Smaws_Client_Kinesis.ListShards
val request :
Smaws_Lib.Context.t ->
list_shards_input ->
(list_shards_output,
[> Smaws_Lib.Protocols.AwsJson.error
| `AccessDeniedException of access_denied_exception
| `ExpiredNextTokenException of expired_next_token_exception
| `InvalidArgumentException of invalid_argument_exception
| `LimitExceededException of limit_exceeded_exception
| `ResourceInUseException of resource_in_use_exception
| `ResourceNotFoundException of resource_not_found_exception ])
Stdlib.result
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.
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.
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.