list_streams¶
Operation¶
list_streams
async
¶
list_streams(request: ListStreamsInput | ListStreamsInputDict, /, *, plugins: list[Plugin] | None = None) -> ListStreamsOutput
list_streams(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListStreamsInputDict]) -> ListStreamsOutput
Lists your Kinesis data streams.
The number of streams may be too large to return from a single call to
ListStreams. You can limit the number of returned streams using the
Limit parameter. If you do not specify a value for the Limit
parameter, Kinesis Data Streams uses the default limit, which is
currently 100.
You can detect if there are more streams available to list by using the
HasMoreStreams flag from the returned output. If there are more
streams available, you can request more streams by using the name of the
last stream returned by the ListStreams request in the
ExclusiveStartStreamName parameter in a subsequent request to
ListStreams. The group of stream names returned by the subsequent
request is then added to the list. You can continue this process until
all the stream names have been collected in the list.
ListStreams has a limit of five transactions per second per account.
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 |
|---|---|
ListStreamsOutput
|
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¶
ListStreamsInput
dataclass
¶
Bases: _SerdeShape
Represents the input for ListStreams.
Attributes¶
exclusive_start_stream_name
class-attribute
instance-attribute
¶
exclusive_start_stream_name: str | None = ...
The name of the stream to start the list with.
Dictionaries¶
ListStreamsInputDict
¶
Bases: TypedDict
Dictionary form of ListStreamsInput.
Attributes¶
exclusive_start_stream_name
instance-attribute
¶
exclusive_start_stream_name: str | None
The name of the stream to start the list with.
Output¶
ListStreamsOutput
dataclass
¶
Bases: _SerdeShape
Represents the output for ListStreams.
Attributes¶
has_more_streams
instance-attribute
¶
has_more_streams: bool
If set to true, there are more streams available to list.
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.
stream_names
instance-attribute
¶
The names of the streams that are associated with the Amazon Web
Services account making the ListStreams request.
stream_summaries
class-attribute
instance-attribute
¶
stream_summaries: list[StreamSummary] | None = ...