StreamDescriptionSummary¶
Structure Class¶
dataclass
¶
Bases: _SerdeShape
Represents the output for DescribeStreamSummary
Attributes¶
class-attribute
instance-attribute
¶
channel_count: int | None = ...
The number of channels associated with the stream.
class-attribute
instance-attribute
¶
consumer_count: int | None = ...
The number of enhanced fan-out consumers registered with the stream.
class-attribute
instance-attribute
¶
encryption_type: str | None = ...
The encryption type used. This value is one of the following:
-
KMS -
NONE
instance-attribute
¶
enhanced_monitoring: list[EnhancedMetrics]
Represents the current enhanced monitoring settings of the stream.
class-attribute
instance-attribute
¶
key_id: str | None = ...
The GUID for the customer-managed Amazon Web Services KMS key to use for
encryption. This value can be a globally unique identifier, a fully
specified ARN to either an alias or a key, or an alias name prefixed by
"alias/".You can also use a master key owned by Kinesis Data Streams
by specifying the alias aws/kinesis.
-
Key ARN example:
arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 -
Alias ARN example:
arn:aws:kms:us-east-1:123456789012:alias/MyAliasName -
Globally unique key ID example:
12345678-1234-1234-1234-123456789012 -
Alias name example:
alias/MyAliasName -
Master key owned by Kinesis Data Streams:
alias/aws/kinesis
class-attribute
instance-attribute
¶
max_record_size_in_ki_b: int | None = ...
The maximum record size of a single record in kibibyte (KiB) that you can write to, and read from a stream.
instance-attribute
¶
open_shard_count: int
The number of open shards in the stream.
class-attribute
instance-attribute
¶
record_distribution_strategy: str | None = ...
The record distribution strategy that the stream currently uses. A value
of AUTO indicates that Amazon Kinesis Data Streams distributes records
across shards using service-managed algorithms. A value of
USER_PARTITION_KEY indicates that shard placement is determined by the
partition key that producers supply. This field is only present for
streams that use the on-demand capacity mode.
instance-attribute
¶
retention_period_hours: int
The current retention period, in hours.
instance-attribute
¶
stream_arn: str
The Amazon Resource Name (ARN) for the stream being described.
instance-attribute
¶
stream_creation_timestamp: datetime
The approximate time that the stream was created.
class-attribute
instance-attribute
¶
stream_id: str | None = ...
Not Implemented. Reserved for future use.
class-attribute
instance-attribute
¶
stream_mode_details: StreamModeDetails | None = ...
Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand ycapacity mode and a provisioned capacity mode for your data streams.
instance-attribute
¶
stream_status: str
The current status of the stream being described. The stream status is one of the following states:
-
CREATING- The stream is being created. Kinesis Data Streams immediately returns and setsStreamStatustoCREATING. -
DELETING- The stream is being deleted. The specified stream is in theDELETINGstate until Kinesis Data Streams completes the deletion. -
ACTIVE- The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on anACTIVEstream. -
UPDATING- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATINGstate.
class-attribute
instance-attribute
¶
warm_throughput: WarmThroughputObject | None = ...
The warm throughput in MB/s for the stream. This represents the throughput capacity that will be immediately available for write operations.