list_shards¶
Operation¶
list_shards
async
¶
list_shards(request: ListShardsInput | ListShardsInputDict, /, *, plugins: list[Plugin] | None = None) -> ListShardsOutput
list_shards(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListShardsInputDict]) -> ListShardsOutput
Lists the shards in a stream and provides information about each shard. This operation has a limit of 1000 transactions per second per data stream.
Note
When invoking this API, you must use either the StreamARN or the
StreamName parameter, or both. It is recommended that you use the
StreamARN input parameter when you invoke this API.
This action does not list expired shards. For information about expired shards, see Data Routing, Data Persistence, and Shard State after a Reshard.
Warning
This API is a new operation that is used by the Amazon Kinesis Client Library (KCL). If you have a fine-grained IAM policy that only allows specific operations, you must update your policy to allow calls to this API. For more information, see Controlling Access to Amazon Kinesis Data Streams Resources Using IAM.
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 |
|---|---|
ListShardsOutput
|
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¶
ListShardsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListShardsInput structure.
Attributes¶
exclusive_start_shard_id
class-attribute
instance-attribute
¶
exclusive_start_shard_id: str | None = ...
Specify this parameter to indicate that you want to list the shards
starting with the shard whose ID immediately follows
ExclusiveStartShardId.
If you don't specify this parameter, the default behavior is for
ListShards to list the shards starting with the first one in the
stream.
You cannot specify this parameter if you specify NextToken.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of shards to return in a single call to ListShards.
The maximum number of shards to return in a single call. The default
value is 1000. If you specify a value greater than 1000, at most 1000
results are returned.
When the number of shards to be listed is greater than the value of
MaxResults, the response contains a NextToken value that you can use
in a subsequent call to ListShards to list the next set of shards.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
When the number of shards in the data stream is greater than the default
value for the MaxResults parameter, or if you explicitly specify a
value for MaxResults that is less than the number of shards in the
data stream, the response includes a pagination token named NextToken.
You can specify this NextToken value in a subsequent call to
ListShards to list the next set of shards.
Don't specify StreamName or StreamCreationTimestamp if you specify
NextToken because the latter unambiguously identifies the stream.
You can optionally specify a value for the MaxResults parameter when
you specify NextToken. If you specify a MaxResults value that is
less than the number of shards that the operation returns if you don't
specify MaxResults, the response will contain a new NextToken value.
You can use the new NextToken value in a subsequent call to the
ListShards operation.
Warning
Tokens expire after 300 seconds. When you obtain a value for NextToken
in the response to a call to ListShards, you have 300 seconds to use
that value. If you specify an expired token in a call to ListShards,
you get ExpiredNextTokenException.
shard_filter
class-attribute
instance-attribute
¶
shard_filter: ShardFilter | None = ...
Enables you to filter out the response of the ListShards API. You can
only specify one filter at a time.
If you use the ShardFilter parameter when invoking the ListShards API,
the Type is the required property and must be specified. If you
specify the AT_TRIM_HORIZON, FROM_TRIM_HORIZON, or AT_LATEST
types, you do not need to specify either the ShardId or the
Timestamp optional properties.
If you specify the AFTER_SHARD_ID type, you must also provide the
value for the optional ShardId property. The ShardId property is
identical in fuctionality to the ExclusiveStartShardId parameter of
the ListShards API. When ShardId property is specified, the response
includes the shards starting with the shard whose ID immediately follows
the ShardId that you provided.
If you specify the AT_TIMESTAMP or FROM_TIMESTAMP_ID type, you must
also provide the value for the optional Timestamp property. If you
specify the AT_TIMESTAMP type, then all shards that were open at the
provided timestamp are returned. If you specify the FROM_TIMESTAMP type,
then all shards starting from the provided timestamp to TIP are
returned.
stream_creation_timestamp
class-attribute
instance-attribute
¶
stream_creation_timestamp: datetime | None = ...
Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the shards for.
You cannot specify this parameter if you specify the NextToken
parameter.
Dictionaries¶
ListShardsInputDict
¶
Bases: TypedDict
Dictionary form of ListShardsInput.
Attributes¶
exclusive_start_shard_id
instance-attribute
¶
exclusive_start_shard_id: str | None
Specify this parameter to indicate that you want to list the shards
starting with the shard whose ID immediately follows
ExclusiveStartShardId.
If you don't specify this parameter, the default behavior is for
ListShards to list the shards starting with the first one in the
stream.
You cannot specify this parameter if you specify NextToken.
max_results
instance-attribute
¶
max_results: int | None
The maximum number of shards to return in a single call to ListShards.
The maximum number of shards to return in a single call. The default
value is 1000. If you specify a value greater than 1000, at most 1000
results are returned.
When the number of shards to be listed is greater than the value of
MaxResults, the response contains a NextToken value that you can use
in a subsequent call to ListShards to list the next set of shards.
next_token
instance-attribute
¶
next_token: str | None
When the number of shards in the data stream is greater than the default
value for the MaxResults parameter, or if you explicitly specify a
value for MaxResults that is less than the number of shards in the
data stream, the response includes a pagination token named NextToken.
You can specify this NextToken value in a subsequent call to
ListShards to list the next set of shards.
Don't specify StreamName or StreamCreationTimestamp if you specify
NextToken because the latter unambiguously identifies the stream.
You can optionally specify a value for the MaxResults parameter when
you specify NextToken. If you specify a MaxResults value that is
less than the number of shards that the operation returns if you don't
specify MaxResults, the response will contain a new NextToken value.
You can use the new NextToken value in a subsequent call to the
ListShards operation.
Warning
Tokens expire after 300 seconds. When you obtain a value for NextToken
in the response to a call to ListShards, you have 300 seconds to use
that value. If you specify an expired token in a call to ListShards,
you get ExpiredNextTokenException.
shard_filter
instance-attribute
¶
shard_filter: ShardFilter | ShardFilterDict | None
Enables you to filter out the response of the ListShards API. You can
only specify one filter at a time.
If you use the ShardFilter parameter when invoking the ListShards API,
the Type is the required property and must be specified. If you
specify the AT_TRIM_HORIZON, FROM_TRIM_HORIZON, or AT_LATEST
types, you do not need to specify either the ShardId or the
Timestamp optional properties.
If you specify the AFTER_SHARD_ID type, you must also provide the
value for the optional ShardId property. The ShardId property is
identical in fuctionality to the ExclusiveStartShardId parameter of
the ListShards API. When ShardId property is specified, the response
includes the shards starting with the shard whose ID immediately follows
the ShardId that you provided.
If you specify the AT_TIMESTAMP or FROM_TIMESTAMP_ID type, you must
also provide the value for the optional Timestamp property. If you
specify the AT_TIMESTAMP type, then all shards that were open at the
provided timestamp are returned. If you specify the FROM_TIMESTAMP type,
then all shards starting from the provided timestamp to TIP are
returned.
stream_creation_timestamp
instance-attribute
¶
stream_creation_timestamp: datetime | None
Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the shards for.
You cannot specify this parameter if you specify the NextToken
parameter.
Output¶
ListShardsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListShardsOutput structure.
Attributes¶
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
When the number of shards in the data stream is greater than the default
value for the MaxResults parameter, or if you explicitly specify a
value for MaxResults that is less than the number of shards in the
data stream, the response includes a pagination token named NextToken.
You can specify this NextToken value in a subsequent call to
ListShards to list the next set of shards. For more information about
the use of this pagination token when calling the ListShards
operation, see ListShardsInput$NextToken.
Warning
Tokens expire after 300 seconds. When you obtain a value for NextToken
in the response to a call to ListShards, you have 300 seconds to use
that value. If you specify an expired token in a call to ListShards,
you get ExpiredNextTokenException.
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.
shards
class-attribute
instance-attribute
¶
An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard.