Values.StreamDescriptionSummarySourceRepresents the output for DescribeStreamSummary
type nonrec t = {streamName : StreamName.t option;The name of the stream being described.
*)streamARN : StreamARN.t option;The Amazon Resource Name (ARN) for the stream being described.
*)streamId : StreamId.t option;Not Implemented. Reserved for future use.
*)streamStatus : StreamStatus.t option;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 : StreamModeDetails.t option;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.
*)retentionPeriodHours : RetentionPeriodHours.t option;The current retention period, in hours.
*)streamCreationTimestamp : Timestamp.t option;The approximate time that the stream was created.
*)enhancedMonitoring : EnhancedMonitoringList.t option;Represents the current enhanced monitoring settings of the stream.
*)encryptionType : EncryptionType.t option;The encryption type used. This value is one of the following: KMS NONE
*)keyId : KeyId.t option;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
*)openShardCount : ShardCountObject.t option;The number of open shards in the stream.
*)consumerCount : ConsumerCountObject.t option;The number of enhanced fan-out consumers registered with the stream.
*)warmThroughput : WarmThroughputObject.t option;The warm throughput in MB/s for the stream. This represents the throughput capacity that will be immediately available for write operations.
*)maxRecordSizeInKiB : MaxRecordSizeInKiB.t option;The maximum record size of a single record in kibibyte (KiB) that you can write to, and read from a stream.
*)}val make :
?streamName:??? ->
?streamARN:??? ->
?streamId:??? ->
?streamStatus:??? ->
?streamModeDetails:??? ->
?retentionPeriodHours:??? ->
?streamCreationTimestamp:??? ->
?enhancedMonitoring:??? ->
?encryptionType:??? ->
?keyId:??? ->
?openShardCount:??? ->
?consumerCount:??? ->
?warmThroughput:??? ->
?maxRecordSizeInKiB:??? ->
unit ->
tval to_value :
t ->
[> `Structure of
(string
* [> `Enum of string
| `Integer of RetentionPeriodHours.t
| `List of
[> `Structure of
(string * [> `List of [> `Enum of string ] list ]) list ]
list
| `String of StreamName.t
| `Structure of
(string * [> `Enum of string | `Integer of NaturalIntegerObject.t ])
list
| `Timestamp of Timestamp.t ])
list ]