list_channels¶
Operation¶
list_channels
¶
list_channels(request: ListChannelsInput | ListChannelsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListChannelsInputDict]) -> ListChannelsOutput
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.
Lists the channels in the current account, and their source names.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListChannelsInput | ListChannelsInputDict | 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[ListChannelsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListChannelsOutput
|
An instance of |
list_channels
async
¶
list_channels(request: ListChannelsInput | ListChannelsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListChannelsInputDict]) -> ListChannelsOutput
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.
Lists the channels in the current account, and their source names.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListChannelsInput | ListChannelsInputDict | 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[ListChannelsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListChannelsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListChannelsInputDict
¶
Bases: TypedDict
Dictionary form of ListChannelsInput.
Attributes¶
max_results
instance-attribute
¶
max_results: int | None
The maximum number of CloudTrail channels to display on a single page.
next_token
instance-attribute
¶
next_token: str | None
The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.
ListChannelsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListChannelsInput structure.
Attributes¶
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of CloudTrail channels to display on a single page.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.
Output¶
ListChannelsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListChannelsOutput structure.
Attributes¶
channels
class-attribute
instance-attribute
¶
The list of channels in the account.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to use to get the next page of results after a previous API call.
response_metadata
class-attribute
instance-attribute
¶
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.