2024/02/01 - Amazon Interactive Video Service - 5 new 6 updated api methods
Changes This release introduces a new resource Playback Restriction Policy which can be used to geo-restrict or domain-restrict channel stream playback when associated with a channel. New APIs to support this resource were introduced in the form of Create/Delete/Get/Update/List.
Updates a specified playback restriction policy.
See also: AWS API Documentation
Request Syntax
client.update_playback_restriction_policy(
allowedCountries=[
'string',
],
allowedOrigins=[
'string',
],
arn='string',
enableStrictOriginEnforcement=True|False,
name='string'
)
list
A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
(string) --
list
A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
(string) --
string
[REQUIRED]
ARN of the playback-restriction-policy to be updated.
boolean
Whether channel playback is constrained by origin site. Default: false .
string
Playback-restriction-policy name. The value does not need to be unique.
dict
Response Syntax
{
'playbackRestrictionPolicy': {
'allowedCountries': [
'string',
],
'allowedOrigins': [
'string',
],
'arn': 'string',
'enableStrictOriginEnforcement': True|False,
'name': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
playbackRestrictionPolicy (dict) --
Object specifying the updated policy.
allowedCountries (list) --
A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
(string) --
allowedOrigins (list) --
A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
(string) --
arn (string) --
Playback-restriction-policy ARN
enableStrictOriginEnforcement (boolean) --
Whether channel playback is constrained by origin site. Default: false .
name (string) --
Playback-restriction-policy name. The value does not need to be unique.
tags (dict) --
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value) . See Tagging Amazon Web Services Resources for more information, 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) --
Gets summary information about playback restriction policies.
See also: AWS API Documentation
Request Syntax
client.list_playback_restriction_policies(
maxResults=123,
nextToken='string'
)
integer
Maximum number of policies to return. Default: 1.
string
The first policy to retrieve. This is used for pagination; see the nextToken response field.
dict
Response Syntax
{
'nextToken': 'string',
'playbackRestrictionPolicies': [
{
'allowedCountries': [
'string',
],
'allowedOrigins': [
'string',
],
'arn': 'string',
'enableStrictOriginEnforcement': True|False,
'name': 'string',
'tags': {
'string': 'string'
}
},
]
}
Response Structure
(dict) --
nextToken (string) --
If there are more channels than maxResults , use nextToken in the request to get the next set.
playbackRestrictionPolicies (list) --
List of the matching policies.
(dict) --
Summary information about a PlaybackRestrictionPolicy.
allowedCountries (list) --
A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
(string) --
allowedOrigins (list) --
A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
(string) --
arn (string) --
Playback-restriction-policy ARN
enableStrictOriginEnforcement (boolean) --
Whether channel playback is constrained by origin site. Default: false .
name (string) --
Playback-restriction-policy name. The value does not need to be unique.
tags (dict) --
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value) . See Tagging Amazon Web Services Resources for more information, 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) --
Creates a new playback restriction policy, for constraining playback by countries and/or origins.
See also: AWS API Documentation
Request Syntax
client.create_playback_restriction_policy(
allowedCountries=[
'string',
],
allowedOrigins=[
'string',
],
enableStrictOriginEnforcement=True|False,
name='string',
tags={
'string': 'string'
}
)
list
A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
(string) --
list
A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
(string) --
boolean
Whether channel playback is constrained by origin site. Default: false .
string
Playback-restriction-policy name. The value does not need to be unique.
dict
Array of 1-50 maps, each of the form string:string (key:value) . See Tagging Amazon Web Services Resources for more information, 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) --
dict
Response Syntax
{
'playbackRestrictionPolicy': {
'allowedCountries': [
'string',
],
'allowedOrigins': [
'string',
],
'arn': 'string',
'enableStrictOriginEnforcement': True|False,
'name': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
playbackRestrictionPolicy (dict) --
allowedCountries (list) --
A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
(string) --
allowedOrigins (list) --
A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
(string) --
arn (string) --
Playback-restriction-policy ARN
enableStrictOriginEnforcement (boolean) --
Whether channel playback is constrained by origin site. Default: false .
name (string) --
Playback-restriction-policy name. The value does not need to be unique.
tags (dict) --
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value) . See Tagging Amazon Web Services Resources for more information, 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 playback restriction policy.
See also: AWS API Documentation
Request Syntax
client.delete_playback_restriction_policy(
arn='string'
)
string
[REQUIRED]
ARN of the playback restriction policy to be deleted.
None
Gets the specified playback restriction policy.
See also: AWS API Documentation
Request Syntax
client.get_playback_restriction_policy(
arn='string'
)
string
[REQUIRED]
ARN of the playback restriction policy to be returned.
dict
Response Syntax
{
'playbackRestrictionPolicy': {
'allowedCountries': [
'string',
],
'allowedOrigins': [
'string',
],
'arn': 'string',
'enableStrictOriginEnforcement': True|False,
'name': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
playbackRestrictionPolicy (dict) --
allowedCountries (list) --
A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
(string) --
allowedOrigins (list) --
A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
(string) --
arn (string) --
Playback-restriction-policy ARN
enableStrictOriginEnforcement (boolean) --
Whether channel playback is constrained by origin site. Default: false .
name (string) --
Playback-restriction-policy name. The value does not need to be unique.
tags (dict) --
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value) . See Tagging Amazon Web Services Resources for more information, 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) --
{'channels': {'playbackRestrictionPolicyArn': '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
{
'channels': [
{
'arn': 'string',
'authorized': True|False,
'ingestEndpoint': 'string',
'insecureIngest': True|False,
'latencyMode': 'NORMAL'|'LOW',
'name': 'string',
'playbackRestrictionPolicyArn': 'string',
'playbackUrl': 'string',
'preset': 'HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
'recordingConfigurationArn': 'string',
'tags': {
'string': 'string'
},
'type': 'BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD'
},
],
'errors': [
{
'arn': 'string',
'code': 'string',
'message': 'string'
},
]
}
Response Structure
(dict) --
channels (list) --
(dict) --
Object specifying a channel.
arn (string) --
Channel ARN.
authorized (boolean) --
Whether the channel is private (enabled for playback authorization). Default: false .
ingestEndpoint (string) --
Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
insecureIngest (boolean) --
Whether the channel allows insecure RTMP ingest. Default: false .
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 . (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
name (string) --
Channel name.
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).
playbackUrl (string) --
Channel playback URL.
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 ( "" ).
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 Tagging Amazon Web Services Resources for more information, 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) --
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.
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.
{'playbackRestrictionPolicyArn': 'string'}
Response {'channel': {'playbackRestrictionPolicyArn': 'string'}}
Creates a new channel and an associated stream key to start streaming.
See also: AWS API Documentation
Request Syntax
client.create_channel(
authorized=True|False,
insecureIngest=True|False,
latencyMode='NORMAL'|'LOW',
name='string',
playbackRestrictionPolicyArn='string',
preset='HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
recordingConfigurationArn='string',
tags={
'string': 'string'
},
type='BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD'
)
boolean
Whether the channel is private (enabled for playback authorization). Default: false .
boolean
Whether the channel allows insecure RTMP ingest. Default: false .
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. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.) Default: LOW .
string
Channel name.
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).
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
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 Tagging Amazon Web Services Resources for more information, 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) --
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.
dict
Response Syntax
{
'channel': {
'arn': 'string',
'authorized': True|False,
'ingestEndpoint': 'string',
'insecureIngest': True|False,
'latencyMode': 'NORMAL'|'LOW',
'name': 'string',
'playbackRestrictionPolicyArn': 'string',
'playbackUrl': 'string',
'preset': 'HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
'recordingConfigurationArn': 'string',
'tags': {
'string': 'string'
},
'type': 'BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD'
},
'streamKey': {
'arn': 'string',
'channelArn': 'string',
'tags': {
'string': 'string'
},
'value': 'string'
}
}
Response Structure
(dict) --
channel (dict) --
arn (string) --
Channel ARN.
authorized (boolean) --
Whether the channel is private (enabled for playback authorization). Default: false .
ingestEndpoint (string) --
Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
insecureIngest (boolean) --
Whether the channel allows insecure RTMP ingest. Default: false .
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 . (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
name (string) --
Channel name.
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).
playbackUrl (string) --
Channel playback URL.
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 ( "" ).
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 Tagging Amazon Web Services Resources for more information, 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) --
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.
streamKey (dict) --
arn (string) --
Stream-key ARN.
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 Tagging Amazon Web Services Resources for more information, 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) --
value (string) --
Stream-key value.
{'channel': {'playbackRestrictionPolicyArn': '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',
'authorized': True|False,
'ingestEndpoint': 'string',
'insecureIngest': True|False,
'latencyMode': 'NORMAL'|'LOW',
'name': 'string',
'playbackRestrictionPolicyArn': 'string',
'playbackUrl': 'string',
'preset': 'HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
'recordingConfigurationArn': 'string',
'tags': {
'string': 'string'
},
'type': 'BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD'
}
}
Response Structure
(dict) --
channel (dict) --
arn (string) --
Channel ARN.
authorized (boolean) --
Whether the channel is private (enabled for playback authorization). Default: false .
ingestEndpoint (string) --
Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
insecureIngest (boolean) --
Whether the channel allows insecure RTMP ingest. Default: false .
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 . (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
name (string) --
Channel name.
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).
playbackUrl (string) --
Channel playback URL.
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 ( "" ).
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 Tagging Amazon Web Services Resources for more information, 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) --
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.
{'streamSession': {'channel': {'playbackRestrictionPolicyArn': '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': {
'channel': {
'arn': 'string',
'authorized': True|False,
'ingestEndpoint': 'string',
'insecureIngest': True|False,
'latencyMode': 'NORMAL'|'LOW',
'name': 'string',
'playbackRestrictionPolicyArn': 'string',
'playbackUrl': 'string',
'preset': 'HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
'recordingConfigurationArn': 'string',
'tags': {
'string': 'string'
},
'type': 'BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD'
},
'endTime': datetime(2015, 1, 1),
'ingestConfiguration': {
'audio': {
'channels': 123,
'codec': 'string',
'sampleRate': 123,
'targetBitrate': 123
},
'video': {
'avcLevel': 'string',
'avcProfile': 'string',
'codec': 'string',
'encoder': 'string',
'targetBitrate': 123,
'targetFramerate': 123,
'videoHeight': 123,
'videoWidth': 123
}
},
'recordingConfiguration': {
'arn': 'string',
'destinationConfiguration': {
's3': {
'bucketName': 'string'
}
},
'name': 'string',
'recordingReconnectWindowSeconds': 123,
'renditionConfiguration': {
'renditionSelection': 'ALL'|'NONE'|'CUSTOM',
'renditions': [
'FULL_HD'|'HD'|'SD'|'LOWEST_RESOLUTION',
]
},
'state': 'CREATING'|'CREATE_FAILED'|'ACTIVE',
'tags': {
'string': 'string'
},
'thumbnailConfiguration': {
'recordingMode': 'DISABLED'|'INTERVAL',
'resolution': 'FULL_HD'|'HD'|'SD'|'LOWEST_RESOLUTION',
'storage': [
'SEQUENTIAL'|'LATEST',
],
'targetIntervalSeconds': 123
}
},
'startTime': datetime(2015, 1, 1),
'streamId': 'string',
'truncatedEvents': [
{
'eventTime': datetime(2015, 1, 1),
'name': 'string',
'type': 'string'
},
]
}
}
Response Structure
(dict) --
streamSession (dict) --
List of stream details.
channel (dict) --
The properties of the channel at the time of going live.
arn (string) --
Channel ARN.
authorized (boolean) --
Whether the channel is private (enabled for playback authorization). Default: false .
ingestEndpoint (string) --
Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
insecureIngest (boolean) --
Whether the channel allows insecure RTMP ingest. Default: false .
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 . (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
name (string) --
Channel name.
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).
playbackUrl (string) --
Channel playback URL.
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 ( "" ).
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 Tagging Amazon Web Services Resources for more information, 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) --
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.
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 .
ingestConfiguration (dict) --
The properties of the incoming RTMP stream for the stream.
audio (dict) --
Encoder settings for audio.
channels (integer) --
Number of audio channels.
codec (string) --
Codec used for the audio encoding.
sampleRate (integer) --
Number of audio samples recorded per second.
targetBitrate (integer) --
The expected ingest bitrate (bits per second). This is configured in the encoder.
video (dict) --
Encoder settings for video.
avcLevel (string) --
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.
avcProfile (string) --
Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification.
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.
recordingConfiguration (dict) --
The properties of recording the live stream.
arn (string) --
Recording-configuration ARN.
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.
name (string) --
Recording-configuration name. The value does not need to be unique.
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) --
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 Tagging Amazon Web Services Resources for more information, 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 .
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) --
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, 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.
startTime (datetime) --
Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string .
streamId (string) --
Unique identifier for a live or previously live stream in the specified channel.
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.
eventTime (datetime) --
Time when the event occurred. This is an ISO 8601 timestamp; note that this is returned as a string .
name (string) --
Name that identifies the stream event within a type .
type (string) --
Logical group for certain events.
{'filterByPlaybackRestrictionPolicyArn': 'string'}
Response {'channels': {'playbackRestrictionPolicyArn': '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',
filterByPlaybackRestrictionPolicyArn='string',
filterByRecordingConfigurationArn='string',
maxResults=123,
nextToken='string'
)
string
Filters the channel list to match the specified name.
string
Filters the channel list to match the specified policy.
string
Filters the channel list to match the specified recording-configuration ARN.
integer
Maximum number of channels to return. Default: 100.
string
The first channel to retrieve. This is used for pagination; see the nextToken response field.
dict
Response Syntax
{
'channels': [
{
'arn': 'string',
'authorized': True|False,
'insecureIngest': True|False,
'latencyMode': 'NORMAL'|'LOW',
'name': 'string',
'playbackRestrictionPolicyArn': 'string',
'preset': 'HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
'recordingConfigurationArn': 'string',
'tags': {
'string': 'string'
},
'type': 'BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
channels (list) --
List of the matching channels.
(dict) --
Summary information about a channel.
arn (string) --
Channel ARN.
authorized (boolean) --
Whether the channel is private (enabled for playback authorization). Default: false .
insecureIngest (boolean) --
Whether the channel allows insecure RTMP ingest. Default: false .
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 . (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
name (string) --
Channel name.
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).
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 ( "" ).
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 Tagging Amazon Web Services Resources for more information, 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) --
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.
nextToken (string) --
If there are more channels than maxResults , use nextToken in the request to get the next set.
{'playbackRestrictionPolicyArn': 'string'}
Response {'channel': {'playbackRestrictionPolicyArn': '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',
authorized=True|False,
insecureIngest=True|False,
latencyMode='NORMAL'|'LOW',
name='string',
playbackRestrictionPolicyArn='string',
preset='HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
recordingConfigurationArn='string',
type='BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD'
)
string
[REQUIRED]
ARN of the channel to be updated.
boolean
Whether the channel is private (enabled for playback authorization).
boolean
Whether the channel allows insecure RTMP ingest. Default: false .
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. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
string
Channel name.
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.
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
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.
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.
dict
Response Syntax
{
'channel': {
'arn': 'string',
'authorized': True|False,
'ingestEndpoint': 'string',
'insecureIngest': True|False,
'latencyMode': 'NORMAL'|'LOW',
'name': 'string',
'playbackRestrictionPolicyArn': 'string',
'playbackUrl': 'string',
'preset': 'HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
'recordingConfigurationArn': 'string',
'tags': {
'string': 'string'
},
'type': 'BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD'
}
}
Response Structure
(dict) --
channel (dict) --
Object specifying the updated channel.
arn (string) --
Channel ARN.
authorized (boolean) --
Whether the channel is private (enabled for playback authorization). Default: false .
ingestEndpoint (string) --
Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
insecureIngest (boolean) --
Whether the channel allows insecure RTMP ingest. Default: false .
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 . (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
name (string) --
Channel name.
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).
playbackUrl (string) --
Channel playback URL.
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 ( "" ).
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 Tagging Amazon Web Services Resources for more information, 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) --
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.