list_channels¶
Operation¶
async
¶
list_channels(input: ListChannelsInput, plugins: list[Plugin] | None = None) -> ListChannelsOutput
Lists the channels in the current account, and their source names.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListChannelsInput
|
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 |
|---|---|
ListChannelsOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for ListChannelsInput structure.
Attributes¶
class-attribute
instance-attribute
¶
max_results: int | None = None
The maximum number of CloudTrail channels to display on a single page.
class-attribute
instance-attribute
¶
next_token: str | None = 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¶
dataclass
¶
Dataclass for ListChannelsOutput structure.