Skip to content

Deletes the specified channel

Description

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. Use list_channels with a stream filter to find the channels attached to a stream before deleting it.

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.

Usage

kinesis_delete_channel(ChannelARN)

Arguments

  • ChannelARN

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

Value

An empty list.

Request syntax

svc$delete_channel(
  ChannelARN = "string"
)