describe_stream¶
Operation¶
describe_stream
async
¶
describe_stream(request: DescribeStreamInput | DescribeStreamInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeStreamOutput
describe_stream(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeStreamInputDict]) -> DescribeStreamOutput
Describes the specified Kinesis data stream.
Note
This API has been revised. It's highly recommended that you use the DescribeStreamSummary API to get a summarized description of the specified Kinesis data stream and the ListShards API to list the shards in a specified data stream and obtain information about each shard.
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), creation time, enhanced metric configuration, and shard map. The shard map is an array of shard objects. For each shard object, there is the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. Every record ingested in the stream is identified by a sequence number, which is assigned when the record is put into the stream.
You can limit the number of shards returned by each call. For more information, see Retrieving Shards from a Stream in the Amazon Kinesis Data Streams Developer Guide.
There are no guarantees about the chronological order shards returned. To process shards in chronological order, use the ID of the parent shard to track the lineage to the oldest shard.
This operation has a limit of 10 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 |
|---|---|
DescribeStreamOutput
|
An instance of |
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¶
DescribeStreamInput
dataclass
¶
Bases: _SerdeShape
Represents the input for DescribeStream.
Attributes¶
exclusive_start_shard_id
class-attribute
instance-attribute
¶
exclusive_start_shard_id: str | None = ...
The shard ID of the shard to start with.
Specify this parameter to indicate that you want to describe the stream
starting with the shard whose ID immediately follows
ExclusiveStartShardId.
If you don't specify this parameter, the default behavior for
DescribeStream is to describe the stream starting with the first shard
in the stream.
limit
class-attribute
instance-attribute
¶
limit: int | None = ...
The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.
Dictionaries¶
DescribeStreamInputDict
¶
Bases: TypedDict
Dictionary form of DescribeStreamInput.
Attributes¶
exclusive_start_shard_id
instance-attribute
¶
exclusive_start_shard_id: str | None
The shard ID of the shard to start with.
Specify this parameter to indicate that you want to describe the stream
starting with the shard whose ID immediately follows
ExclusiveStartShardId.
If you don't specify this parameter, the default behavior for
DescribeStream is to describe the stream starting with the first shard
in the stream.
Output¶
DescribeStreamOutput
dataclass
¶
Bases: _SerdeShape
Represents the output for DescribeStream.
Attributes¶
response_metadata
class-attribute
instance-attribute
¶
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
instance-attribute
¶
stream_description: StreamDescription
The current status of the stream, the stream Amazon Resource Name (ARN), an array of shard objects that comprise the stream, and whether there are more shards available.