2022/01/18 - Amazon Interactive Video Service - 3 updated api methods
Changes This release adds support for the new Thumbnail Configuration property for Recording Configurations. For more information see https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html
{'thumbnailConfiguration': {'recordingMode': 'DISABLED | INTERVAL',
'targetIntervalSeconds': 'long'}}
Response {'recordingConfiguration': {'thumbnailConfiguration': {'recordingMode': 'DISABLED '
'| '
'INTERVAL',
'targetIntervalSeconds': 'long'}}}
Creates a new recording configuration, used to enable recording to Amazon S3.
Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording configuration, it returns success even if the S3 bucket is in a different region. In this case, the state of the recording configuration is CREATE_FAILED (instead of ACTIVE). (In other regions, the CLI correctly returns failure if the bucket is in a different region.)
Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region.
See also: AWS API Documentation
Request Syntax
client.create_recording_configuration(
destinationConfiguration={
's3': {
'bucketName': 'string'
}
},
name='string',
tags={
'string': 'string'
},
thumbnailConfiguration={
'recordingMode': 'DISABLED'|'INTERVAL',
'targetIntervalSeconds': 123
}
)
dict
[REQUIRED]
A complex type that contains a destination configuration for where recorded video will be stored.
s3 (dict) --
An S3 destination configuration where recorded videos will be stored.
bucketName (string) -- [REQUIRED]
Location (S3 bucket name) where recorded videos will be stored.
string
Recording-configuration name. The value does not need to be unique.
dict
Array of 1-50 maps, each of the form string:string (key:value).
(string) --
(string) --
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.
dict
Response Syntax
{
'recordingConfiguration': {
'arn': 'string',
'destinationConfiguration': {
's3': {
'bucketName': 'string'
}
},
'name': 'string',
'state': 'CREATING'|'CREATE_FAILED'|'ACTIVE',
'tags': {
'string': 'string'
},
'thumbnailConfiguration': {
'recordingMode': 'DISABLED'|'INTERVAL',
'targetIntervalSeconds': 123
}
}
}
Response Structure
(dict) --
recordingConfiguration (dict) --
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.
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) --
Array of 1-50 maps, each of the form string:string (key:value).
(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.
{'recordingConfiguration': {'thumbnailConfiguration': {'recordingMode': 'DISABLED '
'| '
'INTERVAL',
'targetIntervalSeconds': 'long'}}}
Gets the recording configuration for the specified ARN.
See also: AWS API Documentation
Request Syntax
client.get_recording_configuration(
arn='string'
)
string
[REQUIRED]
ARN of the recording configuration to be retrieved.
dict
Response Syntax
{
'recordingConfiguration': {
'arn': 'string',
'destinationConfiguration': {
's3': {
'bucketName': 'string'
}
},
'name': 'string',
'state': 'CREATING'|'CREATE_FAILED'|'ACTIVE',
'tags': {
'string': 'string'
},
'thumbnailConfiguration': {
'recordingMode': 'DISABLED'|'INTERVAL',
'targetIntervalSeconds': 123
}
}
}
Response Structure
(dict) --
recordingConfiguration (dict) --
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.
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) --
Array of 1-50 maps, each of the form string:string (key:value).
(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.
{'streamSession': {'recordingConfiguration': {'thumbnailConfiguration': {'recordingMode': 'DISABLED '
'| '
'INTERVAL',
'targetIntervalSeconds': 'long'}}}}
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',
'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',
'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.
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) --
Array of 1-50 maps, each of the form string:string (key:value).
(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: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. 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.
BASIC: 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 480p and bitrate can be up to 1.5 Mbps.
endTime (datetime) --
UTC ISO-8601 formatted timestamp of when the channel went offline. 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.
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) --
Array of 1-50 maps, each of the form string:string (key:value).
(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) --
UTC ISO-8601 formatted timestamp of when the channel went live.
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) --
UTC ISO-8601 formatted timestamp of when the event occurred.
name (string) --
Name that identifies the stream event within a type.
type (string) --
Logical group for certain events.