IVS / Paginator / ListStreams


class IVS.Paginator.ListStreams#
paginator = client.get_paginator('list_streams')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'health': 'HEALTHY'|'STARVING'|'UNKNOWN'
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • 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:



Response Syntax

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

Response Structure

  • (dict) –

    • 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; note that this is returned as a string.

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

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

    • NextToken (string) –

      A token to resume pagination.