StreamDescription

Represents the output for DescribeStream.

EnhancedMonitoring

Represents the current enhanced monitoring settings of the stream.

Type: Array of EnhancedMetrics objects

Required: Yes

HasMoreShards

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

Type: Boolean

Required: Yes

RetentionPeriodHours

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

Type: Integer

Required: Yes

Shards

The shards that comprise the stream.

Type: Array of Shard objects

Required: Yes

StreamARN

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:aws.*:kinesis:.*:\d{12}:stream/\S+

Required: Yes

StreamCreationTimestamp

The approximate time that the stream was created.

Type: Timestamp

Required: Yes

StreamName

The name of the stream being described.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9_.-]+

Required: Yes

StreamStatus

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.

Type: String

Valid Values: CREATING | DELETING | ACTIVE | UPDATING

Required: Yes

EncryptionType

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 AWS KMS key.

Type: String

Valid Values: NONE | KMS

Required: No

KeyId

The GUID for the customer-managed AWS 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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

StreamModeDetails

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.

Type: StreamModeDetails object

Required: No

StreamDescription

Contents

See Also