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

openapi: 3.2.0
info:
  version: 2015-08-04
  x-release: v4
  title: 'Amazon Kinesis Firehose #X Amz Target=Firehose 20150804.UpdateDestination 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.UpdateDestination'
paths:
  /#X-Amz-Target=Firehose_20150804.UpdateDestination:
    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: UpdateDestination
      description: <p>Updates the specified destination of the specified delivery stream.</p> <p>Use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are usually effective within a few minutes.</p> <p>Switching between Amazon ES and other services is not supported. For an Amazon ES destination, you can only update to another Amazon ES destination.</p> <p>If the destination type is the same, Kinesis Data Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values are retained. For example, in the Amazon S3 destination, if <a>EncryptionConfiguration</a> is not specified, then the existing <code>EncryptionConfiguration</code> is maintained on the destination.</p> <p>If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Kinesis Data Firehose does not merge any parameters. In this case, all parameters must be specified.</p> <p>Kinesis Data Firehose uses <code>CurrentDeliveryStreamVersionId</code> to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and can be retrieved using <a>DescribeDeliveryStream</a>. Use the new version ID to set <code>CurrentDeliveryStreamVersionId</code> in the next call.</p>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateDestinationOutput'
        '480':
          description: InvalidArgumentException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidArgumentException'
        '481':
          description: ResourceInUseException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceInUseException'
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '483':
          description: ConcurrentModificationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDestinationInput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Firehose_20150804.UpdateDestination
      tags:
      - '#X Amz Target=Firehose 20150804.UpdateDestination'
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'
    ElasticsearchBufferingIntervalInSeconds:
      type: integer
      minimum: 60
      maximum: 900
    Prefix:
      type: string
      pattern: .*
      minLength: 0
      maxLength: 1024
    UpdateDestinationInput:
      type: object
      required:
      - DeliveryStreamName
      - CurrentDeliveryStreamVersionId
      - DestinationId
      title: UpdateDestinationInput
      properties:
        DeliveryStreamName:
          allOf:
          - $ref: '#/components/schemas/DeliveryStreamName'
          - description: The name of the delivery stream.
        CurrentDeliveryStreamVersionId:
          allOf:
          - $ref: '#/components/schemas/DeliveryStreamVersionId'
          - description: Obtain this value from the <code>VersionId</code> result of <a>DeliveryStreamDescription</a>. This value is required, and helps the service perform conditional operations. For example, if there is an interleaving update and this value is null, then the update destination fails. After the update is successful, the <code>VersionId</code> value is updated. The service then performs a merge of the old configuration with the new configuration.
        DestinationId:
          allOf:
          - $ref: '#/components/schemas/DestinationId'
          - description: The ID of the destination.
        S3DestinationUpdate:
          allOf:
          - $ref: '#/components/schemas/S3DestinationUpdate'
          - deprecated: true
            description: '[Deprecated] Describes an update for a destination in Amazon S3.'
        ExtendedS3DestinationUpdate:
          allOf:
          - $ref: '#/components/schemas/ExtendedS3DestinationUpdate'
          - description: Describes an update for a destination in Amazon S3.
        RedshiftDestinationUpdate:
          allOf:
          - $ref: '#/components/schemas/RedshiftDestinationUpdate'
          - description: Describes an update for a destination in Amazon Redshift.
        ElasticsearchDestinationUpdate:
          allOf:
          - $ref: '#/components/schemas/ElasticsearchDestinationUpdate'
          - description: Describes an update for a destination in Amazon ES.
        AmazonopensearchserviceDestinationUpdate:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceDestinationUpdate'
          - description: Describes an update for a destination in Amazon OpenSearch Service.
        SplunkDestinationUpdate:
          allOf:
          - $ref: '#/components/schemas/SplunkDestinationUpdate'
          - description: Describes an update for a destination in Splunk.
        HttpEndpointDestinationUpdate:
          allOf:
          - $ref: '#/components/schemas/HttpEndpointDestinationUpdate'
          - description: Describes an update to the specified HTTP endpoint destination.
        AmazonOpenSearchServerlessDestinationUpdate:
          allOf:
          - $ref: '#/components/schemas/AmazonOpenSearchServerlessDestinationUpdate'
          - description: Describes an update for a destination in the Serverless offering for Amazon OpenSearch Service.
    InvalidArgumentException: {}
    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
    SplunkDestinationUpdate:
      type: object
      properties:
        HECEndpoint:
          allOf:
          - $ref: '#/components/schemas/HECEndpoint'
          - description: The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
        HECEndpointType:
          allOf:
          - $ref: '#/components/schemas/HECEndpointType'
          - description: This type can be either "Raw" or "Event."
        HECToken:
          allOf:
          - $ref: '#/components/schemas/HECToken'
          - description: A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
        HECAcknowledgmentTimeoutInSeconds:
          allOf:
          - $ref: '#/components/schemas/HECAcknowledgmentTimeoutInSeconds'
          - description: The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.
        RetryOptions:
          allOf:
          - $ref: '#/components/schemas/SplunkRetryOptions'
          - description: The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.
        S3BackupMode:
          allOf:
          - $ref: '#/components/schemas/SplunkS3BackupMode'
          - description: <p>Specifies how you want Kinesis Data Firehose to back up documents to Amazon S3. When set to <code>FailedDocumentsOnly</code>, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to <code>AllEvents</code>, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value is <code>FailedEventsOnly</code>.</p> <p>You can update this backup mode from <code>FailedEventsOnly</code> to <code>AllEvents</code>. You can't update it from <code>AllEvents</code> to <code>FailedEventsOnly</code>.</p>
        S3Update:
          allOf:
          - $ref: '#/components/schemas/S3DestinationUpdate'
          - description: Your update to the configuration of the backup Amazon S3 location.
        ProcessingConfiguration:
          allOf:
          - $ref: '#/components/schemas/ProcessingConfiguration'
          - description: The data processing configuration.
        CloudWatchLoggingOptions:
          allOf:
          - $ref: '#/components/schemas/CloudWatchLoggingOptions'
          - description: The Amazon CloudWatch logging options for your delivery stream.
      description: Describes an update for a destination in Splunk.
    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.
    RedshiftDestinationUpdate:
      type: object
      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>.
        ClusterJDBCURL:
          allOf:
          - $ref: '#/components/schemas/ClusterJDBCURL'
          - description: The database connection string.
        CopyCommand:
          allOf:
          - $ref: '#/components/schemas/CopyCommand'
          - description: The <code>COPY</code> command.
        Username:
          allOf:
          - $ref: '#/components/schemas/Username'
          - description: The name of the user.
        Password:
          allOf:
          - $ref: '#/components/schemas/Password'
          - description: The user password.
        RetryOptions:
          allOf:
          - $ref: '#/components/schemas/RedshiftRetryOptions'
          - description: The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
        S3Update:
          allOf:
          - $ref: '#/components/schemas/S3DestinationUpdate'
          - description: <p>The Amazon S3 destination.</p> <p>The compression formats <code>SNAPPY</code> or <code>ZIP</code> cannot be specified in <code>RedshiftDestinationUpdate.S3Update</code> because the Amazon Redshift <code>COPY</code> operation that reads from the S3 bucket doesn't support these compression formats.</p>
        ProcessingConfiguration:
          allOf:
          - $ref: '#/components/schemas/ProcessingConfiguration'
          - description: The data processing configuration.
        S3BackupMode:
          allOf:
          - $ref: '#/components/schemas/RedshiftS3BackupMode'
          - description: 'You can update a delivery stream to enable Amazon S3 backup if it is disabled. If backup is enabled, you can''t update the delivery stream to disable it. '
        S3BackupUpdate:
          allOf:
          - $ref: '#/components/schemas/S3DestinationUpdate'
          - description: The Amazon S3 destination for backup.
        CloudWatchLoggingOptions:
          allOf:
          - $ref: '#/components/schemas/CloudWatchLoggingOptions'
          - description: The Amazon CloudWatch logging options for your delivery stream.
      description: Describes an update for a destination in Amazon Redshift.
    CompressionFormat:
      type: string
      enum:
      - UNCOMPRESSED
      - GZIP
      - ZIP
      - Snappy
      - HADOOP_SNAPPY
    AWSKMSKeyARN:
      type: string
      pattern: arn:.*
      minLength: 1
      maxLength: 512
    HttpEndpointAccessKey:
      type: string
      pattern: .*
      minLength: 0
      maxLength: 4096
      format: password
    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
    AmazonopensearchserviceDestinationUpdate:
      type: object
      properties:
        RoleARN:
          allOf:
          - $ref: '#/components/schemas/RoleARN'
          - description: 'The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents. '
        DomainARN:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceDomainARN'
          - description: The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN.
        ClusterEndpoint:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceClusterEndpoint'
          - description: 'The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field. '
        IndexName:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceIndexName'
          - description: The Amazon OpenSearch Service index name.
        TypeName:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceTypeName'
          - description: <p>The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during runtime. </p> <p>If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName. </p>
        IndexRotationPeriod:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceIndexRotationPeriod'
          - description: The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.
        BufferingHints:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceBufferingHints'
          - description: 'The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used. '
        RetryOptions:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceRetryOptions'
          - description: 'The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes). '
        S3Update:
          $ref: '#/components/schemas/S3DestinationUpdate'
        ProcessingConfiguration:
          $ref: '#/components/schemas/ProcessingConfiguration'
        CloudWatchLoggingOptions:
          $ref: '#/components/schemas/CloudWatchLoggingOptions'
      description: Describes an update for a destination in Amazon OpenSearch Service.
    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.
    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
    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.
    UpdateDestinationOutput:
      type: object
      properties: {}
    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.
    CopyOptions:
      type: string
      pattern: .*
      minLength: 0
      maxLength: 204800
    DataTableColumns:
      type: string
      pattern: .*
      minLength: 0
      maxLength: 204800
    ElasticsearchClusterEndpoint:
      type: string
      pattern: https:.*
      minLength: 1
      maxLength: 512
    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>.'
    NoEncryptionConfig:
      type: string
      enum:
      - NoEncryption
    Proportion:
      type: number
      format: double
      minimum: 0
      maximum: 1
    HttpEndpointBufferingHints:
      type: object
      properties:
        SizeInMBs:
          allOf:
          - $ref: '#/components/schemas/HttpEndpointBufferingSizeI

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