Skip to content

delete_channel

Operation

delete_channel

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

CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.

Deletes a channel.

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

delete_channel async

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

CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.

Deletes a channel.

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

Input

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

DeleteChannelInputDict

Bases: TypedDict

Dictionary form of DeleteChannelInput.

Attributes

channel instance-attribute
channel: Required[str]

The ARN or the UUID value of the channel that you want to delete.

DeleteChannelInput dataclass

Bases: _SerdeShape

Dataclass for DeleteChannelInput structure.

Attributes

channel class-attribute instance-attribute
channel: str | None = ...

The ARN or the UUID value of the channel that you want 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.