2021/11/18 - Amazon Interactive Video Service - 2 new2 updated api methods
Changes Add APIs for retrieving stream session information and support for filtering live streams by health. For more information, see https://docs.aws.amazon.com/ivs/latest/userguide/stream-health.html
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'
}
},
'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) --
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.
Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.
See also: AWS API Documentation
Request Syntax
client.list_stream_sessions(
channelArn='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
Channel ARN used to filter the list.
integer
Maximum number of streams to return. Default: 50.
string
The first stream to retrieve. This is used for pagination; see the nextToken response field.
dict
Response Syntax
{
'nextToken': 'string',
'streamSessions': [
{
'endTime': datetime(2015, 1, 1),
'hasErrorEvent': True|False,
'startTime': datetime(2015, 1, 1),
'streamId': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
If there are more streams than maxResults, use nextToken in the request to get the next set.
streamSessions (list) --
(dict) --
Summary information about a stream session.
endTime (datetime) --
UTC ISO-8601 formatted timestamp of when the channel went offline. For live streams, this is NULL.
hasErrorEvent (boolean) --
If true, this stream encountered a quota breach or failure.
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.
{'stream': {'streamId': 'string'}}
Gets information about the active (live) stream on a specified channel.
See also: AWS API Documentation
Request Syntax
client.get_stream(
channelArn='string'
)
string
[REQUIRED]
Channel ARN for stream to be accessed.
dict
Response Syntax
{
'stream': {
'channelArn': 'string',
'health': 'HEALTHY'|'STARVING'|'UNKNOWN',
'playbackUrl': 'string',
'startTime': datetime(2015, 1, 1),
'state': 'LIVE'|'OFFLINE',
'streamId': 'string',
'viewerCount': 123
}
}
Response Structure
(dict) --
stream (dict) --
channelArn (string) --
Channel ARN for the stream.
health (string) --
The stream’s health.
playbackUrl (string) --
URL of the master playlist, required by the video player to play the HLS stream.
startTime (datetime) --
Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.
state (string) --
The stream’s state.
streamId (string) --
Unique identifier for a live or previously live stream in the specified channel.
viewerCount (integer) --
A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.
{'filterBy': {'health': 'HEALTHY | STARVING | UNKNOWN'}}
Response {'streams': {'streamId': 'string'}}
Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.
See also: AWS API Documentation
Request Syntax
client.list_streams(
filterBy={
'health': 'HEALTHY'|'STARVING'|'UNKNOWN'
},
maxResults=123,
nextToken='string'
)
dict
Filters the stream list to match the specified criterion.
health (string) --
The stream’s health.
integer
Maximum number of streams to return. Default: 50.
string
The first stream to retrieve. This is used for pagination; see the nextToken response field.
dict
Response Syntax
{
'nextToken': 'string',
'streams': [
{
'channelArn': 'string',
'health': 'HEALTHY'|'STARVING'|'UNKNOWN',
'startTime': datetime(2015, 1, 1),
'state': 'LIVE'|'OFFLINE',
'streamId': 'string',
'viewerCount': 123
},
]
}
Response Structure
(dict) --
nextToken (string) --
If there are more streams than maxResults, use nextToken in the request to get the next set.
streams (list) --
List of streams.
(dict) --
Summary information about a stream.
channelArn (string) --
Channel ARN for the stream.
health (string) --
The stream’s health.
startTime (datetime) --
Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.
state (string) --
The stream’s state.
streamId (string) --
Unique identifier for a live or previously live stream in the specified channel.
viewerCount (integer) --
A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.