IVS / Client / list_stream_sessions

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',
    nextToken='string',
    maxResults=123
)
Parameters:

  • channelArn (string) –

    [REQUIRED]

    Channel ARN used to filter the list.

  • nextToken (string) – The first stream to retrieve. This is used for pagination; see the nextToken response field.

  • maxResults (integer) – Maximum number of streams to return. Default: 100.

Return type:

dict

Returns:

Response Syntax

{
    'streamSessions': [
        {
            'streamId': 'string',
            'startTime': datetime(2015, 1, 1),
            'endTime': datetime(2015, 1, 1),
            'hasErrorEvent': True|False
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • streamSessions (list) –

      List of stream sessions.

      • (dict) –

        Summary information about a stream session.

        • streamId (string) –

          Unique identifier for a live or previously live stream in the specified channel.

        • startTime (datetime) –

          Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.

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

    • nextToken (string) –

      If there are more streams than maxResults, use nextToken in the request to get the next set.

Exceptions

  • IVS.Client.exceptions.ResourceNotFoundException

  • IVS.Client.exceptions.AccessDeniedException

  • IVS.Client.exceptions.ValidationException