View Source AWS.Ivs (aws-elixir v1.0.4)
introduction
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
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
Allowed Header Values
*
## Accept:
application/json
*
## Accept-Encoding:
gzip, deflate
*
## Content-Type:
application/json
key-concepts
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
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
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 Best practices and strategies
in Tagging Amazon Web Services Resources and Tag Editor for details, 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 operations: TagResource,
UntagResource, and ListTagsForResource. 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
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
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
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.
Link to this section Summary
Functions
Performs GetChannel on multiple ARNs simultaneously.
Performs GetStreamKey on multiple ARNs simultaneously.
Performs StartViewerSessionRevocation on multiple channel ARN and viewer
ID pairs simultaneously.
Creates a new channel and an associated stream key to start streaming.
Creates a new playback restriction policy, for constraining playback by countries and/or origins.
Creates a new recording configuration, used to enable recording to Amazon S3.
Creates a stream key, used to initiate a stream, for the specified channel ARN.
Deletes the specified channel and its associated stream keys.
Deletes a specified authorization key pair.
Deletes the specified playback restriction policy.
Deletes the recording configuration for the specified ARN.
Deletes the stream key for the specified ARN, so it can no longer be used to stream.
Gets the channel configuration for the specified channel ARN.
Gets a specified playback authorization key pair and returns the arn and
fingerprint.
Gets the specified playback restriction policy.
Gets the recording configuration for the specified ARN.
Gets information about the active (live) stream on a specified channel.
Gets stream-key information for a specified ARN.
Gets metadata on a specified stream.
Imports the public portion of a new key pair and returns its arn and
fingerprint.
Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed.
Gets summary information about playback key pairs.
Gets summary information about playback restriction policies.
Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.
Gets summary information about stream keys for the specified channel.
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.
Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.
Gets information about Amazon Web Services tags for the specified ARN.
Inserts metadata into the active stream of the specified channel.
Starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID.
Disconnects the incoming RTMPS stream for the specified channel.
Adds or updates tags for the Amazon Web Services resource with the specified ARN.
Removes tags from the resource with the specified ARN.
Updates a channel's configuration.
Updates a specified playback restriction policy.
Link to this section Functions
Performs GetChannel on multiple ARNs simultaneously.
Performs GetStreamKey on multiple ARNs simultaneously.
batch_start_viewer_session_revocation(client, input, options \\ [])
View SourcePerforms StartViewerSessionRevocation on multiple channel ARN and viewer
ID pairs simultaneously.
Creates a new channel and an associated stream key to start streaming.
Creates a new playback restriction policy, for constraining playback by countries and/or origins.
Creates a new recording configuration, used to enable recording to Amazon S3.
Known issue: In the us-east-1 region, if you use the
Amazon Web Services CLI to create a recording configuration, it returns success
even if the
S3 bucket is in a different region. In this case, the state of the recording
configuration is CREATE_FAILED (instead of ACTIVE). (In other
regions, the CLI correctly returns failure if the bucket is in a different
region.)
Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region.
Creates a stream key, used to initiate a stream, for the specified channel ARN.
Note that CreateChannel creates a stream key. If you subsequently use
CreateStreamKey on the same channel, it will fail because a stream key already
exists and
there is a limit of 1 stream key per channel. To reset the stream key on a
channel, use DeleteStreamKey and then CreateStreamKey.
Deletes the specified channel and its associated stream keys.
If you try to delete a live channel, you will get an error (409
ConflictException). To
delete a channel that is live, call StopStream, wait for the Amazon
EventBridge "Stream End" event (to verify that the stream's state is no longer
Live), then
call DeleteChannel. (See Using EventBridge with Amazon IVS.)
Deletes a specified authorization key pair.
This invalidates future viewer tokens
generated using the key pair’s privateKey. For more information, see Setting Up Private
Channels
in the Amazon IVS User Guide.
Deletes the specified playback restriction policy.
Deletes the recording configuration for the specified ARN.
If you try to delete a recording configuration that is associated with a
channel, you will
get an error (409 ConflictException). To avoid this, for all channels that
reference the
recording configuration, first use UpdateChannel to set the
recordingConfigurationArn field to an empty string, then use
DeleteRecordingConfiguration.
Deletes the stream key for the specified ARN, so it can no longer be used to stream.
Gets the channel configuration for the specified channel ARN.
See also BatchGetChannel.
Gets a specified playback authorization key pair and returns the arn and
fingerprint.
The privateKey held by the caller can be used to
generate viewer authorization tokens, to grant viewers access to private
channels. For more
information, see Setting Up Private Channels
in the Amazon IVS User
Guide.
Gets the specified playback restriction policy.
Gets the recording configuration for the specified ARN.
Gets information about the active (live) stream on a specified channel.
Gets stream-key information for a specified ARN.
Gets metadata on a specified stream.
Imports the public portion of a new key pair and returns its arn and
fingerprint.
The privateKey can then be used to generate viewer
authorization tokens, to grant viewers access to private channels. For more
information, see
Setting Up Private
Channels
in the Amazon IVS User Guide.
Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed.
This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException).
Gets summary information about playback key pairs.
For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
Gets summary information about playback restriction policies.
Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.
Gets summary information about stream keys for the specified channel.
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.
Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.
Gets information about Amazon Web Services tags for the specified ARN.
Inserts metadata into the active stream of the specified channel.
At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed. Also see Embedding Metadata within a Video Stream in the Amazon IVS User Guide.
Starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID.
Optionally, you can provide a version to revoke viewer sessions less than and including that version. For instructions on associating a viewer ID with a viewer session, see Setting Up Private Channels.
Disconnects the incoming RTMPS stream for the specified channel.
Can be used in
conjunction with DeleteStreamKey to prevent further streaming to a
channel.
Many streaming client-software libraries automatically reconnect a dropped RTMPS
session, so to stop the stream permanently, you may want to first revoke the
streamKey attached to the channel.
Adds or updates tags for the Amazon Web Services resource with the specified ARN.
Removes tags from the resource with the specified ARN.
Updates a channel's configuration.
Live channels cannot be updated. You must stop the ongoing stream, update the channel, and restart the stream for the changes to take effect.
Updates a specified playback restriction policy.