StreamDescription

{
  "$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": "<p>The current status of the stream being described. The stream status is one of the following states:</p> <ul> <li> <p> <code>CREATING</code> - The stream is being created. Kinesis Data Streams immediately returns and sets <code>StreamStatus</code> to <code>CREATING</code>.</p> </li> <li> <p> <code>DELETING</code> - The stream is being deleted. The specified stream is in the <code>DELETING</code> state until Kinesis Data Streams completes the deletion.</p> </li> <li> <p> <code>ACTIVE</code> - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an <code>ACTIVE</code> stream.</p> </li> <li> <p> <code>UPDATING</code> - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the <code>UPDATING</code> state.</p> </li> </ul>"
        }
      ]
    },
    "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 <b>on-demand</b> capacity mode and a <b>provisioned</b> 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 <code>true</code>, 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": "<p>The server-side encryption type used on the stream. This parameter can be one of the following values:</p> <ul> <li> <p> <code>NONE</code>: Do not encrypt the records in the stream.</p> </li> <li> <p> <code>KMS</code>: Use server-side encryption on the records in the stream using a customer-managed Amazon Web Services KMS key.</p> </li> </ul>"
        }
      ]
    },
    "KeyId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/KeyId"
        },
        {
          "description": "<p>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 <code>aws/kinesis</code>.</p> <ul> <li> <p>Key ARN example: <code>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</code> </p> </li> <li> <p>Alias ARN example: <code>arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</code> </p> </li> <li> <p>Globally unique key ID example: <code>12345678-1234-1234-1234-123456789012</code> </p> </li> <li> <p>Alias name example: <code>alias/MyAliasName</code> </p> </li> <li> <p>Master key owned by Kinesis Data Streams: <code>alias/aws/kinesis</code> </p> </li> </ul>"
        }
      ]
    }
  },
  "description": "Represents the output for <a>DescribeStream</a>."
}