Skip to content

CloudTrail  >  Operations  >  update_channel

update_channel

Operation

update_channel async 

update_channel(input: UpdateChannelInput, plugins: list[Plugin] | None = None) -> UpdateChannelOutput

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

Parameters:

Name Type Description Default
input UpdateChannelInput

An instance of UpdateChannelInput.

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

Input

UpdateChannelInput dataclass

Dataclass for UpdateChannelInput structure.

Attributes

channel class-attribute instance-attribute 
channel: str | None = 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 = 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 = None

Changes the name of the channel.

Output

UpdateChannelOutput dataclass

Dataclass for UpdateChannelOutput structure.

Attributes

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

The ARN of the channel that was updated.

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

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

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

The name of the channel that was updated.

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

The event source of the channel that was updated.