AWS.Ivs (aws-elixir v0.8.0) View Source

Introduction

The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses.

JSON is used for both requests and responses, including errors.

The API is an AWS regional service, currently in these regions: us-west-2, us-east-1, and eu-west-1.

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

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

Service Endpoints

The following are the Amazon IVS service endpoints (all HTTPS):

Region name: US West (Oregon)

  • Region: us-west-2

  • Endpoint: ivs.us-west-2.amazonaws.com

Region name: US East (Virginia)

  • Region: us-east-1

  • Endpoint: ivs.us-east-1.amazonaws.com

Region name: EU West (Dublin)

  • Region: eu-west-1

  • Endpoint: ivs.eu-west-1.amazonaws.com

Allowed Header Values

  • **Accept:** application/json

  • **Accept-Encoding:** gzip, deflate

  • **Content-Type:**application/json

Resources

The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS):

  • 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. See the Channel endpoints for more information.

  • Stream key — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. See the StreamKey endpoints for more information. 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. See the PlaybackKeyPair endpoints for more information.

  • 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. See the Recording Configuration endpoints for more information.

Tagging

A tag is a metadata label that you assign to an AWS 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 AWS Resources for more information, including restrictions that apply to tags.

Tags can help you identify and organize your AWS 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: TagResource, UntagResource, and ListTagsForResource. The following resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording Configurations.

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. You need to be authorized 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 AWS 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 AWS credentials that have permission to perform the requested action. For example, you must sign PutMetadata requests with a signature generated from an IAM user account that has the ivs:PutMetadata permission.

For more information:

Channel Endpoints

  • CreateChannel — Creates a new channel and an associated stream key to start streaming.

  • GetChannel — Gets the channel configuration for the specified channel ARN (Amazon Resource Name).

  • BatchGetChannel — Performs GetChannel on multiple ARNs simultaneously.

  • ListChannels — Gets summary information about all channels in your account, in the AWS 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 Conflict Exception).

  • UpdateChannel — Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.

  • DeleteChannel — Deletes the specified channel.

StreamKey Endpoints

  • CreateStreamKey — Creates a stream key, used to initiate a stream, for the specified channel ARN.

  • GetStreamKey — Gets stream key information for the specified ARN.

  • BatchGetStreamKey — Performs GetStreamKey on multiple ARNs simultaneously.

  • ListStreamKeys — Gets summary information about stream keys for the specified channel.

  • DeleteStreamKey — Deletes the stream key for the specified ARN, so it can no longer be used to stream.

Stream Endpoints

  • GetStream — Gets information about the active (live) stream on a specified channel.

  • ListStreams — Gets summary information about live streams in your account, in the AWS region where the API request is processed.

  • StopStream — Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.

  • PutMetadata — Inserts metadata into the active stream of the specified channel. A maximum of 5 requests per second per channel is 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.)

PlaybackKeyPair Endpoints

For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

  • ImportPlaybackKeyPair — 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 (channels enabled for playback authorization).

  • GetPlaybackKeyPair — 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.

  • ListPlaybackKeyPairs — Gets summary information about playback key pairs.

  • DeletePlaybackKeyPair — Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey.

RecordingConfiguration Endpoints

  • CreateRecordingConfiguration — Creates a new recording configuration, used to enable recording to Amazon S3.

  • GetRecordingConfiguration — Gets the recording-configuration metadata for the specified ARN.

  • ListRecordingConfigurations — Gets summary information about all recording configurations in your account, in the AWS region where the API request is processed.

  • DeleteRecordingConfiguration — Deletes the recording configuration for the specified ARN.

AWS Tags Endpoints

  • TagResource — Adds or updates tags for the AWS resource with the specified ARN.

  • UntagResource — Removes tags from the resource with the specified ARN.

  • ListTagsForResource — Gets information about AWS tags for the specified ARN.

Link to this section Summary

Functions

Performs GetChannel on multiple ARNs simultaneously.

Performs GetStreamKey on multiple ARNs simultaneously.

Creates a new channel and an associated stream key to start streaming.

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 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 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.

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 AWS region where the API request is processed.

Gets summary information about playback key pairs.

Gets summary information about all recording configurations in your account, in the AWS region where the API request is processed.

Gets summary information about stream keys for the specified channel.

Gets summary information about live streams in your account, in the AWS region where the API request is processed.

Gets information about AWS tags for the specified ARN.

Inserts metadata into the active stream of the specified channel.

Disconnects the incoming RTMPS stream for the specified channel.

Adds or updates tags for the AWS resource with the specified ARN.

Removes tags from the resource with the specified ARN.

Updates a channel's configuration.

Link to this section Functions

Link to this function

batch_get_channel(client, input, options \\ [])

View Source

Performs GetChannel on multiple ARNs simultaneously.

Link to this function

batch_get_stream_key(client, input, options \\ [])

View Source

Performs GetStreamKey on multiple ARNs simultaneously.

Link to this function

create_channel(client, input, options \\ [])

View Source

Creates a new channel and an associated stream key to start streaming.

Link to this function

create_recording_configuration(client, input, options \\ [])

View Source

Creates a new recording configuration, used to enable recording to Amazon S3.

Known issue: In the us-east-1 region, if you use the AWS 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.

Link to this function

create_stream_key(client, input, options \\ [])

View Source

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.

Link to this function

delete_channel(client, input, options \\ [])

View Source

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 was changed from Live to Offline), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)

Link to this function

delete_playback_key_pair(client, input, options \\ [])

View Source

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.

Link to this function

delete_recording_configuration(client, input, options \\ [])

View Source

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.

Link to this function

delete_stream_key(client, input, options \\ [])

View Source

Deletes the stream key for the specified ARN, so it can no longer be used to stream.

Link to this function

get_channel(client, input, options \\ [])

View Source

Gets the channel configuration for the specified channel ARN.

See also BatchGetChannel.

Link to this function

get_playback_key_pair(client, input, options \\ [])

View Source

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.

Link to this function

get_recording_configuration(client, input, options \\ [])

View Source

Gets the recording configuration for the specified ARN.

Link to this function

get_stream(client, input, options \\ [])

View Source

Gets information about the active (live) stream on a specified channel.

Link to this function

get_stream_key(client, input, options \\ [])

View Source

Gets stream-key information for a specified ARN.

Link to this function

import_playback_key_pair(client, input, options \\ [])

View Source

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.

Link to this function

list_channels(client, input, options \\ [])

View Source

Gets summary information about all channels in your account, in the AWS 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).

Link to this function

list_playback_key_pairs(client, input, options \\ [])

View Source

Gets summary information about playback key pairs.

For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

Link to this function

list_recording_configurations(client, input, options \\ [])

View Source

Gets summary information about all recording configurations in your account, in the AWS region where the API request is processed.

Link to this function

list_stream_keys(client, input, options \\ [])

View Source

Gets summary information about stream keys for the specified channel.

Link to this function

list_streams(client, input, options \\ [])

View Source

Gets summary information about live streams in your account, in the AWS region where the API request is processed.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Gets information about AWS tags for the specified ARN.

Link to this function

put_metadata(client, input, options \\ [])

View Source

Inserts metadata into the active stream of the specified channel.

A maximum of 5 requests per second per channel is 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.) Also see Embedding Metadata within a Video Stream in the Amazon IVS User Guide.

Link to this function

stop_stream(client, input, options \\ [])

View Source

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.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Adds or updates tags for the AWS resource with the specified ARN.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes tags from the resource with the specified ARN.

Link to this function

update_channel(client, input, options \\ [])

View Source

Updates a channel's configuration.

This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.