Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . kinesis ]

list-shards

Description

Lists the shards in a stream and provides information about each shard.

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 .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-shards
[--stream-name <value>]
[--next-token <value>]
[--exclusive-start-shard-id <value>]
[--max-results <value>]
[--stream-creation-timestamp <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--stream-name (string)

The name of the data stream whose shards you want to list.

You cannot specify this parameter if you specify the next-token parameter.

--next-token (string)

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 next-token . You can specify this next-token value in a subsequent call to list-shards to list the next set of shards.

Don't specify stream-name or StreamCreationTimestamp if you specify next-token because the latter unambiguously identifies the stream.

You can optionally specify a value for the MaxResults parameter when you specify next-token . 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 next-token value. You can use the new next-token value in a subsequent call to the list-shards operation.

Warning

Tokens expire after 300 seconds. When you obtain a value for next-token in the response to a call to list-shards , you have 300 seconds to use that value. If you specify an expired token in a call to list-shards , you get ExpiredNextTokenException .

--exclusive-start-shard-id (string)

The ID of the shard to start the list with.

If you don't specify this parameter, the default behavior is for list-shards to list the shards starting with the first one in the stream.

You cannot specify this parameter if you specify next-token .

--max-results (integer)

The maximum number of shards to return in a single call to list-shards . 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 next-token value that you can use in a subsequent call to list-shards to list the next set of shards.

--stream-creation-timestamp (timestamp)

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 next-token parameter.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Shards -> (list)

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.

(structure)

A uniquely identified group of data records in a Kinesis data stream.

ShardId -> (string)

The unique identifier of the shard within the stream.

ParentShardId -> (string)

The shard ID of the shard's parent.

AdjacentParentShardId -> (string)

The shard ID of the shard adjacent to the shard's parent.

HashKeyRange -> (structure)

The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.

StartingHashKey -> (string)

The starting hash key of the hash key range.

EndingHashKey -> (string)

The ending hash key of the hash key range.

SequenceNumberRange -> (structure)

The range of possible sequence numbers for the shard.

StartingSequenceNumber -> (string)

The starting sequence number for the range.

EndingSequenceNumber -> (string)

The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of null .

NextToken -> (string)

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 next-token . You can specify this next-token value in a subsequent call to list-shards to list the next set of shards. For more information about the use of this pagination token when calling the list-shards operation, see ListShardsInput$NextToken .

Warning

Tokens expire after 300 seconds. When you obtain a value for next-token in the response to a call to list-shards , you have 300 seconds to use that value. If you specify an expired token in a call to list-shards , you get ExpiredNextTokenException .