Skip to content

update_channel

Operation

update_channel

update_channel(request: UpdateChannelInput | UpdateChannelInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateChannelInputDict]) -> UpdateChannelOutput
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.

Updates a channel specified by a required channel ARN or UUID.

Parameters:

Name Type Description Default
request UpdateChannelInput | UpdateChannelInputDict | 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[UpdateChannelInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateChannelOutput

An instance of UpdateChannelOutput.

update_channel async

update_channel(request: UpdateChannelInput | UpdateChannelInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateChannelInputDict]) -> UpdateChannelOutput
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.

Updates a channel specified by a required channel ARN or UUID.

Parameters:

Name Type Description Default
request UpdateChannelInput | UpdateChannelInputDict | 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[UpdateChannelInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateChannelOutput

An instance of UpdateChannelOutput.

Input

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

UpdateChannelInputDict

Bases: TypedDict

Dictionary form of UpdateChannelInput.

Attributes

channel instance-attribute
channel: Required[str]

The ARN or ID (the ARN suffix) of the channel that you want to update.

destinations instance-attribute
destinations: Sequence[Destination | DestinationDict] | None

The ARNs of event data stores that you want to log events arriving through the channel.

name instance-attribute
name: str | None

Changes the name of the channel.

UpdateChannelInput dataclass

Bases: _SerdeShape

Dataclass for UpdateChannelInput structure.

Attributes

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

The ARN or ID (the ARN suffix) of the channel that you want to update.

destinations class-attribute instance-attribute
destinations: list[Destination] | None = ...

The ARNs of event data stores that you want to log events arriving through the channel.

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

Changes the name of the channel.

Output

UpdateChannelOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateChannelOutput structure.

Attributes

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

The ARN of the channel that was updated.

destinations class-attribute instance-attribute
destinations: list[Destination] | None = ...

The event data stores that log events arriving through the channel.

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

The name of the channel that was updated.

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.

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

The event source of the channel that was updated.