CmdID / aws / aws kinesis

aws kinesis describe-stream

Describes the specified Kinesis data stream. AWS CLI reference

1 example 5 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To describe a data stream

The following describe-stream example returns the details of the specified data stream.

aws kinesis describe-stream --stream-name samplestreamIdentify

--stream-nameThe name of the stream to describe.

Its output, shortened

{
    "StreamDescription": {
        "Shards": [
            {
                "ShardId": "shardId-000000000000",
                "HashKeyRange": {
                    "StartingHashKey": "0",
                    "EndingHashKey": "113427455640312821154458202477256070484"
                },
                "SequenceNumberRange": {
                    "StartingSequenceNumber": "49600871682957036442365024926191073437251060580128653314"
                }
            },
            {
                "ShardId": "shardId-000000000001",
                "HashKeyRange": {
                    "StartingHashKey": "113427455640312821154458202477256070485",
                    "EndingHashKey": "226854911280625642308916404954512140969"
                },
                "SequenceNumberRange": {
                    "StartingSequenceNumber": "49600871682979337187563555549332609155523708941634633746"
                }
            },
            {
                "ShardId": "shardId-000000000002",
                "HashKeyRange": {
                    "StartingHashKey": "226854911280625642308916404954512140970",
                    "EndingHashKey": "340282366920938463463374607431768211455"
                },
                "SequenceNumberRange": {
… 18 more lines

For more information, see Creating and Managing Streams in the Amazon Kinesis Data Streams Developer Guide.

Options

5 in the AWS CLI reference

--exclusive-start-shard-idThe shard ID of the shard to start with.

--limitThe maximum number of shards to return in a single call.

--stream-arnThe ARN of the stream.

--stream-idNot Implemented.

--stream-nameThe name of the stream to describe.