Values.StreamDescriptionSourceRepresents the output for DescribeStream.
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.
*)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 capacity mode and a provisioned capacity mode for your data streams.
*)shards : ShardList.t option;The shards that comprise the stream.
*)hasMoreShards : BooleanObject.t option;If set to true, more shards in the stream are available to describe.
*)retentionPeriodHours : RetentionPeriodHours.t option;The current retention period, in hours. Minimum value of 24. Maximum value of 168.
*)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 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 : 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
*)}val to_value :
t ->
[> `Structure of
(string
* [> `Boolean of BooleanObject.t
| `Enum of string
| `Integer of RetentionPeriodHours.t
| `List of
[> `Structure of
(string
* [> `List of [> `Enum of string ] list
| `String of ShardId.t
| `Structure of (string * [> `String of HashKey.t ]) list ])
list ]
list
| `String of StreamName.t
| `Structure of (string * [> `Enum of string ]) list
| `Timestamp of Timestamp.t ])
list ]