KinesisVideo / Client / describe_signaling_channel

describe_signaling_channel#

KinesisVideo.Client.describe_signaling_channel(**kwargs)#

Returns the most current information about the signaling channel. You must specify either the name or the Amazon Resource Name (ARN) of the channel that you want to describe.

See also: AWS API Documentation

Request Syntax

response = client.describe_signaling_channel(
    ChannelName='string',
    ChannelARN='string'
)
Parameters:

  • ChannelName (string) – The name of the signaling channel that you want to describe.

  • ChannelARN (string) – The ARN of the signaling channel that you want to describe.

Return type:

dict

Returns:

Response Syntax

{
    'ChannelInfo': {
        '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) –

    • ChannelInfo (dict) –

      A structure that encapsulates the specified 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.

Exceptions