AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the ListShards operation.
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.
Namespace: Amazon.Kinesis.Model
Assembly: AWSSDK.Kinesis.dll
Version: 3.x.y.z
public class ListShardsRequest : AmazonKinesisRequest IAmazonWebServiceRequest
The ListShardsRequest type exposes the following members
Name | Description | |
---|---|---|
ListShardsRequest() |
Name | Type | Description | |
---|---|---|---|
ExclusiveStartShardId | System.String |
Gets and sets the property ExclusiveStartShardId.
Specify this parameter to indicate that you want to list the shards starting with
the shard whose ID immediately follows
If you don't specify this parameter, the default behavior is for
You cannot specify this parameter if you specify |
|
MaxResults | System.Int32 |
Gets and sets the property MaxResults.
The maximum number of shards to return in a single call to
When the number of shards to be listed is greater than the value of |
|
NextToken | System.String |
Gets and sets the property NextToken.
When the number of shards in the data stream is greater than the default value for
the
Don't specify
You can optionally specify a value for the
Tokens expire after 300 seconds. When you obtain a value for |
|
ShardFilter | Amazon.Kinesis.Model.ShardFilter |
Gets and sets the property ShardFilter.
Enables you to filter out the response of the
If you use the
If you specify the
If you specify the |
|
StreamARN | System.String |
Gets and sets the property StreamARN. The ARN of the stream. |
|
StreamCreationTimestamp | System.DateTime |
Gets and sets the property StreamCreationTimestamp. 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 |
|
StreamName | System.String |
Gets and sets the property StreamName. The name of the data stream whose shards you want to list.
You cannot specify this parameter if you specify the |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5