Skip to content

CloudTrail  >  Operations  >  get_channel

get_channel

Operation

get_channel async 

get_channel(input: GetChannelInput, plugins: list[Plugin] | None = None) -> GetChannelOutput

Returns information about a specific channel.

Parameters:

Name Type Description Default
input GetChannelInput

An instance of GetChannelInput.

 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
GetChannelOutput

An instance of GetChannelOutput.

Input

GetChannelInput dataclass

Dataclass for GetChannelInput structure.

Attributes

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

The ARN or UUID of a channel.

Output

GetChannelOutput dataclass

Dataclass for GetChannelOutput structure.

Attributes

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

The ARN of an channel returned by a GetChannel request.

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

The destinations for the channel. For channels created for integrations, the destinations are the event data stores that log events arriving through the channel. For service-linked channels, the destination is the Amazon Web Services service that created the service-linked channel to receive events.

ingestion_status class-attribute instance-attribute 
ingestion_status: IngestionStatus | None = None

A table showing information about the most recent successful and failed attempts to ingest events.

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

The name of the CloudTrail channel. For service-linked channels, the name is aws-service-channel/service-name/custom-suffix where service-name represents the name of the Amazon Web Services service that created the channel and custom-suffix represents the suffix generated by the Amazon Web Services service.

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

The source for the CloudTrail channel.

source_config class-attribute instance-attribute 
source_config: SourceConfig | None = None

Provides information about the advanced event selectors configured for the channel, and whether the channel applies to all Regions or a single Region.