ListShards
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.
Important
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
Request Syntax
{
"ExclusiveStartShardId": "string
",
"MaxResults": number
,
"NextToken": "string
",
"ShardFilter": {
"ShardId": "string
",
"Timestamp": number
,
"Type": "string
"
},
"StreamARN": "string
",
"StreamCreationTimestamp": number
,
"StreamName": "string
"
}
Request Parameters
The request accepts the following data in JSON format.
- ExclusiveStartShardId
-
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
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9_.-]+
Required: No
- MaxResults
-
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 aNextToken
value that you can use in a subsequent call toListShards
to list the next set of shards.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10000.
Required: No
- NextToken
-
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 forMaxResults
that is less than the number of shards in the data stream, the response includes a pagination token namedNextToken
. You can specify thisNextToken
value in a subsequent call toListShards
to list the next set of shards.Don't specify
StreamName
orStreamCreationTimestamp
if you specifyNextToken
because the latter unambiguously identifies the stream.You can optionally specify a value for the
MaxResults
parameter when you specifyNextToken
. If you specify aMaxResults
value that is less than the number of shards that the operation returns if you don't specifyMaxResults
, the response will contain a newNextToken
value. You can use the newNextToken
value in a subsequent call to theListShards
operation.Important
Tokens expire after 300 seconds. When you obtain a value for
NextToken
in the response to a call toListShards
, you have 300 seconds to use that value. If you specify an expired token in a call toListShards
, you getExpiredNextTokenException
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1048576.
Required: No
- ShardFilter
-
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, theType
is the required property and must be specified. If you specify theAT_TRIM_HORIZON
,FROM_TRIM_HORIZON
, orAT_LATEST
types, you do not need to specify either theShardId
or theTimestamp
optional properties.If you specify the
AFTER_SHARD_ID
type, you must also provide the value for the optionalShardId
property. TheShardId
property is identical in fuctionality to theExclusiveStartShardId
parameter of theListShards
API. WhenShardId
property is specified, the response includes the shards starting with the shard whose ID immediately follows theShardId
that you provided.If you specify the
AT_TIMESTAMP
orFROM_TIMESTAMP_ID
type, you must also provide the value for the optionalTimestamp
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.Type: ShardFilter object
Required: No
- StreamARN
-
The ARN of the stream.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:aws.*:kinesis:.*:\d{12}:stream/\S+
Required: No
- 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
NextToken
parameter.Type: Timestamp
Required: No
- StreamName
-
The name of the data stream whose shards you want to list.
You cannot specify this parameter if you specify the
NextToken
parameter.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9_.-]+
Required: No
Response Syntax
{
"NextToken": "string",
"Shards": [
{
"AdjacentParentShardId": "string",
"HashKeyRange": {
"EndingHashKey": "string",
"StartingHashKey": "string"
},
"ParentShardId": "string",
"SequenceNumberRange": {
"EndingSequenceNumber": "string",
"StartingSequenceNumber": "string"
},
"ShardId": "string"
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- NextToken
-
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 forMaxResults
that is less than the number of shards in the data stream, the response includes a pagination token namedNextToken
. You can specify thisNextToken
value in a subsequent call toListShards
to list the next set of shards. For more information about the use of this pagination token when calling theListShards
operation, see ListShards:NextToken.Important
Tokens expire after 300 seconds. When you obtain a value for
NextToken
in the response to a call toListShards
, you have 300 seconds to use that value. If you specify an expired token in a call toListShards
, you getExpiredNextTokenException
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1048576.
- Shards
-
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.
Type: Array of Shard objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Specifies that you do not have the permissions required to perform this operation.
HTTP Status Code: 400
- ExpiredNextTokenException
-
The pagination token passed to the operation is expired.
HTTP Status Code: 400
- InvalidArgumentException
-
A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
HTTP Status Code: 400
- LimitExceededException
-
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
HTTP Status Code: 400
- ResourceInUseException
-
The resource is not available for this operation. For successful operation, the resource must be in the
ACTIVE
state.HTTP Status Code: 400
- ResourceNotFoundException
-
The requested resource could not be found. The stream might not be specified correctly.
HTTP Status Code: 400
Examples
To list the shards of a stream
The following JSON example lists three of the shards of the stream that is
specified using StreamName
. If the stream has more than three
shards, the response includes a pagination token named NextToken
.
You can use NextToken
in your input to a subsequent call to
ListShards
to get a listing of the next set of shards. When
there are no more shards to be listed, the response doesn't contain
NextToken
.
Sample Request
POST / HTTP/1.1
Host: kinesis.<region>.<domain>
Content-Length: <PayloadSizeBytes>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Authorization: <AuthParams>
Connection: Keep-Alive
X-Amz-Date: <Date>
X-Amz-Target: Kinesis_20131202.ListShards
{
"StreamName": "exampleStreamName",
"MaxResults": 3
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
"NextToken": "AAAAAAAAAAGK9EEG0sJqVhCUS2JsgigQ5dcpB4q9PYswrH2oK44Skbjtm+WR0xA7/hrAFFsohevH1/OyPnbzKBS1byPyCZuVcokYtQe/b1m4c0SCI7jctPT0oUTLRdwSRirKm9dp9YC/EL+kZHOvYAUnztVGsOAPEFC3ECf/bVC927bDZBbRRzy/44OHfWmrCLcbcWqehRh5D14WnL3yLsumhiHDkyuxSlkBepauvMnNLtTOlRtmQ5Q5reoujfq2gzeCSOtLcfXgBMztJqohPdgMzjTQSbwB9Am8rMpHLsDbSdMNXmITvw==",
"Shards": [
{
"ShardId": "shardId-000000000001",
"HashKeyRange": {
"EndingHashKey": "68056473384187692692674921486353642280",
"StartingHashKey": "34028236692093846346337460743176821145"
},
"SequenceNumberRange": {
"StartingSequenceNumber": "49579844037727333356165064238440708846556371693205002258"
}
},
{
"ShardId": "shardId-000000000002",
"HashKeyRange": {
"EndingHashKey": "102084710076281539039012382229530463436",
"StartingHashKey": "68056473384187692692674921486353642281"
},
"SequenceNumberRange": {
"StartingSequenceNumber": "49579844037749634101363594861582244564829020124710982690"
}
},
{
"ShardId": "shardId-000000000003",
"HashKeyRange": {
"EndingHashKey": "136112946768375385385349842972707284581",
"StartingHashKey": "102084710076281539039012382229530463437"
},
"SequenceNumberRange": {
"StartingSequenceNumber": "49579844037771934846562125484723780283101668556216963122"
}
}
]
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: