KinesisVideo / Client / update_signaling_channel

update_signaling_channel

KinesisVideo.Client.update_signaling_channel(**kwargs)

Updates the existing signaling channel. This is an asynchronous operation and takes time to complete.

If the MessageTtlSeconds value is updated (either increased or reduced), it only applies to new messages sent via this channel after it’s been updated. Existing messages are still expired as per the previous MessageTtlSeconds value.

See also: AWS API Documentation

Request Syntax

response = client.update_signaling_channel(
    ChannelARN='string',
    CurrentVersion='string',
    SingleMasterConfiguration={
        'MessageTtlSeconds': 123
    }
)
Parameters:

  • ChannelARN (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the signaling channel that you want to update.

  • CurrentVersion (string) –

    [REQUIRED]

    The current version of the signaling channel that you want to update.

  • SingleMasterConfiguration (dict) –

    The structure containing the configuration for the SINGLE_MASTER type of the signaling channel that you want to update. This parameter and the channel message’s time-to-live are required for channels with the SINGLE_MASTER channel type.

    • MessageTtlSeconds (integer) –

      The period of time (in seconds) a signaling channel retains undelivered messages before they are discarded. Use to update this value.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions