ListSignalingChannels

class KinesisVideo.Paginator.ListSignalingChannels

paginator = client.get_paginator('list_signaling_channels')

paginate(**kwargs)

Creates an iterator that will paginate through responses from KinesisVideo.Client.list_signaling_channels().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ChannelNameCondition={
        'ComparisonOperator': 'BEGINS_WITH',
        'ComparisonValue': 'string'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

• ChannelNameCondition (dict) --

  Optional: Returns only the channels that satisfy a specific condition.

  • ComparisonOperator (string) --

    A comparison operator. Currently, you can only specify the BEGINS_WITH operator, which finds signaling channels whose names begin with a given prefix.

  • ComparisonValue (string) --

    A value to compare.

• 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

{
    'ChannelInfoList': [
        {
            'ChannelName': 'string',
            'ChannelARN': 'string',
            'ChannelType': 'SINGLE_MASTER'|'FULL_MESH',
            'ChannelStatus': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING',
            'CreationTime': datetime(2015, 1, 1),
            'SingleMasterConfiguration': {
                'MessageTtlSeconds': 123
            },
            'Version': 'string'
        },
    ],

}

Response Structure

• (dict) --

  • ChannelInfoList (list) --

    An array of ChannelInfo objects.

    • (dict) --

      A structure that encapsulates a signaling channel's metadata and properties.

      • ChannelName (string) --

        The name of the signaling channel.

      • ChannelARN (string) --

        The Amazon Resource Name (ARN) of the signaling channel.

      • ChannelType (string) --

        The type of the signaling channel.

      • ChannelStatus (string) --

        Current status of the signaling channel.

      • CreationTime (datetime) --

        The time at which the signaling channel was created.

      • SingleMasterConfiguration (dict) --

        A structure that contains the configuration for the SINGLE_MASTER channel type.

        • MessageTtlSeconds (integer) --

          The period of time a signaling channel retains undelivered messages before they are discarded.

      • Version (string) --

        The current version of the signaling channel.