v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1428127159.3 KB

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

When invoking this API, it is recommended you use the StreamARN input parameter rather than the StreamName input parameter.

The information returned includes the stream name, Amazon Resource Name (ARN), status, record retention period, approximate creation time, monitoring, encryption details, and open shard count.

DescribeStreamSummary has a limit of 20 transactions per second per account.

post/#X-Amz-Target=Kinesis_20131202.DescribeStreamSummary

Headers

X-Amz-Target'Kinesis_20131202.DescribeStreamSummary' required

Request body

StreamNamestring

The name of the stream to describe.

StreamARNstring

The ARN of the stream.

Response

Success