aws_ivs
Introduction
The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP API and an AWS SNS 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/jsonAccept-Encoding:
gzip, deflateContent-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.
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, and Playback Key Pairs.
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
— PerformsGetChannel
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 string.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
— PerformsGetStreamKey
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 withDeleteStreamKey
to prevent further streaming to a channel.PutMetadata
— Inserts metadata into an RTMPS stream for the specified channel. A maximum of 5 requests per second per channel is allowed, each with a maximum 1KB payload.
PlaybackKeyPair Endpoints
ImportPlaybackKeyPair
— Imports the public portion of a new key pair and returns itsarn
andfingerprint
. TheprivateKey
can then be used to generate viewer authorization tokens, to grant viewers access to authorized channels.GetPlaybackKeyPair
— Gets a specified playback authorization key pair and returns thearn
andfingerprint
. TheprivateKey
held by the caller can be used to generate viewer authorization tokens, to grant viewers access to authorized 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’sprivateKey
.
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.
Summary
Functions
-
batch_get_channel(Client, Input)
Performs
GetChannel
on multiple ARNs simultaneously. - batch_get_channel(Client, Input0, Options0)
-
batch_get_stream_key(Client, Input)
Performs
GetStreamKey
on multiple ARNs simultaneously. - batch_get_stream_key(Client, Input0, Options0)
-
create_channel(Client, Input)
Creates a new channel and an associated stream key to start streaming.
- create_channel(Client, Input0, Options0)
-
create_stream_key(Client, Input)
Creates a stream key, used to initiate a stream, for the specified channel ARN.
- create_stream_key(Client, Input0, Options0)
-
delete_channel(Client, Input)
Deletes the specified channel and its associated stream keys.
- delete_channel(Client, Input0, Options0)
-
delete_playback_key_pair(Client, Input)
Deletes a specified authorization key pair.
- delete_playback_key_pair(Client, Input0, Options0)
-
delete_stream_key(Client, Input)
Deletes the stream key for the specified ARN, so it can no longer be used to stream.
- delete_stream_key(Client, Input0, Options0)
-
get_channel(Client, Input)
Gets the channel configuration for the specified channel ARN.
- get_channel(Client, Input0, Options0)
-
get_playback_key_pair(Client, Input)
Gets a specified playback authorization key pair and returns the
arn
andfingerprint
. - get_playback_key_pair(Client, Input0, Options0)
-
get_stream(Client, Input)
Gets information about the active (live) stream on a specified channel.
- get_stream(Client, Input0, Options0)
-
get_stream_key(Client, Input)
Gets stream-key information for a specified ARN.
- get_stream_key(Client, Input0, Options0)
-
import_playback_key_pair(Client, Input)
Imports the public portion of a new key pair and returns its
arn
andfingerprint
. - import_playback_key_pair(Client, Input0, Options0)
-
list_channels(Client, Input)
Gets summary information about all channels in your account, in the AWS region where the API request is processed.
- list_channels(Client, Input0, Options0)
-
list_playback_key_pairs(Client, Input)
Gets summary information about playback key pairs.
- list_playback_key_pairs(Client, Input0, Options0)
-
list_stream_keys(Client, Input)
Gets summary information about stream keys for the specified channel.
- list_stream_keys(Client, Input0, Options0)
-
list_streams(Client, Input)
Gets summary information about live streams in your account, in the AWS region where the API request is processed.
- list_streams(Client, Input0, Options0)
-
list_tags_for_resource(Client, ResourceArn)
Gets information about AWS tags for the specified ARN.
- list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)
- list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
-
put_metadata(Client, Input)
Inserts metadata into an RTMPS stream for the specified channel.
- put_metadata(Client, Input0, Options0)
-
stop_stream(Client, Input)
Disconnects the incoming RTMPS stream for the specified channel.
- stop_stream(Client, Input0, Options0)
-
tag_resource(Client, ResourceArn, Input)
Adds or updates tags for the AWS resource with the specified ARN.
- tag_resource(Client, ResourceArn, Input0, Options0)
-
untag_resource(Client, ResourceArn, Input)
Removes tags from the resource with the specified ARN.
- untag_resource(Client, ResourceArn, Input0, Options0)
-
update_channel(Client, Input)
Updates a channel's configuration.
- update_channel(Client, Input0, Options0)
Functions
batch_get_channel(Client, Input)
Performs GetChannel
on multiple ARNs simultaneously.
batch_get_channel(Client, Input0, Options0)
batch_get_stream_key(Client, Input)
Performs GetStreamKey
on multiple ARNs simultaneously.
batch_get_stream_key(Client, Input0, Options0)
create_channel(Client, Input)
Creates a new channel and an associated stream key to start streaming.
create_channel(Client, Input0, Options0)
create_stream_key(Client, Input)
Creates a stream key, used to initiate a stream, for the specified channel ARN.
Note thatCreateChannel
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.
create_stream_key(Client, Input0, Options0)
delete_channel(Client, Input)
Deletes the specified channel and its associated stream keys.
delete_channel(Client, Input0, Options0)
delete_playback_key_pair(Client, Input)
Deletes a specified authorization key pair.
This invalidates future viewer tokens generated using the key pair’sprivateKey
.
delete_playback_key_pair(Client, Input0, Options0)
delete_stream_key(Client, Input)
Deletes the stream key for the specified ARN, so it can no longer be used to stream.
delete_stream_key(Client, Input0, Options0)
get_channel(Client, Input)
Gets the channel configuration for the specified channel ARN.
See alsoBatchGetChannel
.
get_channel(Client, Input0, Options0)
get_playback_key_pair(Client, Input)
Gets a specified playback authorization key pair and returns the
arn
and fingerprint
.
privateKey
held by the caller can be used to generate viewer
authorization tokens, to grant viewers access to authorized channels.
get_playback_key_pair(Client, Input0, Options0)
get_stream(Client, Input)
Gets information about the active (live) stream on a specified channel.
get_stream(Client, Input0, Options0)
get_stream_key(Client, Input)
Gets stream-key information for a specified ARN.
get_stream_key(Client, Input0, Options0)
import_playback_key_pair(Client, Input)
Imports the public portion of a new key pair and returns its arn
and fingerprint
.
privateKey
can then be used to generate viewer authorization tokens,
to grant viewers access to authorized channels.
import_playback_key_pair(Client, Input0, Options0)
list_channels(Client, Input)
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 string.list_channels(Client, Input0, Options0)
list_playback_key_pairs(Client, Input)
Gets summary information about playback key pairs.
list_playback_key_pairs(Client, Input0, Options0)
list_stream_keys(Client, Input)
Gets summary information about stream keys for the specified channel.
list_stream_keys(Client, Input0, Options0)
list_streams(Client, Input)
Gets summary information about live streams in your account, in the AWS region where the API request is processed.
list_streams(Client, Input0, Options0)
list_tags_for_resource(Client, ResourceArn)
Gets information about AWS tags for the specified ARN.
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
put_metadata(Client, Input)
Inserts metadata into an RTMPS stream for the specified channel.
A maximum of 5 requests per second per channel is allowed, each with a maximum 1KB payload.put_metadata(Client, Input0, Options0)
stop_stream(Client, Input)
Disconnects the incoming RTMPS stream for the specified channel.
Can be used in conjunction with DeleteStreamKey
to prevent further
streaming to a channel.
streamKey
attached to the channel.
stop_stream(Client, Input0, Options0)
tag_resource(Client, ResourceArn, Input)
Adds or updates tags for the AWS resource with the specified ARN.
tag_resource(Client, ResourceArn, Input0, Options0)
untag_resource(Client, ResourceArn, Input)
Removes tags from the resource with the specified ARN.
untag_resource(Client, ResourceArn, Input0, Options0)
update_channel(Client, Input)
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.