2023/03/30 - Amazon Interactive Video Service - 6 updated api methods
Changes Amazon Interactive Video Service (IVS) now offers customers the ability to configure IVS channels to allow insecure RTMP ingest.
{'channels': {'insecureIngest': 'boolean'}}
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',
'playbackUrl': 'string',
'recordingConfigurationArn': 'string',
'tags': {
'string': 'string'
},
'type': 'BASIC'|'STANDARD'
},
],
'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.
playbackUrl (string) --
Channel playback URL.
recordingConfigurationArn (string) --
Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. 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 resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:
STANDARD: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.
BASIC: Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.
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.
{'insecureIngest': 'boolean'}
Response {'channel': {'insecureIngest': 'boolean'}}
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',
recordingConfigurationArn='string',
tags={
'string': 'string'
},
type='BASIC'|'STANDARD'
)
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
Recording-configuration ARN. 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 resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:
STANDARD: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.
BASIC: Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.
dict
Response Syntax
{
'channel': {
'arn': 'string',
'authorized': True|False,
'ingestEndpoint': 'string',
'insecureIngest': True|False,
'latencyMode': 'NORMAL'|'LOW',
'name': 'string',
'playbackUrl': 'string',
'recordingConfigurationArn': 'string',
'tags': {
'string': 'string'
},
'type': 'BASIC'|'STANDARD'
},
'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.
playbackUrl (string) --
Channel playback URL.
recordingConfigurationArn (string) --
Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. 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 resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:
STANDARD: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.
BASIC: Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.
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': {'insecureIngest': 'boolean'}}
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',
'playbackUrl': 'string',
'recordingConfigurationArn': 'string',
'tags': {
'string': 'string'
},
'type': 'BASIC'|'STANDARD'
}
}
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.
playbackUrl (string) --
Channel playback URL.
recordingConfigurationArn (string) --
Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. 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 resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:
STANDARD: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.
BASIC: Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.
{'streamSession': {'channel': {'insecureIngest': 'boolean'}}}
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',
'playbackUrl': 'string',
'recordingConfigurationArn': 'string',
'tags': {
'string': 'string'
},
'type': 'BASIC'|'STANDARD'
},
'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,
'state': 'CREATING'|'CREATE_FAILED'|'ACTIVE',
'tags': {
'string': 'string'
},
'thumbnailConfiguration': {
'recordingMode': 'DISABLED'|'INTERVAL',
'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.
playbackUrl (string) --
Channel playback URL.
recordingConfigurationArn (string) --
Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. 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 resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:
STANDARD: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.
BASIC: Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.
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.
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.
targetIntervalSeconds (integer) --
The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.
Important: 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.
{'channels': {'insecureIngest': 'boolean'}}
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',
maxResults=123,
nextToken='string'
)
string
Filters the channel list to match the specified name.
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',
'recordingConfigurationArn': 'string',
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
channels (list) --
List of the matching channels.
(dict) --
Summary information about a channel.
arn (string) --
Channel ARN.
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.
recordingConfigurationArn (string) --
Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. 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) --
nextToken (string) --
If there are more channels than maxResults, use nextToken in the request to get the next set.
{'insecureIngest': 'boolean'}
Response {'channel': {'insecureIngest': 'boolean'}}
Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.
See also: AWS API Documentation
Request Syntax
client.update_channel(
arn='string',
authorized=True|False,
insecureIngest=True|False,
latencyMode='NORMAL'|'LOW',
name='string',
recordingConfigurationArn='string',
type='BASIC'|'STANDARD'
)
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
Recording-configuration ARN. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled
string
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values:
STANDARD: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.
BASIC: Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.
dict
Response Syntax
{
'channel': {
'arn': 'string',
'authorized': True|False,
'ingestEndpoint': 'string',
'insecureIngest': True|False,
'latencyMode': 'NORMAL'|'LOW',
'name': 'string',
'playbackUrl': 'string',
'recordingConfigurationArn': 'string',
'tags': {
'string': 'string'
},
'type': 'BASIC'|'STANDARD'
}
}
Response Structure
(dict) --
channel (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.
playbackUrl (string) --
Channel playback URL.
recordingConfigurationArn (string) --
Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. 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 resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:
STANDARD: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.
BASIC: Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.