Menu
Amazon Kinesis Streams Service API Reference
API Reference (API Version 2013-12-02)

StreamDescriptionSummary

Represents the output for DescribeStreamSummary

Contents

EncryptionType

The encryption type used. This value is one of the following:

  • KMS

  • NONE

Type: String

Valid Values: NONE | KMS

Required: No

EnhancedMonitoring

Represents the current enhanced monitoring settings of the stream.

Type: Array of EnhancedMetrics objects

Required: Yes

KeyId

The GUID for the customer-managed 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 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: alias/aws/kinesis

Type: String

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

Required: No

OpenShardCount

The number of open shards in the stream.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 1000000.

Required: Yes

RetentionPeriodHours

The current retention period, in hours.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100000.

Required: Yes

StreamARN

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

Type: String

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 Streams immediately returns and sets StreamStatus to CREATING.

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: