2026/04/22 - Amazon Interactive Video Service - 5 new8 updated api methods
Changes Adds support for Amazon IVS server-side ad insertion
Gets summary information about all ad configurations in your account, in the AWS region where the API request is processed.
See also: AWS API Documentation
Request Syntax
client.list_ad_configurations(
nextToken='string',
maxResults=123
)
string
The first ad configuration to retrieve. This is used for pagination; see the nextToken response field.
integer
Maximum number of ad configurations to return. Default: your service quota or 100, whichever is smaller.
dict
Response Syntax
{
'adConfigurations': [
{
'arn': 'string',
'name': 'string',
'mediaTailorPlaybackConfigurations': [
{
'playbackConfigurationArn': 'string'
},
],
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
adConfigurations (list) --
List of the matching ad configurations.
(dict) --
Summary information about an ad configuration.
arn (string) --
Ad configuration ARN.
name (string) --
Ad configuration name. Defaults to “”.
mediaTailorPlaybackConfigurations (list) --
List of integration configurations with media tailor resources.
(dict) --
Object specifying a configuration for integration with an AWS Elemental MediaTailor (EMT).
playbackConfigurationArn (string) --
ARN of the customer-created EMT PlaybackConfiguration resource in the same region and account.
tags (dict) --
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
(string) --
(string) --
nextToken (string) --
If there are more ad configurations than maxResults, use nextToken in the request to get the next set.
Inserts an ad marker in the playlist for the specified channel and duration using the ad configuration associated with the channel.
Note: AWS Elemental MediaTailor (EMT), the service that handles ad requests, provides CloudWatch metrics to help you monitor the success or failure of each InsertAdBreak operation. See Monitoring AWS Elemental MediaTailor with Amazon CloudWatch metrics in the AWS Elemental MediaTailor User Guide for details on available metrics.
See also: AWS API Documentation
Request Syntax
client.insert_ad_break(
channelArn='string',
durationSeconds=123
)
string
[REQUIRED]
ARN of the channel into which the ad break is inserted.
integer
[REQUIRED]
Maximum duration of the ad break, in seconds.
dict
Response Syntax
{
'adBreakId': 'string'
}
Response Structure
(dict) --
adBreakId (string) --
Unique identifier for the ad break that was inserted into the playlist.
Creates a new ad configuration to be used for server-side ad insertion.
See also: AWS API Documentation
Request Syntax
client.create_ad_configuration(
name='string',
mediaTailorPlaybackConfigurations=[
{
'playbackConfigurationArn': 'string'
},
]
)
string
Ad configuration name. Defaults to “”.
list
[REQUIRED]
List of integration configurations with media tailor resources.
(dict) --
Object specifying a configuration for integration with an AWS Elemental MediaTailor (EMT).
playbackConfigurationArn (string) --
ARN of the customer-created EMT PlaybackConfiguration resource in the same region and account.
dict
Response Syntax
{
'adConfiguration': {
'arn': 'string',
'name': 'string',
'mediaTailorPlaybackConfigurations': [
{
'playbackConfigurationArn': 'string'
},
],
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
adConfiguration (dict) --
arn (string) --
Ad configuration ARN.
name (string) --
Ad configuration name. Defaults to “”.
mediaTailorPlaybackConfigurations (list) --
List of integration configurations with media tailor resources.
(dict) --
Object specifying a configuration for integration with an AWS Elemental MediaTailor (EMT).
playbackConfigurationArn (string) --
ARN of the customer-created EMT PlaybackConfiguration resource in the same region and account.
tags (dict) --
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
(string) --
(string) --
Deletes the specified ad configuration.
See also: AWS API Documentation
Request Syntax
client.delete_ad_configuration(
arn='string'
)
string
[REQUIRED]
ARN of the ad configuration to be deleted.
None
Gets the ad configuration represented by the specified ARN.
See also: AWS API Documentation
Request Syntax
client.get_ad_configuration(
arn='string'
)
string
[REQUIRED]
ARN of the ad configuration to be retrieved.
dict
Response Syntax
{
'adConfiguration': {
'arn': 'string',
'name': 'string',
'mediaTailorPlaybackConfigurations': [
{
'playbackConfigurationArn': 'string'
},
],
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
adConfiguration (dict) --
arn (string) --
Ad configuration ARN.
name (string) --
Ad configuration name. Defaults to “”.
mediaTailorPlaybackConfigurations (list) --
List of integration configurations with media tailor resources.
(dict) --
Object specifying a configuration for integration with an AWS Elemental MediaTailor (EMT).
playbackConfigurationArn (string) --
ARN of the customer-created EMT PlaybackConfiguration resource in the same region and account.
tags (dict) --
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
(string) --
(string) --
{'accessControlAllowOrigin': 'string',
'accessControlExposeHeaders': 'string',
'cacheControl': 'string',
'channels': {'adConfigurationArn': 'string'},
'contentSecurityPolicy': 'string',
'strictTransportSecurity': 'string',
'xContentTypeOptions': 'string',
'xFrameOptions': 'string'}
Performs GetChannel on multiple ARNs simultaneously.
See also: AWS API Documentation
Request Syntax
client.batch_get_channel(
arns=[
'string',
]
)
list
[REQUIRED]
Array of ARNs, one per channel.
(string) --
dict
Response Syntax
{
'accessControlAllowOrigin': 'string',
'accessControlExposeHeaders': 'string',
'cacheControl': 'string',
'contentSecurityPolicy': 'string',
'strictTransportSecurity': 'string',
'xContentTypeOptions': 'string',
'xFrameOptions': 'string',
'channels': [
{
'arn': 'string',
'name': 'string',
'latencyMode': 'NORMAL'|'LOW',
'type': 'BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD',
'recordingConfigurationArn': 'string',
'ingestEndpoint': 'string',
'playbackUrl': 'string',
'authorized': True|False,
'tags': {
'string': 'string'
},
'insecureIngest': True|False,
'preset': 'HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
'srt': {
'endpoint': 'string',
'passphrase': 'string'
},
'playbackRestrictionPolicyArn': 'string',
'multitrackInputConfiguration': {
'enabled': True|False,
'policy': 'ALLOW'|'REQUIRE',
'maximumResolution': 'SD'|'HD'|'FULL_HD'
},
'containerFormat': 'TS'|'FRAGMENTED_MP4',
'adConfigurationArn': 'string'
},
],
'errors': [
{
'arn': 'string',
'code': 'string',
'message': 'string'
},
]
}
Response Structure
(dict) --
accessControlAllowOrigin (string) --
See Access-Control-Allow-Origin in the MDN Web Docs.
accessControlExposeHeaders (string) --
See Access-Control-Expose-Headers in the MDN Web Docs.
cacheControl (string) --
See Cache-Control in the MDN Web Docs.
contentSecurityPolicy (string) --
See Content-Security-Policy in the MDN Web Docs.
strictTransportSecurity (string) --
See Strict-Transport-Security in the MDN Web Docs.
xContentTypeOptions (string) --
See X-Content-Type-Options in the MDN Web Docs.
xFrameOptions (string) --
See X-Frame-Options in the MDN Web Docs.
channels (list) --
(dict) --
Object specifying a channel.
arn (string) --
Channel ARN.
name (string) --
Channel name.
latencyMode (string) --
Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.
type (string) --
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
recordingConfigurationArn (string) --
Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).
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 private (enabled for playback authorization). Default: false.
tags (dict) --
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
(string) --
(string) --
insecureIngest (boolean) --
Whether the channel allows insecure RTMP ingest. Default: false.
preset (string) --
Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types ( BASIC and STANDARD), preset is the empty string ( "").
srt (dict) --
Specifies the endpoint and optional passphrase for streaming with the SRT protocol.
endpoint (string) --
The endpoint to be used when streaming with IVS using the SRT protocol.
passphrase (string) --
Auto-generated passphrase to enable encryption. This field is applicable only if the end user has not enabled the insecureIngest option for the channel.
playbackRestrictionPolicyArn (string) --
Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).
multitrackInputConfiguration (dict) --
Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.
enabled (boolean) --
Indicates whether multitrack input is enabled. Can be set to true only if channel type is STANDARD. Setting enabled to true with any other channel type will cause an exception. If true, then policy, maximumResolution, and containerFormat are required, and containerFormat must be set to FRAGMENTED_MP4. Default: false.
policy (string) --
Indicates whether multitrack input is allowed or required. Required if enabled is true.
maximumResolution (string) --
Maximum resolution for multitrack input. Required if enabled is true.
containerFormat (string) --
Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.
adConfigurationArn (string) --
ARN of the ad configuration associated with the channel.
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) --
ARN of an IVS resource; e.g., channel.
code (string) --
Error code.
message (string) --
Error message, determined by the application.
{'accessControlAllowOrigin': 'string',
'accessControlExposeHeaders': 'string',
'cacheControl': 'string',
'contentSecurityPolicy': 'string',
'strictTransportSecurity': 'string',
'xContentTypeOptions': 'string',
'xFrameOptions': 'string'}
Performs GetStreamKey on multiple ARNs simultaneously.
See also: AWS API Documentation
Request Syntax
client.batch_get_stream_key(
arns=[
'string',
]
)
list
[REQUIRED]
Array of ARNs, one per stream key.
(string) --
dict
Response Syntax
{
'accessControlAllowOrigin': 'string',
'accessControlExposeHeaders': 'string',
'cacheControl': 'string',
'contentSecurityPolicy': 'string',
'strictTransportSecurity': 'string',
'xContentTypeOptions': 'string',
'xFrameOptions': 'string',
'streamKeys': [
{
'arn': 'string',
'value': 'string',
'channelArn': 'string',
'tags': {
'string': 'string'
}
},
],
'errors': [
{
'arn': 'string',
'code': 'string',
'message': 'string'
},
]
}
Response Structure
(dict) --
accessControlAllowOrigin (string) --
See Access-Control-Allow-Origin in the MDN Web Docs.
accessControlExposeHeaders (string) --
See Access-Control-Expose-Headers in the MDN Web Docs.
cacheControl (string) --
See Cache-Control in the MDN Web Docs.
contentSecurityPolicy (string) --
See Content-Security-Policy in the MDN Web Docs.
strictTransportSecurity (string) --
See Strict-Transport-Security in the MDN Web Docs.
xContentTypeOptions (string) --
See X-Content-Type-Options in the MDN Web Docs.
xFrameOptions (string) --
See X-Frame-Options in the MDN Web Docs.
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) --
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
(string) --
(string) --
errors (list) --
(dict) --
Error related to a specific channel, specified by its ARN.
arn (string) --
ARN of an IVS resource; e.g., channel.
code (string) --
Error code.
message (string) --
Error message, determined by the application.
{'accessControlAllowOrigin': 'string',
'accessControlExposeHeaders': 'string',
'cacheControl': 'string',
'contentSecurityPolicy': 'string',
'strictTransportSecurity': 'string',
'xContentTypeOptions': 'string',
'xFrameOptions': 'string'}
Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.
See also: AWS API Documentation
Request Syntax
client.batch_start_viewer_session_revocation(
viewerSessions=[
{
'channelArn': 'string',
'viewerId': 'string',
'viewerSessionVersionsLessThanOrEqualTo': 123
},
]
)
list
[REQUIRED]
Array of viewer sessions, one per channel-ARN and viewer-ID pair.
(dict) --
A viewer session to revoke in the call to BatchStartViewerSessionRevocation.
channelArn (string) -- [REQUIRED]
The ARN of the channel associated with the viewer session to revoke.
viewerId (string) -- [REQUIRED]
The ID of the viewer associated with the viewer session to revoke. Do not use this field for personally identifying, confidential, or sensitive information.
viewerSessionVersionsLessThanOrEqualTo (integer) --
An optional filter on which versions of the viewer session to revoke. All versions less than or equal to the specified version will be revoked. Default: 0.
dict
Response Syntax
{
'accessControlAllowOrigin': 'string',
'accessControlExposeHeaders': 'string',
'cacheControl': 'string',
'contentSecurityPolicy': 'string',
'strictTransportSecurity': 'string',
'xContentTypeOptions': 'string',
'xFrameOptions': 'string',
'errors': [
{
'channelArn': 'string',
'viewerId': 'string',
'code': 'string',
'message': 'string'
},
]
}
Response Structure
(dict) --
accessControlAllowOrigin (string) --
See Access-Control-Allow-Origin in the MDN Web Docs.
accessControlExposeHeaders (string) --
See Access-Control-Expose-Headers in the MDN Web Docs.
cacheControl (string) --
See Cache-Control in the MDN Web Docs.
contentSecurityPolicy (string) --
See Content-Security-Policy in the MDN Web Docs.
strictTransportSecurity (string) --
See Strict-Transport-Security in the MDN Web Docs.
xContentTypeOptions (string) --
See X-Content-Type-Options in the MDN Web Docs.
xFrameOptions (string) --
See X-Frame-Options in the MDN Web Docs.
errors (list) --
Each error object is related to a specific channelArn and viewerId pair in the request.
(dict) --
Error for a request in the batch for BatchStartViewerSessionRevocation. Each error is related to a specific channel-ARN and viewer-ID pair.
channelArn (string) --
Channel ARN.
viewerId (string) --
The ID of the viewer session to revoke.
code (string) --
Error code.
message (string) --
Error message, determined by the application.
{'adConfigurationArn': 'string'}
Response {'channel': {'adConfigurationArn': 'string'}}
Creates a new channel and an associated stream key to start streaming.
See also: AWS API Documentation
Request Syntax
client.create_channel(
name='string',
latencyMode='NORMAL'|'LOW',
type='BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD',
authorized=True|False,
recordingConfigurationArn='string',
tags={
'string': 'string'
},
insecureIngest=True|False,
preset='HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
playbackRestrictionPolicyArn='string',
multitrackInputConfiguration={
'enabled': True|False,
'policy': 'ALLOW'|'REQUIRE',
'maximumResolution': 'SD'|'HD'|'FULL_HD'
},
containerFormat='TS'|'FRAGMENTED_MP4',
adConfigurationArn='string'
)
string
Channel name.
string
Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.
string
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
boolean
Whether the channel is private (enabled for playback authorization). Default: false.
string
Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).
dict
Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
(string) --
(string) --
boolean
Whether the channel allows insecure RTMP and SRT ingest. Default: false.
string
Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types ( BASIC and STANDARD), preset is the empty string ( "").
string
Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).
dict
Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.
enabled (boolean) --
Indicates whether multitrack input is enabled. Can be set to true only if channel type is STANDARD. Setting enabled to true with any other channel type will cause an exception. If true, then policy, maximumResolution, and containerFormat are required, and containerFormat must be set to FRAGMENTED_MP4. Default: false.
policy (string) --
Indicates whether multitrack input is allowed or required. Required if enabled is true.
maximumResolution (string) --
Maximum resolution for multitrack input. Required if enabled is true.
string
Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.
string
ARN of the ad configuration associated with the channel.
dict
Response Syntax
{
'channel': {
'arn': 'string',
'name': 'string',
'latencyMode': 'NORMAL'|'LOW',
'type': 'BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD',
'recordingConfigurationArn': 'string',
'ingestEndpoint': 'string',
'playbackUrl': 'string',
'authorized': True|False,
'tags': {
'string': 'string'
},
'insecureIngest': True|False,
'preset': 'HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
'srt': {
'endpoint': 'string',
'passphrase': 'string'
},
'playbackRestrictionPolicyArn': 'string',
'multitrackInputConfiguration': {
'enabled': True|False,
'policy': 'ALLOW'|'REQUIRE',
'maximumResolution': 'SD'|'HD'|'FULL_HD'
},
'containerFormat': 'TS'|'FRAGMENTED_MP4',
'adConfigurationArn': 'string'
},
'streamKey': {
'arn': 'string',
'value': 'string',
'channelArn': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
channel (dict) --
arn (string) --
Channel ARN.
name (string) --
Channel name.
latencyMode (string) --
Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.
type (string) --
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
recordingConfigurationArn (string) --
Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).
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 private (enabled for playback authorization). Default: false.
tags (dict) --
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
(string) --
(string) --
insecureIngest (boolean) --
Whether the channel allows insecure RTMP ingest. Default: false.
preset (string) --
Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types ( BASIC and STANDARD), preset is the empty string ( "").
srt (dict) --
Specifies the endpoint and optional passphrase for streaming with the SRT protocol.
endpoint (string) --
The endpoint to be used when streaming with IVS using the SRT protocol.
passphrase (string) --
Auto-generated passphrase to enable encryption. This field is applicable only if the end user has not enabled the insecureIngest option for the channel.
playbackRestrictionPolicyArn (string) --
Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).
multitrackInputConfiguration (dict) --
Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.
enabled (boolean) --
Indicates whether multitrack input is enabled. Can be set to true only if channel type is STANDARD. Setting enabled to true with any other channel type will cause an exception. If true, then policy, maximumResolution, and containerFormat are required, and containerFormat must be set to FRAGMENTED_MP4. Default: false.
policy (string) --
Indicates whether multitrack input is allowed or required. Required if enabled is true.
maximumResolution (string) --
Maximum resolution for multitrack input. Required if enabled is true.
containerFormat (string) --
Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.
adConfigurationArn (string) --
ARN of the ad configuration associated with the channel.
streamKey (dict) --
arn (string) --
Stream-key ARN.
value (string) --
Stream-key value.
channelArn (string) --
Channel ARN for the stream.
tags (dict) --
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
(string) --
(string) --
{'channel': {'adConfigurationArn': 'string'}}
Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.
See also: AWS API Documentation
Request Syntax
client.get_channel(
arn='string'
)
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'|'ADVANCED_SD'|'ADVANCED_HD',
'recordingConfigurationArn': 'string',
'ingestEndpoint': 'string',
'playbackUrl': 'string',
'authorized': True|False,
'tags': {
'string': 'string'
},
'insecureIngest': True|False,
'preset': 'HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
'srt': {
'endpoint': 'string',
'passphrase': 'string'
},
'playbackRestrictionPolicyArn': 'string',
'multitrackInputConfiguration': {
'enabled': True|False,
'policy': 'ALLOW'|'REQUIRE',
'maximumResolution': 'SD'|'HD'|'FULL_HD'
},
'containerFormat': 'TS'|'FRAGMENTED_MP4',
'adConfigurationArn': 'string'
}
}
Response Structure
(dict) --
channel (dict) --
arn (string) --
Channel ARN.
name (string) --
Channel name.
latencyMode (string) --
Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.
type (string) --
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
recordingConfigurationArn (string) --
Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).
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 private (enabled for playback authorization). Default: false.
tags (dict) --
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
(string) --
(string) --
insecureIngest (boolean) --
Whether the channel allows insecure RTMP ingest. Default: false.
preset (string) --
Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types ( BASIC and STANDARD), preset is the empty string ( "").
srt (dict) --
Specifies the endpoint and optional passphrase for streaming with the SRT protocol.
endpoint (string) --
The endpoint to be used when streaming with IVS using the SRT protocol.
passphrase (string) --
Auto-generated passphrase to enable encryption. This field is applicable only if the end user has not enabled the insecureIngest option for the channel.
playbackRestrictionPolicyArn (string) --
Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).
multitrackInputConfiguration (dict) --
Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.
enabled (boolean) --
Indicates whether multitrack input is enabled. Can be set to true only if channel type is STANDARD. Setting enabled to true with any other channel type will cause an exception. If true, then policy, maximumResolution, and containerFormat are required, and containerFormat must be set to FRAGMENTED_MP4. Default: false.
policy (string) --
Indicates whether multitrack input is allowed or required. Required if enabled is true.
maximumResolution (string) --
Maximum resolution for multitrack input. Required if enabled is true.
containerFormat (string) --
Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.
adConfigurationArn (string) --
ARN of the ad configuration associated with the channel.
{'streamSession': {'channel': {'adConfigurationArn': 'string'}}}
Gets metadata on a specified stream.
See also: AWS API Documentation
Request Syntax
client.get_stream_session(
channelArn='string',
streamId='string'
)
string
[REQUIRED]
ARN of the channel resource
string
Unique identifier for a live or previously live stream in the specified channel. If no streamId is provided, this returns the most recent stream session for the channel, if it exists.
dict
Response Syntax
{
'streamSession': {
'streamId': 'string',
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'channel': {
'arn': 'string',
'name': 'string',
'latencyMode': 'NORMAL'|'LOW',
'type': 'BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD',
'recordingConfigurationArn': 'string',
'ingestEndpoint': 'string',
'playbackUrl': 'string',
'authorized': True|False,
'tags': {
'string': 'string'
},
'insecureIngest': True|False,
'preset': 'HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
'srt': {
'endpoint': 'string',
'passphrase': 'string'
},
'playbackRestrictionPolicyArn': 'string',
'multitrackInputConfiguration': {
'enabled': True|False,
'policy': 'ALLOW'|'REQUIRE',
'maximumResolution': 'SD'|'HD'|'FULL_HD'
},
'containerFormat': 'TS'|'FRAGMENTED_MP4',
'adConfigurationArn': 'string'
},
'ingestConfiguration': {
'video': {
'avcProfile': 'string',
'avcLevel': 'string',
'codec': 'string',
'encoder': 'string',
'targetBitrate': 123,
'targetFramerate': 123,
'videoHeight': 123,
'videoWidth': 123,
'level': 'string',
'track': 'string',
'profile': 'string'
},
'audio': {
'codec': 'string',
'targetBitrate': 123,
'sampleRate': 123,
'channels': 123,
'track': 'string'
}
},
'ingestConfigurations': {
'videoConfigurations': [
{
'avcProfile': 'string',
'avcLevel': 'string',
'codec': 'string',
'encoder': 'string',
'targetBitrate': 123,
'targetFramerate': 123,
'videoHeight': 123,
'videoWidth': 123,
'level': 'string',
'track': 'string',
'profile': 'string'
},
],
'audioConfigurations': [
{
'codec': 'string',
'targetBitrate': 123,
'sampleRate': 123,
'channels': 123,
'track': 'string'
},
]
},
'recordingConfiguration': {
'arn': 'string',
'name': 'string',
'destinationConfiguration': {
's3': {
'bucketName': 'string'
}
},
'state': 'CREATING'|'CREATE_FAILED'|'ACTIVE',
'tags': {
'string': 'string'
},
'thumbnailConfiguration': {
'recordingMode': 'DISABLED'|'INTERVAL',
'targetIntervalSeconds': 123,
'resolution': 'SD'|'HD'|'FULL_HD'|'LOWEST_RESOLUTION',
'storage': [
'SEQUENTIAL'|'LATEST',
]
},
'recordingReconnectWindowSeconds': 123,
'renditionConfiguration': {
'renditionSelection': 'ALL'|'NONE'|'CUSTOM',
'renditions': [
'SD'|'HD'|'FULL_HD'|'LOWEST_RESOLUTION',
]
}
},
'truncatedEvents': [
{
'name': 'string',
'type': 'string',
'eventTime': datetime(2015, 1, 1),
'code': 'string'
},
]
}
}
Response Structure
(dict) --
streamSession (dict) --
List of stream details.
streamId (string) --
Unique identifier for a live or previously live stream in the specified channel.
startTime (datetime) --
Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.
endTime (datetime) --
Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string. For live streams, this is NULL.
channel (dict) --
The properties of the channel at the time of going live.
arn (string) --
Channel ARN.
name (string) --
Channel name.
latencyMode (string) --
Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.
type (string) --
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
recordingConfigurationArn (string) --
Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).
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 private (enabled for playback authorization). Default: false.
tags (dict) --
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
(string) --
(string) --
insecureIngest (boolean) --
Whether the channel allows insecure RTMP ingest. Default: false.
preset (string) --
Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types ( BASIC and STANDARD), preset is the empty string ( "").
srt (dict) --
Specifies the endpoint and optional passphrase for streaming with the SRT protocol.
endpoint (string) --
The endpoint to be used when streaming with IVS using the SRT protocol.
passphrase (string) --
Auto-generated passphrase to enable encryption. This field is applicable only if the end user has not enabled the insecureIngest option for the channel.
playbackRestrictionPolicyArn (string) --
Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).
multitrackInputConfiguration (dict) --
Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.
enabled (boolean) --
Indicates whether multitrack input is enabled. Can be set to true only if channel type is STANDARD. Setting enabled to true with any other channel type will cause an exception. If true, then policy, maximumResolution, and containerFormat are required, and containerFormat must be set to FRAGMENTED_MP4. Default: false.
policy (string) --
Indicates whether multitrack input is allowed or required. Required if enabled is true.
maximumResolution (string) --
Maximum resolution for multitrack input. Required if enabled is true.
containerFormat (string) --
Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.
adConfigurationArn (string) --
ARN of the ad configuration associated with the channel.
ingestConfiguration (dict) --
The properties of the incoming RTMP stream.
Note: ingestConfiguration is deprecated in favor of ingestConfigurations but retained to ensure backward compatibility. If multitrack is not enabled, ingestConfiguration and ingestConfigurations contain the same data, namely information about Track0 (the sole track). If multitrack is enabled, ingestConfiguration contains data for only the first track (Track0) and ingestConfigurations contains data for all tracks.
video (dict) --
Encoder settings for video.
avcProfile (string) --
(Deprecated) Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification. This is populated only when VideoConfiguration is part of the deprecated IngestConfiguration; otherwise, this is an empty string.
avcLevel (string) --
(Deprecated) Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. For details, see the H.264 specification. This is populated only when VideoConfiguration is part of the deprecated IngestConfiguration; otherwise, this is an empty string.
codec (string) --
Codec used for the video encoding.
encoder (string) --
Software or hardware used to encode the video.
targetBitrate (integer) --
The expected ingest bitrate (bits per second). This is configured in the encoder.
targetFramerate (integer) --
The expected ingest framerate. This is configured in the encoder.
videoHeight (integer) --
Video-resolution height in pixels.
videoWidth (integer) --
Video-resolution width in pixels.
level (string) --
Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. When an AVC codec is used, this field has the same value as avcLevel.
track (string) --
Name of the video track. If multitrack is not enabled, this is Track0 (the sole track).
profile (string) --
Indicates to the decoder the requirements for decoding the stream. When an AVC codec is used, this field has the same value as avcProfile.
audio (dict) --
Encoder settings for audio.
codec (string) --
Codec used for the audio encoding.
targetBitrate (integer) --
The expected ingest bitrate (bits per second). This is configured in the encoder.
sampleRate (integer) --
Number of audio samples recorded per second.
channels (integer) --
Number of audio channels.
track (string) --
Name of the audio track (if the stream has an audio track). If multitrack is not enabled, this is Track0 (the sole track).
ingestConfigurations (dict) --
The properties of the incoming RTMP stream. If multitrack is enabled, ingestConfigurations contains data for all tracks; otherwise, it contains data only for Track0 (the sole track).
videoConfigurations (list) --
Encoder settings for video
(dict) --
Object specifying a stream’s video configuration, as set up by the broadcaster (usually in an encoder). This is part of the IngestConfigurations object and the deprecated IngestConfiguration object. It is used for monitoring stream health.
avcProfile (string) --
(Deprecated) Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification. This is populated only when VideoConfiguration is part of the deprecated IngestConfiguration; otherwise, this is an empty string.
avcLevel (string) --
(Deprecated) Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. For details, see the H.264 specification. This is populated only when VideoConfiguration is part of the deprecated IngestConfiguration; otherwise, this is an empty string.
codec (string) --
Codec used for the video encoding.
encoder (string) --
Software or hardware used to encode the video.
targetBitrate (integer) --
The expected ingest bitrate (bits per second). This is configured in the encoder.
targetFramerate (integer) --
The expected ingest framerate. This is configured in the encoder.
videoHeight (integer) --
Video-resolution height in pixels.
videoWidth (integer) --
Video-resolution width in pixels.
level (string) --
Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. When an AVC codec is used, this field has the same value as avcLevel.
track (string) --
Name of the video track. If multitrack is not enabled, this is Track0 (the sole track).
profile (string) --
Indicates to the decoder the requirements for decoding the stream. When an AVC codec is used, this field has the same value as avcProfile.
audioConfigurations (list) --
Encoder settings for audio.
(dict) --
Object specifying a stream’s audio configuration, as set up by the broadcaster (usually in an encoder). This is part of the IngestConfigurations object and the deprecated IngestConfiguration object. It is used for monitoring stream health.
codec (string) --
Codec used for the audio encoding.
targetBitrate (integer) --
The expected ingest bitrate (bits per second). This is configured in the encoder.
sampleRate (integer) --
Number of audio samples recorded per second.
channels (integer) --
Number of audio channels.
track (string) --
Name of the audio track (if the stream has an audio track). If multitrack is not enabled, this is Track0 (the sole track).
recordingConfiguration (dict) --
The properties of recording the live stream.
arn (string) --
Recording-configuration ARN.
name (string) --
Recording-configuration name. The value does not need to be unique.
destinationConfiguration (dict) --
A complex type that contains information about where recorded video will be stored.
s3 (dict) --
An S3 destination configuration where recorded videos will be stored.
bucketName (string) --
Location (S3 bucket name) where recorded videos will be stored.
state (string) --
Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.
tags (dict) --
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
(string) --
(string) --
thumbnailConfiguration (dict) --
A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.
recordingMode (string) --
Thumbnail recording mode. Default: INTERVAL.
targetIntervalSeconds (integer) --
The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.
Important: For the BASIC channel type, or the STANDARD channel type with multitrack input, setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.
resolution (string) --
Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3. Default: Null (source resolution is returned).
storage (list) --
Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.
(string) --
recordingReconnectWindowSeconds (integer) --
If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.
renditionConfiguration (dict) --
Object that describes which renditions should be recorded for a stream.
renditionSelection (string) --
Indicates which set of renditions are recorded for a stream. For BASIC channels, the CUSTOM value has no effect. If CUSTOM is specified, a set of renditions must be specified in the renditions field. Default: ALL.
renditions (list) --
Indicates which renditions are recorded for a stream, if renditionSelection is CUSTOM; otherwise, this field is irrelevant. The selected renditions are recorded if they are available during the stream. If a selected rendition is unavailable, the best available rendition is recorded. For details on the resolution dimensions of each rendition, see Auto-Record to Amazon S3.
(string) --
truncatedEvents (list) --
List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.
(dict) --
Object specifying a stream’s events. For a list of events, see Using Amazon EventBridge with Amazon IVS.
name (string) --
Name that identifies the stream event within a type.
type (string) --
Logical group for certain events.
eventTime (datetime) --
Time when the event occurred. This is an ISO 8601 timestamp; note that this is returned as a string.
code (string) --
Provides additional details about the stream event. There are several values; the long descriptions are provided in the IVS console but not delivered through the IVS API or EventBridge. Multitrack-related codes are used only for certain Session Ended events.
MultitrackInputNotAllowed — The broadcast client attempted to connect with multitrack input, but multitrack input was not enabled on the channel. Check your broadcast software settings or set MultitrackInputConfiguration.Policy to ALLOW or REQUIRE.
MultitrackInputRequired — The broadcast client attempted to connect with single-track video, but multitrack input is required on this channel. Enable multitrack video in your broadcast software or configure the channel’s MultitrackInputConfiguration.Policy to ALLOW.
InvalidGetClientConfigurationStreamKey — The broadcast client attempted to connect with an invalid, expired, or corrupt stream key.
GetClientConfigurationStreamKeyRequired — The broadcast client attempted to stream multitrack video without providing an authenticated stream key from GetClientConfiguration.
InvalidMultitrackInputTrackCount — The multitrack input stream contained an invalid number of tracks.
InvalidMultitrackInputVideoTrackMediaProperties — The multitrack input stream contained one or more tracks with an invalid codec, resolution, bitrate, or framerate.
StreamTakeoverMediaMismatch — The broadcast client attempted to take over with different media properties (e.g., codec, resolution, or video track type) from the original stream.
StreamTakeoverInvalidPriority — The broadcast client attempted a takeover with either a priority integer value equal to or lower than the original stream's value or a value outside the allowed range of 1 to 2,147,483,647. StreamTakeoverLimitBreached — The broadcast client reached the maximum allowed takeover attempts for this stream.
{'filterByAdConfigurationArn': 'string'}
Response {'channels': {'adConfigurationArn': 'string'}}
Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException).
See also: AWS API Documentation
Request Syntax
client.list_channels(
filterByName='string',
filterByRecordingConfigurationArn='string',
filterByPlaybackRestrictionPolicyArn='string',
filterByAdConfigurationArn='string',
nextToken='string',
maxResults=123
)
string
Filters the channel list to match the specified name.
string
Filters the channel list to match the specified recording-configuration ARN.
string
Filters the channel list to match the specified policy.
string
Filters the channel list to match the specified ad configuration ARN.
string
The first channel to retrieve. This is used for pagination; see the nextToken response field.
integer
Maximum number of channels to return. Default: 100.
dict
Response Syntax
{
'channels': [
{
'arn': 'string',
'name': 'string',
'latencyMode': 'NORMAL'|'LOW',
'authorized': True|False,
'recordingConfigurationArn': 'string',
'tags': {
'string': 'string'
},
'insecureIngest': True|False,
'type': 'BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD',
'preset': 'HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
'playbackRestrictionPolicyArn': 'string',
'adConfigurationArn': '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. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.
authorized (boolean) --
Whether the channel is private (enabled for playback authorization). Default: false.
recordingConfigurationArn (string) --
Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).
tags (dict) --
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
(string) --
(string) --
insecureIngest (boolean) --
Whether the channel allows insecure RTMP ingest. Default: false.
type (string) --
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
preset (string) --
Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types ( BASIC and STANDARD), preset is the empty string ( "").
playbackRestrictionPolicyArn (string) --
Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).
adConfigurationArn (string) --
ARN of the ad configuration associated with the channel.
nextToken (string) --
If there are more channels than maxResults, use nextToken in the request to get the next set.
{'adConfigurationArn': 'string'}
Response {'channel': {'adConfigurationArn': 'string'}}
Updates a channel's configuration. Live channels cannot be updated. You must stop the ongoing stream, update the channel, and restart the stream for the changes to take effect.
See also: AWS API Documentation
Request Syntax
client.update_channel(
arn='string',
name='string',
latencyMode='NORMAL'|'LOW',
type='BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD',
authorized=True|False,
recordingConfigurationArn='string',
insecureIngest=True|False,
preset='HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
playbackRestrictionPolicyArn='string',
multitrackInputConfiguration={
'enabled': True|False,
'policy': 'ALLOW'|'REQUIRE',
'maximumResolution': 'SD'|'HD'|'FULL_HD'
},
containerFormat='TS'|'FRAGMENTED_MP4',
adConfigurationArn='string'
)
string
[REQUIRED]
ARN of the channel to be updated.
string
Channel name.
string
Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers.
string
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
boolean
Whether the channel is private (enabled for playback authorization).
string
Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. If this is set to an empty string, recording is disabled.
boolean
Whether the channel allows insecure RTMP and SRT ingest. Default: false.
string
Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types ( BASIC and STANDARD), preset is the empty string ( "").
string
Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. If this is set to an empty string, playback restriction policy is disabled.
dict
Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.
enabled (boolean) --
Indicates whether multitrack input is enabled. Can be set to true only if channel type is STANDARD. Setting enabled to true with any other channel type will cause an exception. If true, then policy, maximumResolution, and containerFormat are required, and containerFormat must be set to FRAGMENTED_MP4. Default: false.
policy (string) --
Indicates whether multitrack input is allowed or required. Required if enabled is true.
maximumResolution (string) --
Maximum resolution for multitrack input. Required if enabled is true.
string
Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.
string
ARN of the ad configuration associated with the channel.
dict
Response Syntax
{
'channel': {
'arn': 'string',
'name': 'string',
'latencyMode': 'NORMAL'|'LOW',
'type': 'BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD',
'recordingConfigurationArn': 'string',
'ingestEndpoint': 'string',
'playbackUrl': 'string',
'authorized': True|False,
'tags': {
'string': 'string'
},
'insecureIngest': True|False,
'preset': 'HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
'srt': {
'endpoint': 'string',
'passphrase': 'string'
},
'playbackRestrictionPolicyArn': 'string',
'multitrackInputConfiguration': {
'enabled': True|False,
'policy': 'ALLOW'|'REQUIRE',
'maximumResolution': 'SD'|'HD'|'FULL_HD'
},
'containerFormat': 'TS'|'FRAGMENTED_MP4',
'adConfigurationArn': 'string'
}
}
Response Structure
(dict) --
channel (dict) --
Object specifying the updated channel.
arn (string) --
Channel ARN.
name (string) --
Channel name.
latencyMode (string) --
Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.
type (string) --
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
recordingConfigurationArn (string) --
Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).
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 private (enabled for playback authorization). Default: false.
tags (dict) --
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
(string) --
(string) --
insecureIngest (boolean) --
Whether the channel allows insecure RTMP ingest. Default: false.
preset (string) --
Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types ( BASIC and STANDARD), preset is the empty string ( "").
srt (dict) --
Specifies the endpoint and optional passphrase for streaming with the SRT protocol.
endpoint (string) --
The endpoint to be used when streaming with IVS using the SRT protocol.
passphrase (string) --
Auto-generated passphrase to enable encryption. This field is applicable only if the end user has not enabled the insecureIngest option for the channel.
playbackRestrictionPolicyArn (string) --
Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).
multitrackInputConfiguration (dict) --
Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.
enabled (boolean) --
Indicates whether multitrack input is enabled. Can be set to true only if channel type is STANDARD. Setting enabled to true with any other channel type will cause an exception. If true, then policy, maximumResolution, and containerFormat are required, and containerFormat must be set to FRAGMENTED_MP4. Default: false.
policy (string) --
Indicates whether multitrack input is allowed or required. Required if enabled is true.
maximumResolution (string) --
Maximum resolution for multitrack input. Required if enabled is true.
containerFormat (string) --
Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.
adConfigurationArn (string) --
ARN of the ad configuration associated with the channel.