IVS / Paginator / ListStreamKeys

ListStreamKeys

class IVS.Paginator.ListStreamKeys

paginator = client.get_paginator('list_stream_keys')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    channelArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• channelArn (string) –

  [REQUIRED]

  Channel ARN used to filter the list.

• 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

{
    'streamKeys': [
        {
            'arn': 'string',
            'channelArn': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • streamKeys (list) –

    List of stream keys.

    • (dict) –

      Summary information about a stream key.

      • arn (string) –

        Stream-key ARN.

      • channelArn (string) –

        Channel ARN for the stream.

      • tags (dict) –

        Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no service-specific constraints beyond what is documented there.

        • (string) –

          • (string) –

  • NextToken (string) –

    A token to resume pagination.