aws kinesis describe-stream-summary

Provides a summarized description of the specified Kinesis data stream without the shard list. AWS CLI reference

1 example 3 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To describe a data stream summary

The following describe-stream-summary example provides a summarized description (without the shard list) of the specified data stream.

aws kinesis describe-stream-summary --stream-name samplestreamIdentify

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

Its output

{
    "StreamDescriptionSummary": {
        "StreamName": "samplestream",
        "StreamARN": "arn:aws:kinesis:us-west-2:123456789012:stream/samplestream",
        "StreamStatus": "ACTIVE",
        "RetentionPeriodHours": 48,
        "StreamCreationTimestamp": 1572297168.0,
        "EnhancedMonitoring": [
            {
                "ShardLevelMetrics": []
            }
        ],
        "EncryptionType": "NONE",
        "OpenShardCount": 3,
        "ConsumerCount": 0
    }
}

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

Options

3 in the AWS CLI reference

--stream-arnThe ARN of the stream.

--stream-idNot Implemented.

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