AWS Kinesis #X Amz Target=Firehose 20150804.DescribeDeliveryStream API

openapi: 3.2.0
info:
  version: 2015-08-04
  x-release: v4
  title: 'Amazon Kinesis Firehose #X Amz Target=Firehose 20150804.DescribeDeliveryStream API'
  description: <fullname>Amazon Kinesis Data Firehose API Reference</fullname> <p>Amazon Kinesis Data Firehose is a fully managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon OpenSearch Service, Amazon Redshift, Splunk, and various other supportd destinations.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: firehose
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/firehose-2015-08-04.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://firehose.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Firehose multi-region endpoint
- url: https://firehose.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Firehose multi-region endpoint
- url: http://firehose.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Firehose endpoint for China (Beijing) and China (Ningxia)
- url: https://firehose.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Firehose endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=Firehose 20150804.DescribeDeliveryStream'
paths:
  /#X-Amz-Target=Firehose_20150804.DescribeDeliveryStream:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: DescribeDeliveryStream
      description: <p>Describes the specified delivery stream and its status. For example, after your delivery stream is created, call <code>DescribeDeliveryStream</code> to see whether the delivery stream is <code>ACTIVE</code> and therefore ready for data to be sent to it. </p> <p>If the status of a delivery stream is <code>CREATING_FAILED</code>, this status doesn't change, and you can't invoke <a>CreateDeliveryStream</a> again on it. However, you can invoke the <a>DeleteDeliveryStream</a> operation to delete it. If the status is <code>DELETING_FAILED</code>, you can force deletion by invoking <a>DeleteDeliveryStream</a> again but with <a>DeleteDeliveryStreamInput$AllowForceDelete</a> set to true.</p>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeDeliveryStreamOutput'
        '480':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeDeliveryStreamInput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Firehose_20150804.DescribeDeliveryStream
      tags:
      - '#X Amz Target=Firehose 20150804.DescribeDeliveryStream'
components:
  schemas:
    HttpEndpointAttributeName:
      type: string
      pattern: ^(?!\s*$).+
      minLength: 1
      maxLength: 256
      format: password
    AmazonopensearchserviceBufferingIntervalInSeconds:
      type: integer
      minimum: 60
      maximum: 900
    ProcessorParameter:
      type: object
      required:
      - ParameterName
      - ParameterValue
      properties:
        ParameterName:
          allOf:
          - $ref: '#/components/schemas/ProcessorParameterName'
          - description: 'The name of the parameter. Currently the following default values are supported: 3 for <code>NumberOfRetries</code> and 60 for the <code>BufferIntervalInSeconds</code>. The <code>BufferSizeInMBs</code> ranges between 0.2 MB and up to 3MB. The default buffering hint is 1MB for all destinations, except Splunk. For Splunk, the default buffering hint is 256 KB. '
        ParameterValue:
          allOf:
          - $ref: '#/components/schemas/ProcessorParameterValue'
          - description: The parameter value.
      description: 'Describes the processor parameter. '
    HECEndpoint:
      type: string
      pattern: .*
      minLength: 0
      maxLength: 2048
    ListOfNonEmptyStringsWithoutWhitespace:
      type: array
      items:
        $ref: '#/components/schemas/NonEmptyStringWithoutWhitespace'
    DescribeDeliveryStreamInput:
      type: object
      required:
      - DeliveryStreamName
      title: DescribeDeliveryStreamInput
      properties:
        DeliveryStreamName:
          allOf:
          - $ref: '#/components/schemas/DeliveryStreamName'
          - description: The name of the delivery stream.
        Limit:
          allOf:
          - $ref: '#/components/schemas/DescribeDeliveryStreamInputLimit'
          - description: The limit on the number of destinations to return. You can have one destination per delivery stream.
        ExclusiveStartDestinationId:
          allOf:
          - $ref: '#/components/schemas/DestinationId'
          - description: The ID of the destination to start returning the destination information. Kinesis Data Firehose supports one destination per delivery stream.
    ElasticsearchBufferingIntervalInSeconds:
      type: integer
      minimum: 60
      maximum: 900
    Prefix:
      type: string
      pattern: .*
      minLength: 0
      maxLength: 1024
    AmazonopensearchserviceIndexName:
      type: string
      pattern: .*
      minLength: 1
      maxLength: 80
    AmazonOpenSearchServerlessCollectionEndpoint:
      type: string
      pattern: https:.*
      minLength: 1
      maxLength: 512
    AmazonopensearchserviceRetryOptions:
      type: object
      properties:
        DurationInSeconds:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceRetryDurationInSeconds'
          - description: 'After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries. '
      description: 'Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. '
    ProcessorType:
      type: string
      enum:
      - RecordDeAggregation
      - Lambda
      - MetadataExtraction
      - AppendDelimiterToRecord
    OpenXJsonSerDe:
      type: object
      properties:
        ConvertDotsInJsonKeysToUnderscores:
          allOf:
          - $ref: '#/components/schemas/BooleanObject'
          - description: <p>When set to <code>true</code>, specifies that the names of the keys include dots and that you want Kinesis Data Firehose to replace them with underscores. This is useful because Apache Hive does not allow dots in column names. For example, if the JSON contains a key whose name is "a.b", you can define the column name to be "a_b" when using this option.</p> <p>The default is <code>false</code>.</p>
        CaseInsensitive:
          allOf:
          - $ref: '#/components/schemas/BooleanObject'
          - description: When set to <code>true</code>, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.
        ColumnToJsonKeyMappings:
          allOf:
          - $ref: '#/components/schemas/ColumnToJsonKeyMappings'
          - description: 'Maps column names to JSON keys that aren''t identical to the column names. This is useful when the JSON contains keys that are Hive keywords. For example, <code>timestamp</code> is a Hive keyword. If you have a JSON key named <code>timestamp</code>, set this parameter to <code>{"ts": "timestamp"}</code> to map this key to a column named <code>ts</code>.'
      description: The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.
    DestinationDescriptionList:
      type: array
      items:
        $ref: '#/components/schemas/DestinationDescription'
    CompressionFormat:
      type: string
      enum:
      - UNCOMPRESSED
      - GZIP
      - ZIP
      - Snappy
      - HADOOP_SNAPPY
    ExtendedS3DestinationDescription:
      type: object
      required:
      - RoleARN
      - BucketARN
      - BufferingHints
      - CompressionFormat
      - EncryptionConfiguration
      properties:
        RoleARN:
          allOf:
          - $ref: '#/components/schemas/RoleARN'
          - description: The Amazon Resource Name (ARN) of the Amazon Web Services credentials. 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>.
        BucketARN:
          allOf:
          - $ref: '#/components/schemas/BucketARN'
          - description: The ARN of the S3 bucket. 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>.
        Prefix:
          allOf:
          - $ref: '#/components/schemas/Prefix'
          - description: The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in <a href="https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html">Custom Prefixes for Amazon S3 Objects</a>.
        ErrorOutputPrefix:
          allOf:
          - $ref: '#/components/schemas/ErrorOutputPrefix'
          - description: A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html">Custom Prefixes for Amazon S3 Objects</a>.
        BufferingHints:
          allOf:
          - $ref: '#/components/schemas/BufferingHints'
          - description: The buffering option.
        CompressionFormat:
          allOf:
          - $ref: '#/components/schemas/CompressionFormat'
          - description: The compression format. If no value is specified, the default is <code>UNCOMPRESSED</code>.
        EncryptionConfiguration:
          allOf:
          - $ref: '#/components/schemas/EncryptionConfiguration'
          - description: The encryption configuration. If no value is specified, the default is no encryption.
        CloudWatchLoggingOptions:
          allOf:
          - $ref: '#/components/schemas/CloudWatchLoggingOptions'
          - description: The Amazon CloudWatch logging options for your delivery stream.
        ProcessingConfiguration:
          allOf:
          - $ref: '#/components/schemas/ProcessingConfiguration'
          - description: The data processing configuration.
        S3BackupMode:
          allOf:
          - $ref: '#/components/schemas/S3BackupMode'
          - description: The Amazon S3 backup mode.
        S3BackupDescription:
          allOf:
          - $ref: '#/components/schemas/S3DestinationDescription'
          - description: The configuration for backup in Amazon S3.
        DataFormatConversionConfiguration:
          allOf:
          - $ref: '#/components/schemas/DataFormatConversionConfiguration'
          - description: The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
        DynamicPartitioningConfiguration:
          allOf:
          - $ref: '#/components/schemas/DynamicPartitioningConfiguration'
          - description: 'The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations. '
      description: Describes a destination in Amazon S3.
    AWSKMSKeyARN:
      type: string
      pattern: arn:.*
      minLength: 1
      maxLength: 512
    HECEndpointType:
      type: string
      enum:
      - Raw
      - Event
    RoleARN:
      type: string
      pattern: arn:.*
      minLength: 1
      maxLength: 512
    SchemaConfiguration:
      type: object
      properties:
        RoleARN:
          allOf:
          - $ref: '#/components/schemas/NonEmptyStringWithoutWhitespace'
          - description: <p>The role that Kinesis Data Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.</p> <important> <p>If the <code>SchemaConfiguration</code> request parameter is used as part of invoking the <code>CreateDeliveryStream</code> API, then the <code>RoleARN</code> property is required and its value must be specified.</p> </important>
        CatalogId:
          allOf:
          - $ref: '#/components/schemas/NonEmptyStringWithoutWhitespace'
          - description: The ID of the Amazon Web Services Glue Data Catalog. If you don't supply this, the Amazon Web Services account ID is used by default.
        DatabaseName:
          allOf:
          - $ref: '#/components/schemas/NonEmptyStringWithoutWhitespace'
          - description: <p>Specifies the name of the Amazon Web Services Glue database that contains the schema for the output data.</p> <important> <p>If the <code>SchemaConfiguration</code> request parameter is used as part of invoking the <code>CreateDeliveryStream</code> API, then the <code>DatabaseName</code> property is required and its value must be specified.</p> </important>
        TableName:
          allOf:
          - $ref: '#/components/schemas/NonEmptyStringWithoutWhitespace'
          - description: <p>Specifies the Amazon Web Services Glue table that contains the column information that constitutes your data schema.</p> <important> <p>If the <code>SchemaConfiguration</code> request parameter is used as part of invoking the <code>CreateDeliveryStream</code> API, then the <code>TableName</code> property is required and its value must be specified.</p> </important>
        Region:
          allOf:
          - $ref: '#/components/schemas/NonEmptyStringWithoutWhitespace'
          - description: If you don't specify an Amazon Web Services Region, the default is the current Region.
        VersionId:
          allOf:
          - $ref: '#/components/schemas/NonEmptyStringWithoutWhitespace'
          - description: Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to <code>LATEST</code>, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.
      description: Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3. This parameter is required if <code>Enabled</code> is set to true.
    Serializer:
      type: object
      properties:
        ParquetSerDe:
          allOf:
          - $ref: '#/components/schemas/ParquetSerDe'
          - description: A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see <a href="https://parquet.apache.org/documentation/latest/">Apache Parquet</a>.
        OrcSerDe:
          allOf:
          - $ref: '#/components/schemas/OrcSerDe'
          - description: A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see <a href="https://orc.apache.org/docs/">Apache ORC</a>.
      description: 'The serializer that you want Kinesis Data Firehose to use to convert data to the target format before writing it to Amazon S3. Kinesis Data Firehose supports two types of serializers: the <a href="https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/orc/OrcSerde.html">ORC SerDe</a> and the <a href="https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/parquet/serde/ParquetHiveSerDe.html">Parquet SerDe</a>.'
    DeliveryStreamVersionId:
      type: string
      pattern: '[0-9]+'
      minLength: 1
      maxLength: 50
    HttpEndpointRetryOptions:
      type: object
      properties:
        DurationInSeconds:
          allOf:
          - $ref: '#/components/schemas/HttpEndpointRetryDurationInSeconds'
          - description: 'The total amount of time that Kinesis Data Firehose spends on retries. This duration starts after the initial attempt to send data to the custom destination via HTTPS endpoint fails. It doesn''t include the periods during which Kinesis Data Firehose waits for acknowledgment from the specified destination after each attempt. '
      description: Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.
    DeliveryStreamType:
      type: string
      enum:
      - DirectPut
      - KinesisStreamAsSource
    AmazonOpenSearchServerlessS3BackupMode:
      type: string
      enum:
      - FailedDocumentsOnly
      - AllDocuments
    KMSEncryptionConfig:
      type: object
      required:
      - AWSKMSKeyARN
      properties:
        AWSKMSKeyARN:
          allOf:
          - $ref: '#/components/schemas/AWSKMSKeyARN'
          - description: The Amazon Resource Name (ARN) of the encryption key. Must belong to the same Amazon Web Services Region as the destination Amazon S3 bucket. 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>.
      description: Describes an encryption key for a destination in Amazon S3.
    ElasticsearchDomainARN:
      type: string
      pattern: arn:.*
      minLength: 1
      maxLength: 512
    DeliveryStartTimestamp:
      type: string
      format: date-time
    AmazonopensearchserviceDestinationDescription:
      type: object
      properties:
        RoleARN:
          allOf:
          - $ref: '#/components/schemas/RoleARN'
          - description: 'The Amazon Resource Name (ARN) of the Amazon Web Services credentials. '
        DomainARN:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceDomainARN'
          - description: The ARN of the Amazon OpenSearch Service domain.
        ClusterEndpoint:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceClusterEndpoint'
          - description: 'The endpoint to use when communicating with the cluster. Kinesis Data Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service. '
        IndexName:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceIndexName'
          - description: The Amazon OpenSearch Service index name.
        TypeName:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceTypeName'
          - description: 'The Amazon OpenSearch Service type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there''s no value for TypeName. '
        IndexRotationPeriod:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceIndexRotationPeriod'
          - description: The Amazon OpenSearch Service index rotation period
        BufferingHints:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceBufferingHints'
          - description: The buffering options.
        RetryOptions:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceRetryOptions'
          - description: The Amazon OpenSearch Service retry options.
        S3BackupMode:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceS3BackupMode'
          - description: The Amazon S3 backup mode.
        S3DestinationDescription:
          $ref: '#/components/schemas/S3DestinationDescription'
        ProcessingConfiguration:
          $ref: '#/components/schemas/ProcessingConfiguration'
        CloudWatchLoggingOptions:
          $ref: '#/components/schemas/CloudWatchLoggingOptions'
        VpcConfigurationDescription:
          $ref: '#/components/schemas/VpcConfigurationDescription'
      description: The destination description in Amazon OpenSearch Service.
    CloudWatchLoggingOptions:
      type: object
      properties:
        Enabled:
          allOf:
          - $ref: '#/components/schemas/BooleanObject'
          - description: Enables or disables CloudWatch logging.
        LogGroupName:
          allOf:
          - $ref: '#/components/schemas/LogGroupName'
          - description: The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
        LogStreamName:
          allOf:
          - $ref: '#/components/schemas/LogStreamName'
          - description: The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
      description: Describes the Amazon CloudWatch logging options for your delivery stream.
    RedshiftRetryOptions:
      type: object
      properties:
        DurationInSeconds:
          allOf:
          - $ref: '#/components/schemas/RedshiftRetryDurationInSeconds'
          - description: The length of time during which Kinesis Data Firehose retries delivery after a failure, starting from the initial request and including the first attempt. The default value is 3600 seconds (60 minutes). Kinesis Data Firehose does not retry if the value of <code>DurationInSeconds</code> is 0 (zero) or if the first delivery attempt takes longer than the current value.
      description: Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift.
    DeliveryStreamARN:
      type: string
      pattern: arn:.*
      minLength: 1
      maxLength: 512
    S3DestinationDescription:
      type: object
      required:
      - RoleARN
      - BucketARN
      - BufferingHints
      - CompressionFormat
      - EncryptionConfiguration
      properties:
        RoleARN:
          allOf:
          - $ref: '#/components/schemas/RoleARN'
          - description: The Amazon Resource Name (ARN) of the Amazon Web Services credentials. 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>.
        BucketARN:
          allOf:
          - $ref: '#/components/schemas/BucketARN'
          - description: The ARN of the S3 bucket. 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>.
        Prefix:
          allOf:
          - $ref: '#/components/schemas/Prefix'
          - description: The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in <a href="https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html">Custom Prefixes for Amazon S3 Objects</a>.
        ErrorOutputPrefix:
          allOf:
          - $ref: '#/components/schemas/ErrorOutputPrefix'
          - description: A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html">Custom Prefixes for Amazon S3 Objects</a>.
        BufferingHints:
          allOf:
          - $ref: '#/components/schemas/BufferingHints'
          - description: The buffering option. If no value is specified, <code>BufferingHints</code> object default values are used.
        CompressionFormat:
          allOf:
          - $ref: '#/components/schemas/CompressionFormat'
          - description: The compression format. If no value is specified, the default is <code>UNCOMPRESSED</code>.
        EncryptionConfiguration:
          allOf:
          - $ref: '#/components/schemas/EncryptionConfiguration'
          - description: The encryption configuration. If no value is specified, the default is no encryption.
        CloudWatchLoggingOptions:
          allOf:
          - $ref: '#/components/schemas/CloudWatchLoggingOptions'
          - description: The Amazon CloudWatch logging options for your delivery stream.
      description: Describes a destination in Amazon S3.
    CopyOptions:
      type: string
      pattern: .*
      minLength: 0
      maxLength: 204800
    ElasticsearchClusterEndpoint:
      type: string
      pattern: https:.*
      minLength: 1
      maxLength: 512
    DataTableColumns:
      type: string
      pattern: .*
      minLength: 0
      maxLength: 204800
    ProcessorParameterName:
      type: string
      enum:
      - LambdaArn
      - NumberOfRetries
      - MetadataExtractionQuery
      - JsonParsingEngine
      - RoleArn
      - BufferSizeInMBs
      - BufferIntervalInSeconds
      - SubRecordType
      - Delimiter
    Deserializer:
      type: object
      properties:
        OpenXJsonSerDe:
          allOf:
          - $ref: '#/components/schemas/OpenXJsonSerDe'
          - description: The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.
        HiveJsonSerDe:
          allOf:
          - $ref: '#/components/schemas/HiveJsonSerDe'
          - description: The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.
      description: 'The deserializer you want Kinesis Data Firehose to use for converting the input data from JSON. Kinesis Data Firehose then serializes the data to its final format using the <a>Serializer</a>. Kinesis Data Firehose supports two types of deserializers: the <a href="https://cwiki.apache.org/confluence/display/Hive/LanguageManual+DDL#LanguageManualDDL-JSON">Apache Hive JSON SerDe</a> and the <a href="https://github.com/rcongiu/Hive-JSON-Serde">OpenX JSON SerDe</a>.'
    DestinationDescription:
      type: object
      required:
      - DestinationId
      properties:
        DestinationId:
          allOf:
          - $ref: '#/components/schemas/DestinationId'
          - description: The ID of the destination.
        S3DestinationDescription:
          allOf:
          - $ref: '#/components/schemas/S3DestinationDescription'
          - description: '[Deprecated] The destination in Amazon S3.'
        ExtendedS3DestinationDescription:
          allOf:
          - $ref: '#/components/schemas/ExtendedS3DestinationDescription'
          - description: The destination in Amazon S3.
        RedshiftDestinationDescription:
          allOf:
          - $ref: '#/components/schemas/RedshiftDestinationDescription'
          - description: The destination in Amazon Redshift.
        ElasticsearchDestinationDescription:
          allOf:
          - $ref: '#/components/schemas/ElasticsearchDestinationDescription'
          - description: The destination in Amazon ES.
        AmazonopensearchserviceDestinationDescription:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceDestinationDescription'
          - description: The destination in Amazon OpenSearch Service.
        SplunkDestinationDescription:
          allOf:
          - $ref: '#/components/schemas/SplunkDestinationDescription'
          - description: The destination in Splunk.
        HttpEndpointDestinationDescription:
          allOf:
          - $ref: '#/components/schemas/HttpEndpointDestinationDescription'
          - description: Describes the specified HTTP endpoint destination.
        AmazonOpenSearchServerlessDestinationDescription:
          allOf:
          - $ref: '#/components/schemas/AmazonOpenSearchServerlessDestinationDescription'
          - description: The destination in the Serverless offering for Amazon OpenSearch Service.
      description: Describes the destination for a delivery stream.
    SecurityGroupIdList:
      type: array
      items:
        $ref: '#/components/schemas/NonEmptyStringWithoutWhitespace'
      minItems: 1
      maxItems: 5
    NoEncryptionConfig:
      type: string
      enum:
      - NoEncryption
    Proportion:
      type: number
      format: double
      minimum: 0
      maximum: 1
    HttpEndpointBufferingHints:
      type: object
      properties:
        SizeInMBs:
          allOf:
          - $ref: '#/components/schemas/HttpEndpointBufferingSizeInMBs'
          - description: <p>Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5. </p> <p>We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher. </p>
        IntervalInSeconds:
          allOf:
          - $ref: '#/components/schemas/HttpEndpointBufferingIntervalInSeconds'
          - description: 'Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes). '
      description: 'Describes the buffering options that can be applied before data is delivered to the HTTP endpoint destination. Kinesis Data Firehose t

# --- truncated at 32 KB (86 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kinesis/refs/heads/main/openapi/kinesis-x-amz-target-firehose-20150804-describedeliverystream-api-openapi.yml