Skip to content

Kinesis  >  Operations  >  delete_channel

delete_channel

Operation

delete_channel async

delete_channel(request: DeleteChannelInput | DeleteChannelInputDict, /, *, plugins: list[Plugin] | None = None) -> DeleteChannelOutput
delete_channel(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteChannelInputDict]) -> DeleteChannelOutput

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 ListChannels 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.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DeleteChannelOutput

An instance of DeleteChannelOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DeleteChannelInput dataclass

Bases: _SerdeShape

Dataclass for DeleteChannelInput structure.

Attributes
channel_arn class-attribute instance-attribute
channel_arn: str | None = ...

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

Dictionaries

DeleteChannelInputDict

Bases: TypedDict

Dictionary form of DeleteChannelInput.

Attributes
channel_arn instance-attribute
channel_arn: Required[str]

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

Output

DeleteChannelOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteChannelOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.