Skip to content

Kinesis  >  Operations  >  describe_stream_summary

describe_stream_summary

Operation

describe_stream_summary async

describe_stream_summary(request: DescribeStreamSummaryInput | DescribeStreamSummaryInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeStreamSummaryOutput
describe_stream_summary(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeStreamSummaryInputDict]) -> DescribeStreamSummaryOutput

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

Note

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.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeStreamSummaryOutput

An instance of DescribeStreamSummaryOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribeStreamSummaryInput dataclass

Bases: _SerdeShape

Dataclass for DescribeStreamSummaryInput structure.

Attributes
stream_arn class-attribute instance-attribute
stream_arn: str | None = ...

The ARN of the stream.

stream_id class-attribute instance-attribute
stream_id: str | None = ...

Not Implemented. Reserved for future use.

stream_name class-attribute instance-attribute
stream_name: str | None = ...

The name of the stream to describe.

Dictionaries

DescribeStreamSummaryInputDict

Bases: TypedDict

Dictionary form of DescribeStreamSummaryInput.

Attributes
stream_arn instance-attribute
stream_arn: str | None

The ARN of the stream.

stream_id instance-attribute
stream_id: str | None

Not Implemented. Reserved for future use.

stream_name instance-attribute
stream_name: str | None

The name of the stream to describe.

Output

DescribeStreamSummaryOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeStreamSummaryOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

stream_description_summary instance-attribute
stream_description_summary: StreamDescriptionSummary

A StreamDescriptionSummary containing information about the stream.