Represents the output for DescribeStreamSummary
ContentsRepresents the current enhanced monitoring settings of the stream.
Type: Array of EnhancedMetrics objects
Required: Yes
The number of open shards in the stream.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 1000000.
Required: Yes
The current retention period, in hours.
Type: Integer
Required: Yes
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
The approximate time that the stream was created.
Type: Timestamp
Required: Yes
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
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
The number of enhanced fan-out consumers registered with the stream.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 1000000.
Required: No
The encryption type used. This value is one of the following:
Type: String
Valid Values: NONE | KMS
Required: No
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
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.
Type: StreamModeDetails object
Required: No
For more information about using this API in one of the language-specific AWS SDKs, see the following:
StreamDescription
StreamModeDetails
Did this page help you? - Yes
Thanks for letting us know we're doing a good job!
If you've got a moment, please tell us what we did right so we can do more of it.
Did this page help you? - No
Thanks for letting us know this page needs work. We're sorry we let you down.
If you've got a moment, please tell us how we can make the documentation better.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4