Menu
Amazon Kinesis Data Streams Service API Reference
API Reference (API Version 2013-12-02)

ListShards

Lists the shards in a stream and provides information about each shard. This operation has a limit of 100 transactions per second per data stream.

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", "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 minimum value you can specify for this parameter is 1, and the maximum is 1,000, which is also the default.

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.

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 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.

Important

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1048576.

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 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 ListShards:NextToken.

Important

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.

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.

ExpiredNextTokenException

The pagination token passed to the ListShards operation is expired. For more information, see ListShards:NextToken.

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

Example

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 AWS SDKs, see the following: