{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/StreamDescription", "title": "StreamDescription", "type": "object", "required": [ "StreamName", "StreamARN", "StreamStatus", "Shards", "HasMoreShards", "RetentionPeriodHours", "StreamCreationTimestamp", "EnhancedMonitoring" ], "properties": { "StreamName": { "allOf": [ { "$ref": "#/components/schemas/StreamName" }, { "description": "The name of the stream being described." } ] }, "StreamARN": { "allOf": [ { "$ref": "#/components/schemas/StreamARN" }, { "description": "The Amazon Resource Name (ARN) for the stream being described." } ] }, "StreamStatus": { "allOf": [ { "$ref": "#/components/schemas/StreamStatus" }, { "description": "

The current status of the stream being described. The stream status is one of the following states:

" } ] }, "StreamModeDetails": { "allOf": [ { "$ref": "#/components/schemas/StreamModeDetails" }, { "description": " 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": { "allOf": [ { "$ref": "#/components/schemas/ShardList" }, { "description": "The shards that comprise the stream." } ] }, "HasMoreShards": { "allOf": [ { "$ref": "#/components/schemas/BooleanObject" }, { "description": "If set to true, more shards in the stream are available to describe." } ] }, "RetentionPeriodHours": { "allOf": [ { "$ref": "#/components/schemas/RetentionPeriodHours" }, { "description": "The current retention period, in hours. Minimum value of 24. Maximum value of 168." } ] }, "StreamCreationTimestamp": { "allOf": [ { "$ref": "#/components/schemas/Timestamp" }, { "description": "The approximate time that the stream was created." } ] }, "EnhancedMonitoring": { "allOf": [ { "$ref": "#/components/schemas/EnhancedMonitoringList" }, { "description": "Represents the current enhanced monitoring settings of the stream." } ] }, "EncryptionType": { "allOf": [ { "$ref": "#/components/schemas/EncryptionType" }, { "description": "

The server-side encryption type used on the stream. This parameter can be one of the following values:

" } ] }, "KeyId": { "allOf": [ { "$ref": "#/components/schemas/KeyId" }, { "description": "

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.

" } ] } }, "description": "Represents the output for DescribeStream." }