Amazon Kinesis

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

See also: AWS API Documentation

Request Syntax

client.list_shards(
    StreamName='string',
    NextToken='string',
    ExclusiveStartShardId='string',
    MaxResults=123,
    StreamCreationTimestamp=datetime(2015, 1, 1)
)

type StreamName:

string

param 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 NextToken:

string

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

type ExclusiveStartShardId:

string

param ExclusiveStartShardId:

The ID of the shard to start the list with.

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 MaxResults:

integer

param 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 StreamCreationTimestamp:

datetime

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

rtype:

dict

returns:

Response Syntax

{
    'Shards': [
        {
            'ShardId': 'string',
            'ParentShardId': 'string',
            'AdjacentParentShardId': 'string',
            'HashKeyRange': {
                'StartingHashKey': 'string',
                'EndingHashKey': 'string'
            },
            'SequenceNumberRange': {
                'StartingSequenceNumber': 'string',
                'EndingSequenceNumber': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

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

    • (dict) --

      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 (dict) --

        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 (dict) --

        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 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 ListShardsInput$NextToken.