Skip to content

get_channel

Operation

get_channel

get_channel(request: GetChannelInput | GetChannelInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetChannelInputDict]) -> GetChannelOutput
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.

Returns information about a specific channel.

Parameters:

Name Type Description Default
request GetChannelInput | GetChannelInputDict | 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[GetChannelInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetChannelOutput

An instance of GetChannelOutput.

get_channel async

get_channel(request: GetChannelInput | GetChannelInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetChannelInputDict]) -> GetChannelOutput
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.

Returns information about a specific channel.

Parameters:

Name Type Description Default
request GetChannelInput | GetChannelInputDict | 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[GetChannelInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetChannelOutput

An instance of GetChannelOutput.

Input

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

GetChannelInputDict

Bases: TypedDict

Dictionary form of GetChannelInput.

Attributes

channel instance-attribute
channel: Required[str]

The ARN or UUID of a channel.

GetChannelInput dataclass

Bases: _SerdeShape

Dataclass for GetChannelInput structure.

Attributes

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

The ARN or UUID of a channel.

Output

GetChannelOutput dataclass

Bases: _SerdeShape

Dataclass for GetChannelOutput structure.

Attributes

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

The ARN of an channel returned by a GetChannel request.

destinations class-attribute instance-attribute
destinations: list[Destination] | 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 = ...

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

name class-attribute instance-attribute
name: str | 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.

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 source for the CloudTrail channel.

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

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