IVS / Paginator / ListStreams

ListStreams

class IVS.Paginator.ListStreams

paginator = client.get_paginator('list_streams')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IVS.Client.list_streams().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filterBy={
        'health': 'HEALTHY'|'STARVING'|'UNKNOWN'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• filterBy (dict) –

  Filters the stream list to match the specified criterion.

  • health (string) –

    The stream’s health.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'streams': [
        {
            'channelArn': 'string',
            'streamId': 'string',
            'state': 'LIVE'|'OFFLINE',
            'health': 'HEALTHY'|'STARVING'|'UNKNOWN',
            'viewerCount': 123,
            'startTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • streams (list) –

    List of streams.

    • (dict) –

      Summary information about a stream.

      • channelArn (string) –

        Channel ARN for the stream.

      • streamId (string) –

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

      • state (string) –

        The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a “NotBroadcasting” error will indicate that the stream is not live.

      • health (string) –

        The stream’s health.

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

      • startTime (datetime) –

        Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.

  • NextToken (string) –

    A token to resume pagination.