Table of Contents
IVS.
Client
¶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: 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.
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 — 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 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 — 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 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 its arn
and fingerprint
. The privateKey
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 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.
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
.
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.
client = session.create_client('ivs')
These are the available methods:
batch_get_channel
(**kwargs)¶Performs GetChannel on multiple ARNs simultaneously.
See also: AWS API Documentation
Request Syntax
response = client.batch_get_channel(
arns=[
'string',
]
)
arns (list) –
[REQUIRED]
Array of ARNs, one per channel.
(string) –
dict
Response Syntax
{
'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
(dict) –
channels (list) –
(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:
STANDARD
: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.
BASIC
: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.
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)
.
(string) –
(string) –
errors (list) –
Each error object is related to a specific ARN in the request.
(dict) –
Error related to a specific channel, specified by its ARN.
arn (string) –
Channel ARN.
code (string) –
Error code.
message (string) –
Error message, determined by the application.
batch_get_stream_key
(**kwargs)¶Performs GetStreamKey on multiple ARNs simultaneously.
See also: AWS API Documentation
Request Syntax
response = client.batch_get_stream_key(
arns=[
'string',
]
)
arns (list) –
[REQUIRED]
Array of ARNs, one per channel.
(string) –
dict
Response Syntax
{
'streamKeys': [
{
'arn': 'string',
'value': 'string',
'channelArn': 'string',
'tags': {
'string': 'string'
}
},
],
'errors': [
{
'arn': 'string',
'code': 'string',
'message': 'string'
},
]
}
Response Structure
(dict) –
streamKeys (list) –
(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)
.
(string) –
(string) –
errors (list) –
(dict) –
Error related to a specific channel, specified by its ARN.
arn (string) –
Channel ARN.
code (string) –
Error code.
message (string) –
Error message, determined by the application.
can_paginate
(operation_name)¶Check if an operation can be paginated.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
True
if the operation can be paginated,
False
otherwise.
create_channel
(**kwargs)¶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'
}
)
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:
STANDARD
: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.
BASIC
: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.
Default: STANDARD
.
authorized (boolean) – Whether the channel is authorized. Default: false
.
tags (dict) –
See Channel$tags .
(string) –
(string) –
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:
STANDARD
: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.
BASIC
: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.
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)
.
(string) –
(string) –
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)
.
(string) –
(string) –
Exceptions
create_stream_key
(**kwargs)¶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'
}
)
channelArn (string) –
[REQUIRED]
ARN of the channel for which to create the stream key.
tags (dict) –
See Channel$tags .
(string) –
(string) –
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)
.
(string) –
(string) –
Exceptions
delete_channel
(**kwargs)¶Deletes the specified channel and its associated stream keys.
See also: AWS API Documentation
Request Syntax
response = client.delete_channel(
arn='string'
)
arn (string) –
[REQUIRED]
ARN of the channel to be deleted.
None
Exceptions
delete_playback_key_pair
(**kwargs)¶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'
)
arn (string) –
[REQUIRED]
ARN of the key pair to be deleted.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
delete_stream_key
(**kwargs)¶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'
)
arn (string) –
[REQUIRED]
ARN of the stream key to be deleted.
None
Exceptions
generate_presigned_url
(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶Generate a presigned url given a client, its method, and arguments
ClientMethod (string) – The client method to presign for
Params (dict) – The parameters normally passed to
ClientMethod
.
ExpiresIn (int) – The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
HttpMethod (string) – The http method to use on the generated url. By default, the http method is whatever is used in the method’s model.
The presigned url
get_channel
(**kwargs)¶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'
)
arn (string) –
[REQUIRED]
ARN of the channel for which the configuration is to be retrieved.
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:
STANDARD
: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.
BASIC
: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.
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)
.
(string) –
(string) –
Exceptions
get_paginator
(operation_name)¶Create a paginator for an operation.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate
method to
check if an operation is pageable.
L{botocore.paginate.Paginator}
A paginator object.
get_playback_key_pair
(**kwargs)¶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'
)
arn (string) –
[REQUIRED]
ARN of the key pair to be returned.
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)
.
(string) –
(string) –
Exceptions
get_stream
(**kwargs)¶Gets information about the active (live) stream on a specified channel.
See also: AWS API Documentation
Request Syntax
response = client.get_stream(
channelArn='string'
)
channelArn (string) –
[REQUIRED]
Channel ARN for stream to be accessed.
dict
Response Syntax
{
'stream': {
'channelArn': 'string',
'playbackUrl': 'string',
'startTime': datetime(2015, 1, 1),
'state': 'LIVE'|'OFFLINE',
'health': 'HEALTHY'|'STARVING'|'UNKNOWN',
'viewerCount': 123
}
}
Response Structure
(dict) –
stream (dict) –
Specifies a live video stream that has been ingested and distributed.
channelArn (string) –
Channel ARN for the stream.
playbackUrl (string) –
URL of the video master manifest, required by the video player to play the HLS stream.
startTime (datetime) –
ISO-8601 formatted timestamp of the stream’s start.
state (string) –
The stream’s state.
health (string) –
The stream’s health.
viewerCount (integer) –
Number of current viewers of the stream.
Exceptions
get_stream_key
(**kwargs)¶Gets stream-key information for a specified ARN.
See also: AWS API Documentation
Request Syntax
response = client.get_stream_key(
arn='string'
)
arn (string) –
[REQUIRED]
ARN for the stream key to be retrieved.
dict
Response Syntax
{
'streamKey': {
'arn': 'string',
'value': 'string',
'channelArn': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) –
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)
.
(string) –
(string) –
Exceptions
get_waiter
(waiter_name)¶Returns an object that can wait for some condition.
waiter_name (str) – The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
The specified waiter object.
botocore.waiter.Waiter
import_playback_key_pair
(**kwargs)¶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'
}
)
publicKeyMaterial (string) –
[REQUIRED]
The public portion of a customer-generated key pair.
name (string) – An arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource. The value does not need to be unique.
tags (dict) –
Any tags provided with the request are added to the playback key pair tags.
(string) –
(string) –
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)
.
(string) –
(string) –
Exceptions
list_channels
(**kwargs)¶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
)
filterByName (string) – Filters the channel list to match the specified name.
nextToken (string) – The first channel to retrieve. This is used for pagination; see the nextToken
response field.
maxResults (integer) – Maximum number of channels to return.
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)
.
(string) –
(string) –
nextToken (string) –
If there are more channels than maxResults
, use nextToken
in the request to get the next set.
Exceptions
list_playback_key_pairs
(**kwargs)¶Gets summary information about playback key pairs.
See also: AWS API Documentation
Request Syntax
response = client.list_playback_key_pairs(
nextToken='string',
maxResults=123
)
nextToken (string) – Maximum number of key pairs to return.
maxResults (integer) – The first key pair to retrieve. This is used for pagination; see the nextToken
response field.
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)
(string) –
(string) –
nextToken (string) –
If there are more key pairs than maxResults
, use nextToken
in the request to get the next set.
Exceptions
list_stream_keys
(**kwargs)¶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
)
channelArn (string) –
[REQUIRED]
Channel ARN used to filter the list.
nextToken (string) – The first stream key to retrieve. This is used for pagination; see the nextToken
response field.
maxResults (integer) – Maximum number of streamKeys to return.
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)
.
(string) –
(string) –
nextToken (string) –
If there are more stream keys than maxResults
, use nextToken
in the request to get the next set.
Exceptions
list_streams
(**kwargs)¶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
)
nextToken (string) – The first stream to retrieve. This is used for pagination; see the nextToken
response field.
maxResults (integer) – Maximum number of streams to return.
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
)
resourceArn (string) –
[REQUIRED]
The ARN of the resource to be retrieved.
nextToken (string) – The first tag to retrieve. This is used for pagination; see the nextToken
response field.
maxResults (integer) – Maximum number of tags to return.
dict
Response Syntax
{
'tags': {
'string': 'string'
},
'nextToken': 'string'
}
Response Structure
(dict) –
tags (dict) –
(string) –
(string) –
nextToken (string) –
If there are more tags than maxResults
, use nextToken
in the request to get the next set.
Exceptions
put_metadata
(**kwargs)¶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'
)
channelArn (string) –
[REQUIRED]
ARN of the channel into which metadata is inserted. This channel must have an active stream.
metadata (string) –
[REQUIRED]
Metadata to insert into the stream. Maximum: 1 KB per request.
None
Exceptions
stop_stream
(**kwargs)¶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'
)
channelArn (string) –
[REQUIRED]
ARN of the channel for which the stream is to be stopped.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
tag_resource
(**kwargs)¶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'
}
)
resourceArn (string) –
[REQUIRED]
ARN of the resource for which tags are to be added or updated.
tags (dict) –
[REQUIRED]
Array of tags to be added or updated.
(string) –
(string) –
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
untag_resource
(**kwargs)¶Removes tags from the resource with the specified ARN.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
resourceArn (string) –
[REQUIRED]
ARN of the resource for which tags are to be removed.
tagKeys (list) –
[REQUIRED]
Array of tags to be removed.
(string) –
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
update_channel
(**kwargs)¶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
)
arn (string) –
[REQUIRED]
ARN of the channel to be updated.
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:
STANDARD
: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.
BASIC
: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.
Default: STANDARD
.
authorized (boolean) – Whether the channel is authorized. Default: false
.
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:
STANDARD
: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.
BASIC
: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.
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)
.
(string) –
(string) –
Exceptions
Client exceptions are available on a client instance via the exceptions
property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
IVS.Client.exceptions.
AccessDeniedException
¶Example
try:
...
except client.exceptions.AccessDeniedException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'exceptionMessage': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
exceptionMessage (string) –
User does not have sufficient access to perform this action.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
IVS.Client.exceptions.
ChannelNotBroadcasting
¶Example
try:
...
except client.exceptions.ChannelNotBroadcasting as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'exceptionMessage': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
exceptionMessage (string) –
The stream is offline for the given channel ARN.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
IVS.Client.exceptions.
ConflictException
¶Example
try:
...
except client.exceptions.ConflictException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'exceptionMessage': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
exceptionMessage (string) –
Updating or deleting a resource can cause an inconsistent state.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
IVS.Client.exceptions.
InternalServerException
¶Example
try:
...
except client.exceptions.InternalServerException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'exceptionMessage': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
exceptionMessage (string) –
Unexpected error during processing of request.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
IVS.Client.exceptions.
PendingVerification
¶Example
try:
...
except client.exceptions.PendingVerification as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'exceptionMessage': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
exceptionMessage (string) –
Your account is pending verification.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
IVS.Client.exceptions.
ResourceNotFoundException
¶Example
try:
...
except client.exceptions.ResourceNotFoundException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'exceptionMessage': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
exceptionMessage (string) –
Request references a resource which does not exist.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
IVS.Client.exceptions.
ServiceQuotaExceededException
¶Example
try:
...
except client.exceptions.ServiceQuotaExceededException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'exceptionMessage': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
exceptionMessage (string) –
Request would cause a service quota to be exceeded.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
Example
try:
...
except client.exceptions.StreamUnavailable as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'exceptionMessage': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
exceptionMessage (string) –
The stream is temporarily unavailable.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
IVS.Client.exceptions.
ThrottlingException
¶Example
try:
...
except client.exceptions.ThrottlingException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'exceptionMessage': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
exceptionMessage (string) –
Request was denied due to request throttling.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
IVS.Client.exceptions.
ValidationException
¶Example
try:
...
except client.exceptions.ValidationException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'exceptionMessage': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
exceptionMessage (string) –
The input fails to satisfy the constraints specified by an AWS service.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The available paginators are:
IVS.Paginator.
ListChannels
¶paginator = client.get_paginator('list_channels')
paginate
(**kwargs)¶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'
}
)
filterByName (string) – Filters the channel list to match the specified name.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
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.
PageSize (integer) –
The size of each page.
StartingToken (string) –
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)
.
(string) –
(string) –
NextToken (string) –
A token to resume pagination.
IVS.Paginator.
ListPlaybackKeyPairs
¶paginator = client.get_paginator('list_playback_key_pairs')
paginate
(**kwargs)¶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'
}
)
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
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.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
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)
(string) –
(string) –
NextToken (string) –
A token to resume pagination.
IVS.Paginator.
ListStreamKeys
¶paginator = client.get_paginator('list_stream_keys')
paginate
(**kwargs)¶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'
}
)
channelArn (string) –
[REQUIRED]
Channel ARN used to filter the list.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
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.
PageSize (integer) –
The size of each page.
StartingToken (string) –
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)
.
(string) –
(string) –
NextToken (string) –
A token to resume pagination.
IVS.Paginator.
ListStreams
¶paginator = client.get_paginator('list_streams')
paginate
(**kwargs)¶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'
}
)
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
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.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
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) –
A token to resume pagination.