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.
StreamName [required]
string
The name of the stream being described.
StreamARN [required]
string
The Amazon Resource Name (ARN) for the stream being described.
StreamStatus [required]
string
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.
StreamModeDetails
object
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.
StreamMode [required]
string
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.
Shards [required]
[object]
The shards that comprise the stream.
ShardId [required]
string
The unique identifier of the shard within the stream.
ParentShardId
string
The shard ID of the shard's parent.
AdjacentParentShardId
string
The shard ID of the shard adjacent to the shard's parent.
HashKeyRange [required]
object
The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
StartingHashKey [required]
string
The starting hash key of the hash key range.
EndingHashKey [required]
string
The ending hash key of the hash key range.
SequenceNumberRange [required]
object
The range of possible sequence numbers for the shard.
StartingSequenceNumber [required]
string
The starting sequence number for the range.
EndingSequenceNumber
string
The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of null.
HasMoreShards [required]
boolean
If set to true, more shards in the stream are available to describe.
RetentionPeriodHours [required]
number
The current retention period, in hours. Minimum value of 24. Maximum value of 168.
StreamCreationTimestamp [required]
date-time
The approximate time that the stream was created.
EnhancedMonitoring [required]
[object]
Represents the current enhanced monitoring settings of the stream.
ShardLevelMetrics
[string]
List of shard-level metrics. The following are the valid shard-level metrics. The value "ALL" enhances every metric. IncomingBytes IncomingRecords OutgoingBytes OutgoingRecords WriteProvisionedThroughputExceeded ReadProvisionedThroughputExceeded IteratorAgeMilliseconds ALL For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.
EncryptionType
string
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.
KeyId
string
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