Table of Contents
A low-level client representing Amazon Interactive Video Service (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 name: US East (Virginia)
Region name: EU West (Dublin)
Allowed Header Values
Resources
The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS ):
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
StreamKey Endpoints
Stream Endpoints
PlaybackKeyPair Endpoints
AWS Tags Endpoints
import boto3
client = boto3.client('ivs')
These are the available methods:
Performs GetChannel on multiple ARNs simultaneously.
See also: AWS API Documentation
Request Syntax
response = client.batch_get_channel(
arns=[
'string',
]
)
[REQUIRED]
Array of ARNs, one per channel.
{
'channels': [
{
'arn': 'string',
'name': 'string',
'latencyMode': 'NORMAL'|'LOW',
'type': 'BASIC'|'STANDARD',
'ingestEndpoint': 'string',
'playbackUrl': 'string',
'authorized': True|False,
'tags': {
'string': 'string'
}
},
],
'errors': [
{
'arn': 'string',
'code': 'string',
'message': 'string'
},
]
}
Response Structure
Object specifying a channel.
Channel ARN.
Channel name.
Channel latency mode. Default: LOW .
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values:
Default: STANDARD .
Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
Channel playback URL.
Whether the channel is authorized.
Array of 1-50 maps, each of the form string:string (key:value) .
Each error object is related to a specific ARN in the request.
Error related to a specific channel, specified by its ARN.
Channel ARN.
Error code.
Error message, determined by the application.
Performs GetStreamKey on multiple ARNs simultaneously.
See also: AWS API Documentation
Request Syntax
response = client.batch_get_stream_key(
arns=[
'string',
]
)
[REQUIRED]
Array of ARNs, one per channel.
{
'streamKeys': [
{
'arn': 'string',
'value': 'string',
'channelArn': 'string',
'tags': {
'string': 'string'
}
},
],
'errors': [
{
'arn': 'string',
'code': 'string',
'message': 'string'
},
]
}
Response Structure
Object specifying a stream key.
Stream-key ARN.
Stream-key value.
Channel ARN for the stream.
Array of 1-50 maps, each of the form string:string (key:value) .
Error related to a specific channel, specified by its ARN.
Channel ARN.
Error code.
Error message, determined by the application.
Check if an operation can be paginated.
Creates a new channel and an associated stream key to start streaming.
See also: AWS API Documentation
Request Syntax
response = client.create_channel(
name='string',
latencyMode='NORMAL'|'LOW',
type='BASIC'|'STANDARD',
authorized=True|False,
tags={
'string': 'string'
}
)
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values:
Default: STANDARD .
See Channel$tags .
dict
Response Syntax
{
'channel': {
'arn': 'string',
'name': 'string',
'latencyMode': 'NORMAL'|'LOW',
'type': 'BASIC'|'STANDARD',
'ingestEndpoint': 'string',
'playbackUrl': 'string',
'authorized': True|False,
'tags': {
'string': 'string'
}
},
'streamKey': {
'arn': 'string',
'value': 'string',
'channelArn': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
channel (dict) --
Object specifying a channel.
arn (string) --
Channel ARN.
name (string) --
Channel name.
latencyMode (string) --
Channel latency mode. Default: LOW .
type (string) --
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values:
Default: STANDARD .
ingestEndpoint (string) --
Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
playbackUrl (string) --
Channel playback URL.
authorized (boolean) --
Whether the channel is authorized.
tags (dict) --
Array of 1-50 maps, each of the form string:string (key:value) .
streamKey (dict) --
Object specifying a stream key.
arn (string) --
Stream-key ARN.
value (string) --
Stream-key value.
channelArn (string) --
Channel ARN for the stream.
tags (dict) --
Array of 1-50 maps, each of the form string:string (key:value) .
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.create_stream_key(
channelArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
ARN of the channel for which to create the stream key.
See Channel$tags .
dict
Response Syntax
{
'streamKey': {
'arn': 'string',
'value': 'string',
'channelArn': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
streamKey (dict) --
Stream key used to authenticate an RTMPS stream for ingestion.
arn (string) --
Stream-key ARN.
value (string) --
Stream-key value.
channelArn (string) --
Channel ARN for the stream.
tags (dict) --
Array of 1-50 maps, each of the form string:string (key:value) .
Exceptions
Deletes the specified channel and its associated stream keys.
See also: AWS API Documentation
Request Syntax
response = client.delete_channel(
arn='string'
)
[REQUIRED]
ARN of the channel to be deleted.
Exceptions
Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey .
See also: AWS API Documentation
Request Syntax
response = client.delete_playback_key_pair(
arn='string'
)
[REQUIRED]
ARN of the key pair to be deleted.
{}
Response Structure
Exceptions
Deletes the stream key for the specified ARN, so it can no longer be used to stream.
See also: AWS API Documentation
Request Syntax
response = client.delete_stream_key(
arn='string'
)
[REQUIRED]
ARN of the stream key to be deleted.
Exceptions
Generate a presigned url given a client, its method, and arguments
The presigned url
Gets the channel configuration for the specified channel ARN. See also BatchGetChannel .
See also: AWS API Documentation
Request Syntax
response = client.get_channel(
arn='string'
)
[REQUIRED]
ARN of the channel for which the configuration is to be retrieved.
{
'channel': {
'arn': 'string',
'name': 'string',
'latencyMode': 'NORMAL'|'LOW',
'type': 'BASIC'|'STANDARD',
'ingestEndpoint': 'string',
'playbackUrl': 'string',
'authorized': True|False,
'tags': {
'string': 'string'
}
}
}
Response Structure
Object specifying a channel.
Channel ARN.
Channel name.
Channel latency mode. Default: LOW .
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values:
Default: STANDARD .
Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
Channel playback URL.
Whether the channel is authorized.
Array of 1-50 maps, each of the form string:string (key:value) .
Exceptions
Create a paginator for an operation.
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 authorized channels.
See also: AWS API Documentation
Request Syntax
response = client.get_playback_key_pair(
arn='string'
)
[REQUIRED]
ARN of the key pair to be returned.
{
'keyPair': {
'arn': 'string',
'name': 'string',
'fingerprint': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
A key pair used to sign and validate a playback authorization token.
Key-pair ARN.
Key-pair name.
Key-pair identifier.
Array of 1-50 maps, each of the form string:string (key:value) .
Exceptions
Gets information about the active (live) stream on a specified channel.
See also: AWS API Documentation
Request Syntax
response = client.get_stream(
channelArn='string'
)
[REQUIRED]
Channel ARN for stream to be accessed.
{
'stream': {
'channelArn': 'string',
'playbackUrl': 'string',
'startTime': datetime(2015, 1, 1),
'state': 'LIVE'|'OFFLINE',
'health': 'HEALTHY'|'STARVING'|'UNKNOWN',
'viewerCount': 123
}
}
Response Structure
Specifies a live video stream that has been ingested and distributed.
Channel ARN for the stream.
URL of the video master manifest, required by the video player to play the HLS stream.
ISO-8601 formatted timestamp of the stream’s start.
The stream’s state.
The stream’s health.
Number of current viewers of the stream.
Exceptions
Gets stream-key information for a specified ARN.
See also: AWS API Documentation
Request Syntax
response = client.get_stream_key(
arn='string'
)
[REQUIRED]
ARN for the stream key to be retrieved.
{
'streamKey': {
'arn': 'string',
'value': 'string',
'channelArn': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
Object specifying a stream key.
Stream-key ARN.
Stream-key value.
Channel ARN for the stream.
Array of 1-50 maps, each of the form string:string (key:value) .
Exceptions
Returns an object that can wait for some condition.
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 authorized channels.
See also: AWS API Documentation
Request Syntax
response = client.import_playback_key_pair(
publicKeyMaterial='string',
name='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The public portion of a customer-generated key pair.
Any tags provided with the request are added to the playback key pair tags.
dict
Response Syntax
{
'keyPair': {
'arn': 'string',
'name': 'string',
'fingerprint': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
keyPair (dict) --
A key pair used to sign and validate a playback authorization token.
arn (string) --
Key-pair ARN.
name (string) --
Key-pair name.
fingerprint (string) --
Key-pair identifier.
tags (dict) --
Array of 1-50 maps, each of the form string:string (key:value) .
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.list_channels(
filterByName='string',
nextToken='string',
maxResults=123
)
dict
Response Syntax
{
'channels': [
{
'arn': 'string',
'name': 'string',
'latencyMode': 'NORMAL'|'LOW',
'authorized': True|False,
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
channels (list) --
List of the matching channels.
(dict) --
Summary information about a channel.
arn (string) --
Channel ARN.
name (string) --
Channel name.
latencyMode (string) --
Channel latency mode. Default: LOW .
authorized (boolean) --
Whether the channel is authorized.
tags (dict) --
Array of 1-50 maps, each of the form string:string (key:value) .
nextToken (string) --
If there are more channels than maxResults , use nextToken in the request to get the next set.
Exceptions
Gets summary information about playback key pairs.
See also: AWS API Documentation
Request Syntax
response = client.list_playback_key_pairs(
nextToken='string',
maxResults=123
)
dict
Response Syntax
{
'keyPairs': [
{
'arn': 'string',
'name': 'string',
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
keyPairs (list) --
List of key pairs.
(dict) --
Summary information about a playback key pair.
arn (string) --
Key-pair ARN.
name (string) --
Key-pair name.
tags (dict) --
Array of 1-50 maps, each of the form string:string (key:value)
nextToken (string) --
If there are more key pairs than maxResults , use nextToken in the request to get the next set.
Exceptions
Gets summary information about stream keys for the specified channel.
See also: AWS API Documentation
Request Syntax
response = client.list_stream_keys(
channelArn='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
Channel ARN used to filter the list.
dict
Response Syntax
{
'streamKeys': [
{
'arn': 'string',
'channelArn': 'string',
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
streamKeys (list) --
List of stream keys.
(dict) --
Summary information about a stream key.
arn (string) --
Stream-key ARN.
channelArn (string) --
Channel ARN for the stream.
tags (dict) --
Array of 1-50 maps, each of the form string:string (key:value) .
nextToken (string) --
If there are more stream keys than maxResults , use nextToken in the request to get the next set.
Exceptions
Gets summary information about live streams in your account, in the AWS region where the API request is processed.
See also: AWS API Documentation
Request Syntax
response = client.list_streams(
nextToken='string',
maxResults=123
)
dict
Response Syntax
{
'streams': [
{
'channelArn': 'string',
'state': 'LIVE'|'OFFLINE',
'health': 'HEALTHY'|'STARVING'|'UNKNOWN',
'viewerCount': 123,
'startTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
streams (list) --
List of streams.
(dict) --
Summary information about a stream.
channelArn (string) --
Channel ARN for the stream.
state (string) --
The stream’s state.
health (string) --
The stream’s health.
viewerCount (integer) --
Number of current viewers of the stream.
startTime (datetime) --
ISO-8601 formatted timestamp of the stream’s start.
nextToken (string) --
If there are more streams than maxResults , use nextToken in the request to get the next set.
Exceptions
Gets information about AWS tags for the specified ARN.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The ARN of the resource to be retrieved.
dict
Response Syntax
{
'tags': {
'string': 'string'
},
'nextToken': 'string'
}
Response Structure
(dict) --
tags (dict) --
nextToken (string) --
If there are more tags than maxResults , use nextToken in the request to get the next set.
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.put_metadata(
channelArn='string',
metadata='string'
)
[REQUIRED]
ARN of the channel into which metadata is inserted. This channel must have an active stream.
[REQUIRED]
Metadata to insert into the stream. Maximum: 1 KB per request.
None
Exceptions
Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.
Note
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.
See also: AWS API Documentation
Request Syntax
response = client.stop_stream(
channelArn='string'
)
[REQUIRED]
ARN of the channel for which the stream is to be stopped.
{}
Response Structure
Exceptions
Adds or updates tags for the AWS resource with the specified ARN.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
ARN of the resource for which tags are to be added or updated.
[REQUIRED]
Array of tags to be added or updated.
dict
Response Syntax
{}
Response Structure
Exceptions
Removes tags from the resource with the specified ARN.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
ARN of the resource for which tags are to be removed.
[REQUIRED]
Array of tags to be removed.
dict
Response Syntax
{}
Response Structure
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.update_channel(
arn='string',
name='string',
latencyMode='NORMAL'|'LOW',
type='BASIC'|'STANDARD',
authorized=True|False
)
[REQUIRED]
ARN of the channel to be updated.
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values:
Default: STANDARD .
dict
Response Syntax
{
'channel': {
'arn': 'string',
'name': 'string',
'latencyMode': 'NORMAL'|'LOW',
'type': 'BASIC'|'STANDARD',
'ingestEndpoint': 'string',
'playbackUrl': 'string',
'authorized': True|False,
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
channel (dict) --
Object specifying a channel.
arn (string) --
Channel ARN.
name (string) --
Channel name.
latencyMode (string) --
Channel latency mode. Default: LOW .
type (string) --
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values:
Default: STANDARD .
ingestEndpoint (string) --
Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
playbackUrl (string) --
Channel playback URL.
authorized (boolean) --
Whether the channel is authorized.
tags (dict) --
Array of 1-50 maps, each of the form string:string (key:value) .
Exceptions
The available paginators are:
paginator = client.get_paginator('list_channels')
Creates an iterator that will paginate through responses from IVS.Client.list_channels().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
filterByName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'channels': [
{
'arn': 'string',
'name': 'string',
'latencyMode': 'NORMAL'|'LOW',
'authorized': True|False,
'tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
channels (list) --
List of the matching channels.
(dict) --
Summary information about a channel.
arn (string) --
Channel ARN.
name (string) --
Channel name.
latencyMode (string) --
Channel latency mode. Default: LOW .
authorized (boolean) --
Whether the channel is authorized.
tags (dict) --
Array of 1-50 maps, each of the form string:string (key:value) .
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_playback_key_pairs')
Creates an iterator that will paginate through responses from IVS.Client.list_playback_key_pairs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'keyPairs': [
{
'arn': 'string',
'name': 'string',
'tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
List of key pairs.
Summary information about a playback key pair.
Key-pair ARN.
Key-pair name.
Array of 1-50 maps, each of the form string:string (key:value)
A token to resume pagination.
paginator = client.get_paginator('list_stream_keys')
Creates an iterator that will paginate through responses from IVS.Client.list_stream_keys().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
channelArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
Channel ARN used to filter the list.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'streamKeys': [
{
'arn': 'string',
'channelArn': 'string',
'tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
streamKeys (list) --
List of stream keys.
(dict) --
Summary information about a stream key.
arn (string) --
Stream-key ARN.
channelArn (string) --
Channel ARN for the stream.
tags (dict) --
Array of 1-50 maps, each of the form string:string (key:value) .
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_streams')
Creates an iterator that will paginate through responses from IVS.Client.list_streams().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'streams': [
{
'channelArn': 'string',
'state': 'LIVE'|'OFFLINE',
'health': 'HEALTHY'|'STARVING'|'UNKNOWN',
'viewerCount': 123,
'startTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
List of streams.
Summary information about a stream.
Channel ARN for the stream.
The stream’s state.
The stream’s health.
Number of current viewers of the stream.
ISO-8601 formatted timestamp of the stream’s start.
A token to resume pagination.