KinesisVideo / Client / delete_signaling_channel

delete_signaling_channel#

KinesisVideo.Client.delete_signaling_channel(**kwargs)#

Deletes a specified signaling channel. DeleteSignalingChannel is an asynchronous operation. If you don’t specify the channel’s current version, the most recent version is deleted.

See also: AWS API Documentation

Request Syntax

response = client.delete_signaling_channel(
    ChannelARN='string',
    CurrentVersion='string'
)
Parameters:

  • ChannelARN (string) –

    [REQUIRED]

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

  • CurrentVersion (string) – The current version of the signaling channel that you want to delete. You can obtain the current version by invoking the DescribeSignalingChannel or ListSignalingChannels API operations.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • KinesisVideo.Client.exceptions.InvalidArgumentException

  • KinesisVideo.Client.exceptions.ClientLimitExceededException

  • KinesisVideo.Client.exceptions.ResourceNotFoundException

  • KinesisVideo.Client.exceptions.AccessDeniedException

  • KinesisVideo.Client.exceptions.VersionMismatchException

  • KinesisVideo.Client.exceptions.ResourceInUseException