Skip to content

Kinesis  >  Structures  >  StreamDescription

StreamDescription

Structure Class

StreamDescription dataclass

Bases: _SerdeShape

Represents the output for DescribeStream.

Attributes

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

The server-side encryption type used on the stream. This parameter can be one of the following values:

  • NONE: Do not encrypt the records in the stream.

  • KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon Web Services KMS key.

enhanced_monitoring instance-attribute 
enhanced_monitoring: list[EnhancedMetrics]

Represents the current enhanced monitoring settings of the stream.

has_more_shards instance-attribute 
has_more_shards: bool

If set to true, more shards in the stream are available to describe.

key_id 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

retention_period_hours instance-attribute 
retention_period_hours: int

The current retention period, in hours. Minimum value of 24. Maximum value of 168.

shards instance-attribute 
shards: list[Shard]

The shards that comprise the stream.

stream_arn instance-attribute 
stream_arn: str

The Amazon Resource Name (ARN) for the stream being described.

stream_creation_timestamp instance-attribute 
stream_creation_timestamp: datetime

The approximate time that the stream was created.

stream_mode_details 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 capacity mode and a provisioned capacity mode for your data streams.

stream_name instance-attribute 
stream_name: str

The name of the stream being described.

stream_status 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 sets StreamStatus to CREATING.

  • DELETING - The stream is being deleted. The specified stream is in the DELETING state 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 an ACTIVE stream.

  • UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.