Skip to content

/AWS1/CL_KNS=>DESCRIBESTREAMSUMMARY()

About DescribeStreamSummary

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

When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.

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.

Method Signature

IMPORTING

Optional arguments:

IV_STREAMNAME TYPE /AWS1/KNSSTREAMNAME /AWS1/KNSSTREAMNAME

The name of the stream to describe.

IV_STREAMARN TYPE /AWS1/KNSSTREAMARN /AWS1/KNSSTREAMARN

The ARN of the stream.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_KNSDESCRSTREAMSUMMOUT /AWS1/CL_KNSDESCRSTREAMSUMMOUT