update_channel¶
Operation¶
async
¶
update_channel(input: UpdateChannelInput, plugins: list[Plugin] | None = None) -> 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 |
|---|---|---|---|
input
|
UpdateChannelInput
|
An instance of |
required |
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 |
|---|---|
UpdateChannelOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for UpdateChannelInput structure.
Attributes¶
class-attribute
instance-attribute
¶
channel: str | None = None
The ARN or ID (the ARN suffix) of the channel that you want to update.
class-attribute
instance-attribute
¶
destinations: list[Destination] | None = None
The ARNs of event data stores that you want to log events arriving through the channel.
Output¶
dataclass
¶
Dataclass for UpdateChannelOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
channel_arn: str | None = None
The ARN of the channel that was updated.
class-attribute
instance-attribute
¶
destinations: list[Destination] | None = None
The event data stores that log events arriving through the channel.
class-attribute
instance-attribute
¶
name: str | None = None
The name of the channel that was updated.
class-attribute
instance-attribute
¶
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)
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.