get_channel¶
Operation¶
async
¶
get_channel(input: GetChannelInput, plugins: list[Plugin] | None = None) -> 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 |
|---|---|---|---|
input
|
GetChannelInput
|
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 |
|---|---|
GetChannelOutput
|
An instance of |
Input¶
dataclass
¶
Output¶
dataclass
¶
Dataclass for GetChannelOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
channel_arn: str | None = None
The ARN of an channel returned by a GetChannel request.
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.
class-attribute
instance-attribute
¶
ingestion_status: IngestionStatus | None = None
A table showing information about the most recent successful and failed attempts to ingest events.
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.
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.
class-attribute
instance-attribute
¶
source: str | None = None
The source for the CloudTrail channel.
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.