delete_channel¶
Operation¶
delete_channel
¶
delete_channel(request: DeleteChannelInput | DeleteChannelInputDict | None = None, /, *, 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 |
|---|---|---|---|
request
|
DeleteChannelInput | DeleteChannelInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DeleteChannelInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteChannelOutput
|
An instance of |
delete_channel
async
¶
delete_channel(request: DeleteChannelInput | DeleteChannelInputDict | None = None, /, *, 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 |
|---|---|---|---|
request
|
DeleteChannelInput | DeleteChannelInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DeleteChannelInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteChannelOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
Output¶
DeleteChannelOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteChannelOutput structure.