list_channels¶
Operation¶
list_channels
async
¶
list_channels(request: ListChannelsInput | ListChannelsInputDict, /, *, plugins: list[Plugin] | None = None) -> ListChannelsOutput
list_channels(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListChannelsInputDict]) -> ListChannelsOutput
Lists the channels in your account. You can filter the results by source
stream. The results are paginated. Use the NextToken value returned in
the response to retrieve additional results.
Use this operation to find channels before deleting a stream, or to audit the channels configured in an Amazon Web Services Region.
This operation has a call limit of 5 transactions per second (TPS) for
each Amazon Web Services account. Exceeding 5 TPS results in a
LimitExceededException.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
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¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
ListChannelsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListChannelsInput structure.
Attributes¶
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of channels to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The pagination token returned by a previous call. Specify this token to retrieve the next page of results.
stream_filter
class-attribute
instance-attribute
¶
stream_filter: list[StreamFilter] | None = ...
Filters the results to channels associated with the specified streams.
Dictionaries¶
ListChannelsInputDict
¶
Bases: TypedDict
Dictionary form of ListChannelsInput.
Attributes¶
max_results
instance-attribute
¶
max_results: int | None
The maximum number of channels to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.
next_token
instance-attribute
¶
next_token: str | None
The pagination token returned by a previous call. Specify this token to retrieve the next page of results.
stream_filter
instance-attribute
¶
stream_filter: Sequence[StreamFilter | StreamFilterDict] | None
Filters the results to channels associated with the specified streams.
Output¶
ListChannelsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListChannelsOutput structure.
Attributes¶
channel_summaries
instance-attribute
¶
channel_summaries: list[ChannelSummary]
A list of channel summaries.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The pagination token to use in a subsequent call to retrieve the next
page of results. This value is null when there are no more results to
return.
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.