Kinesis / Client / delete_channel

delete_channel¶

Kinesis.Client.delete_channel(**kwargs)¶

Deletes the specified channel. Deleting a channel stops delivery from the source stream to the destination. Data already delivered to the destination is not deleted.

A stream cannot be deleted while it has active channels. To delete the stream, first delete all channels attached to it. To find them, use ListChannels with a stream filter.

This operation has a call limit of 5 transactions per second (TPS) for each Amazon Web Services account. Exceeding 5 TPS results in a LimitExceededException.

Request Syntax

response = client.delete_channel(
    ChannelARN='string'
)

Parameters:

ChannelARN (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the channel to delete.

Returns:

None

Exceptions

Kinesis.Client.exceptions.ValidationException
Kinesis.Client.exceptions.ResourceNotFoundException
Kinesis.Client.exceptions.LimitExceededException
Kinesis.Client.exceptions.InvalidArgumentException
Kinesis.Client.exceptions.AccessDeniedException