AWS Kinesis · Schema

DeliveryStreamDescription

Contains information about a delivery stream.

AnalyticsApache FlinkBig DataData ProcessingReal-TimeStreamingVideo

Properties

Name Type Description
DeliveryStreamName object
DeliveryStreamARN object
DeliveryStreamStatus object
FailureDescription object
DeliveryStreamEncryptionConfiguration object
DeliveryStreamType object
VersionId object
CreateTimestamp object
LastUpdateTimestamp object
Source object
Destinations object
HasMoreDestinations object
View JSON Schema on GitHub

JSON Schema

kinesis-deliverystreamdescription-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DeliveryStreamDescription",
  "title": "DeliveryStreamDescription",
  "type": "object",
  "required": [
    "DeliveryStreamName",
    "DeliveryStreamARN",
    "DeliveryStreamStatus",
    "DeliveryStreamType",
    "VersionId",
    "Destinations",
    "HasMoreDestinations"
  ],
  "properties": {
    "DeliveryStreamName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeliveryStreamName"
        },
        {
          "description": "The name of the delivery stream."
        }
      ]
    },
    "DeliveryStreamARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeliveryStreamARN"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the delivery stream. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a>."
        }
      ]
    },
    "DeliveryStreamStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeliveryStreamStatus"
        },
        {
          "description": "The status of the delivery stream. If the status of a delivery stream is <code>CREATING_FAILED</code>, this status doesn't change, and you can't invoke <code>CreateDeliveryStream</code> again on it. However, you can invoke the <a>DeleteDeliveryStream</a> operation to delete it."
        }
      ]
    },
    "FailureDescription": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FailureDescription"
        },
        {
          "description": "Provides details in case one of the following operations fails due to an error related to KMS: <a>CreateDeliveryStream</a>, <a>DeleteDeliveryStream</a>, <a>StartDeliveryStreamEncryption</a>, <a>StopDeliveryStreamEncryption</a>."
        }
      ]
    },
    "DeliveryStreamEncryptionConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeliveryStreamEncryptionConfiguration"
        },
        {
          "description": "Indicates the server-side encryption (SSE) status for the delivery stream."
        }
      ]
    },
    "DeliveryStreamType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeliveryStreamType"
        },
        {
          "description": "<p>The delivery stream type. This can be one of the following values:</p> <ul> <li> <p> <code>DirectPut</code>: Provider applications access the delivery stream directly.</p> </li> <li> <p> <code>KinesisStreamAsSource</code>: The delivery stream uses a Kinesis data stream as a source.</p> </li> </ul>"
        }
      ]
    },
    "VersionId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeliveryStreamVersionId"
        },
        {
          "description": "Each time the destination is updated for a delivery stream, the version ID is changed, and the current version ID is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream."
        }
      ]
    },
    "CreateTimestamp": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date and time that the delivery stream was created."
        }
      ]
    },
    "LastUpdateTimestamp": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date and time that the delivery stream was last updated."
        }
      ]
    },
    "Source": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SourceDescription"
        },
        {
          "description": "If the <code>DeliveryStreamType</code> parameter is <code>KinesisStreamAsSource</code>, a <a>SourceDescription</a> object describing the source Kinesis data stream."
        }
      ]
    },
    "Destinations": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DestinationDescriptionList"
        },
        {
          "description": "The destinations."
        }
      ]
    },
    "HasMoreDestinations": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BooleanObject"
        },
        {
          "description": "Indicates whether there are more destinations available to list."
        }
      ]
    }
  },
  "description": "Contains information about a delivery stream."
}