Client

ivs	R Documentation

Amazon Interactive Video Service¶

Description¶

Introduction

The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP API and an Amazon Web Services EventBridge event stream for responses. JSON is used for both requests and responses, including errors.

The API is an Amazon Web Services regional service. For a list of supported regions and Amazon IVS HTTPS service endpoints, see the Amazon IVS page in the Amazon Web Services General Reference.

*All API request parameters and URLs are case sensitive. *

For a summary of notable documentation changes in each release, see Document History.

Allowed Header Values

⁠Accept:⁠ application/json
⁠Accept-Encoding:⁠ gzip, deflate
⁠Content-Type:⁠application/json

Key Concepts

Channel — Stores configuration data related to your live stream. You first create a channel and then use the channel’s stream key to start your live stream.
Stream key — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. Treat the stream key like a secret, since it allows anyone to stream to the channel.
Playback key pair — Video playback may be restricted using playback-authorization tokens, which use public-key encryption. A playback key pair is the public-private pair of keys used to sign and validate the playback-authorization token.
Recording configuration — Stores configuration related to recording a live stream and where to store the recorded content. Multiple channels can reference the same recording configuration.
Playback restriction policy — Restricts playback by countries and/or origin sites.

For more information about your IVS live stream, also see Getting Started with IVS Low-Latency Streaming.

Tagging

A tag is a metadata label that you assign to an Amazon Web Services resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

Tags can help you identify and organize your Amazon Web Services resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).

The Amazon IVS API has these tag-related endpoints: tag_resource, untag_resource, and list_tags_for_resource. The following resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording Configurations.

At most 50 tags can be applied to a resource.

Authentication versus Authorization

Note the differences between these concepts:

Authentication is about verifying identity. You need to be authenticated to sign Amazon IVS API requests.
Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS API requests. In addition, authorization is needed to view Amazon IVS private channels. (Private channels are channels that are enabled for "playback authorization.")

Authentication

All Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS API directly, it’s your responsibility to sign the requests.

You generate a signature using valid Amazon Web Services credentials that have permission to perform the requested action. For example, you must sign PutMetadata requests with a signature generated from a user account that has the ivs:PutMetadata permission.

For more information:

Authentication and generating signatures — See Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon Web Services General Reference.
Managing Amazon IVS permissions — See Identity and Access Management on the Security page of the Amazon IVS User Guide.

Amazon Resource Names (ARNs)

ARNs uniquely identify AWS resources. An ARN is required when you need to specify a resource unambiguously across all of AWS, such as in IAM policies and API calls. For more information, see Amazon Resource Names in the AWS General Reference.

Usage¶

ivs(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- ivs(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

batch_get_channel: Performs GetChannel on multiple ARNs simultaneously
batch_get_stream_key: Performs GetStreamKey on multiple ARNs simultaneously
batch_start_viewer_session_revocation: Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously
create_channel: Creates a new channel and an associated stream key to start streaming
create_playback_restriction_policy: Creates a new playback restriction policy, for constraining playback by countries and/or origins
create_recording_configuration: Creates a new recording configuration, used to enable recording to Amazon S3
create_stream_key: Creates a stream key, used to initiate a stream, for the specified channel ARN
delete_channel: Deletes the specified channel and its associated stream keys
delete_playback_key_pair: Deletes a specified authorization key pair
delete_playback_restriction_policy: Deletes the specified playback restriction policy
delete_recording_configuration: Deletes the recording configuration for the specified ARN
delete_stream_key: Deletes the stream key for the specified ARN, so it can no longer be used to stream
get_channel: Gets the channel configuration for the specified channel ARN
get_playback_key_pair: Gets a specified playback authorization key pair and returns the arn and fingerprint
get_playback_restriction_policy: Gets the specified playback restriction policy
get_recording_configuration: Gets the recording configuration for the specified ARN
get_stream: Gets information about the active (live) stream on a specified channel
get_stream_key: Gets stream-key information for a specified ARN
get_stream_session: Gets metadata on a specified stream
import_playback_key_pair: Imports the public portion of a new key pair and returns its arn and fingerprint
list_channels: Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed
list_playback_key_pairs: Gets summary information about playback key pairs
list_playback_restriction_policies: Gets summary information about playback restriction policies
list_recording_configurations: Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed
list_stream_keys: Gets summary information about stream keys for the specified channel
list_streams: Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed
list_stream_sessions: Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed
list_tags_for_resource: Gets information about Amazon Web Services tags for the specified ARN
put_metadata: Inserts metadata into the active stream of the specified channel
start_viewer_session_revocation: Starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID
stop_stream: Disconnects the incoming RTMPS stream for the specified channel
tag_resource: Adds or updates tags for the Amazon Web Services resource with the specified ARN
untag_resource: Removes tags from the resource with the specified ARN
update_channel: Updates a channel's configuration
update_playback_restriction_policy: Updates a specified playback restriction policy

Examples¶

## Not run: 
svc <- ivs()
svc$batch_get_channel(
  Foo = 123
)

## End(Not run)