KinesisVideo / Client / list_signaling_channels

list_signaling_channels#

KinesisVideo.Client.list_signaling_channels(**kwargs)#

Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can specify a ChannelNameCondition.

See also: AWS API Documentation

Request Syntax

response = client.list_signaling_channels(
    MaxResults=123,
    NextToken='string',
    ChannelNameCondition={
        'ComparisonOperator': 'BEGINS_WITH',
        'ComparisonValue': 'string'
    }
)
Parameters:

  • MaxResults (integer) – The maximum number of channels to return in the response. The default is 500.

  • NextToken (string) – If you specify this parameter, when the result of a ListSignalingChannels operation is truncated, the call returns the NextToken in the response. To get another batch of channels, provide this token in your next request.

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

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'
        },
    ],
    'NextToken': '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.

    • NextToken (string) –

      If the response is truncated, the call returns this element with a token. To get the next batch of streams, use this token in your next request.

Exceptions