list_stream_sessions

IVS.Client.list_stream_sessions(**kwargs)

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

response = client.list_stream_sessions(
    channelArn='string',
    maxResults=123,
    nextToken='string'
)

Parameters

• channelArn (string) --

  [REQUIRED]

  Channel ARN used to filter the list.

• maxResults (integer) -- Maximum number of streams to return. Default: 100.
• nextToken (string) -- The first stream to retrieve. This is used for pagination; see the nextToken response field.

Return type

dict

Returns

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) --

    List of stream sessions.

    • (dict) --

      Summary information about a stream session.

      • 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 .

      • hasErrorEvent (boolean) --

        If true , this stream encountered a quota breach or failure.

      • 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.

Exceptions

• IVS.Client.exceptions.ResourceNotFoundException
• IVS.Client.exceptions.AccessDeniedException
• IVS.Client.exceptions.ValidationException