KinesisVideo / Client / create_signaling_channel

create_signaling_channel#

KinesisVideo.Client.create_signaling_channel(**kwargs)#

Creates a signaling channel.

CreateSignalingChannel is an asynchronous operation.

See also: AWS API Documentation

Request Syntax

response = client.create_signaling_channel(
    ChannelName='string',
    ChannelType='SINGLE_MASTER'|'FULL_MESH',
    SingleMasterConfiguration={
        'MessageTtlSeconds': 123
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • ChannelName (string) –

    [REQUIRED]

    A name for the signaling channel that you are creating. It must be unique for each Amazon Web Services account and Amazon Web Services Region.

  • ChannelType (string) – A type of the signaling channel that you are creating. Currently, SINGLE_MASTER is the only supported channel type.

  • SingleMasterConfiguration (dict) –

    A structure containing the configuration for the SINGLE_MASTER channel type.

    • MessageTtlSeconds (integer) –

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

  • Tags (list) –

    A set of tags (key-value pairs) that you want to associate with this channel.

    • (dict) –

      A key and value pair that is associated with the specified signaling channel.

      • Key (string) – [REQUIRED]

        The key of the tag that is associated with the specified signaling channel.

      • Value (string) – [REQUIRED]

        The value of the tag that is associated with the specified signaling channel.

Return type:

dict

Returns:

Response Syntax

{
    'ChannelARN': 'string'
}

Response Structure

  • (dict) –

    • ChannelARN (string) –

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

Exceptions

  • KinesisVideo.Client.exceptions.InvalidArgumentException

  • KinesisVideo.Client.exceptions.ClientLimitExceededException

  • KinesisVideo.Client.exceptions.AccountChannelLimitExceededException

  • KinesisVideo.Client.exceptions.ResourceInUseException

  • KinesisVideo.Client.exceptions.AccessDeniedException

  • KinesisVideo.Client.exceptions.TagsPerResourceExceededLimitException