openapi: 3.0.0
info:
version: 2015-08-04
x-release: v4
title: 'Amazon Kinesis Firehose CreateSignalingChannel #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:
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 treats these options as hints, and it might choose to use more optimal values. The <code>SizeInMBs</code> and <code>IntervalInSeconds</code> parameters are optional. However, if specify a value for one of them, you must also provide a value for the other. '
HttpEndpointCommonAttribute:
type: object
required:
- AttributeName
- AttributeValue
properties:
AttributeName:
allOf:
- $ref: '#/components/schemas/HttpEndpointAttributeName'
- description: The name of the HTTP endpoint common attribute.
AttributeValue:
allOf:
- $ref: '#/components/schemas/HttpEndpointAttributeValue'
- description: The value of the HTTP endpoint common attribute.
description: Describes the metadata that's delivered to the specified HTTP endpoint destination.
HECEndpoint:
type: string
pattern: .*
minLength: 0
maxLength: 2048
ProcessorParameterList:
type: array
items:
$ref: '#/components/schemas/ProcessorParameter'
DynamicPartitioningConfiguration:
type: object
properties:
RetryOptions:
allOf:
- $ref: '#/components/schemas/RetryOptions'
- description: The retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon S3 prefix.
Enabled:
allOf:
- $ref: '#/components/schemas/BooleanObject'
- description: Specifies that the dynamic partitioning is enabled for this Kinesis Data Firehose delivery stream.
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. '
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.
S3BackupMode:
type: string
enum:
- Disabled
- Enabled
AmazonopensearchserviceTypeName:
type: string
pattern: .*
minLength: 0
maxLength: 100
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.
OutputFormatConfiguration:
type: object
properties:
Serializer:
allOf:
- $ref: '#/components/schemas/Serializer'
- description: Specifies which serializer to use. You can choose either the ORC SerDe or the Parquet SerDe. If both are non-null, the server rejects the request.
description: Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data before it writes it to Amazon S3. This parameter is required if <code>Enabled</code> is set to true.
HttpEndpointCommonAttributesList:
type: array
items:
$ref: '#/components/schemas/HttpEndpointCommonAttribute'
minItems: 0
maxItems: 50
LogGroupName:
type: string
pattern: '[\.\-_/#A-Za-z0-9]*'
minLength: 0
maxLength: 512
HttpEndpointAccessKey:
type: string
pattern: .*
minLength: 0
maxLength: 4096
format: password
AmazonopensearchserviceBufferingHints:
type: object
properties:
IntervalInSeconds:
allOf:
- $ref: '#/components/schemas/AmazonopensearchserviceBufferingIntervalInSeconds'
- 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). '
SizeInMBs:
allOf:
- $ref: '#/components/schemas/AmazonopensearchserviceBufferingSizeInMBs'
- 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>
description: 'Describes the buffering to perform before delivering data to the Amazon OpenSearch Service destination. '
HttpEndpointRetryDurationInSeconds:
type: integer
minimum: 0
maximum: 7200
AmazonOpenSearchServerlessBufferingHints:
type: object
properties:
IntervalInSeconds:
allOf:
- $ref: '#/components/schemas/AmazonOpenSearchServerlessBufferingIntervalInSeconds'
- 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).
SizeInMBs:
allOf:
- $ref: '#/components/schemas/AmazonOpenSearchServerlessBufferingSizeInMBs'
- 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>
description: Describes the buffering to perform before delivering data to the Serverless offering for Amazon OpenSearch Service destination.
Processor:
type: object
required:
- Type
properties:
Type:
allOf:
- $ref: '#/components/schemas/ProcessorType'
- description: The type of processor.
Parameters:
allOf:
- $ref: '#/components/schemas/ProcessorParameterList'
- description: The processor parameters.
description: Describes a data processor.
NonEmptyString:
type: string
pattern: ^(?!\s*$).+
minLength: 1
maxLength: 1024
CopyOptions:
type: string
pattern: .*
minLength: 0
maxLength: 204800
ProcessorType:
type: string
enum:
- RecordDeAggregation
- Lambda
- MetadataExtraction
- AppendDelimiterToRecord
AmazonopensearchserviceBufferingSizeInMBs:
type: integer
minimum: 1
maximum: 100
RedshiftS3BackupMode:
type: string
enum:
- Disabled
- Enabled
OrcCompression:
type: string
enum:
- NONE
- ZLIB
- SNAPPY
OrcStripeSizeBytes:
type: integer
minimum: 8388608
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. '
InputFormatConfiguration:
type: object
properties:
Deserializer:
allOf:
- $ref: '#/components/schemas/Deserializer'
- description: Specifies which deserializer to use. You can choose either the Apache Hive JSON SerDe or the OpenX JSON SerDe. If both are non-null, the server rejects the request.
description: Specifies the deserializer you want to use to convert the format of the input data. This parameter is required if <code>Enabled</code> is set to true.
HttpEndpointUrl:
type: string
pattern: https://.*
minLength: 1
maxLength: 1000
format: password
HiveJsonSerDe:
type: object
properties:
TimestampFormats:
allOf:
- $ref: '#/components/schemas/ListOfNonEmptyStrings'
- description: Indicates how you want Kinesis Data Firehose to parse the date and timestamps that may be present in your input data JSON. To specify these format strings, follow the pattern syntax of JodaTime's DateTimeFormat format strings. For more information, see <a href="https://www.joda.org/joda-time/apidocs/org/joda/time/format/DateTimeFormat.html">Class DateTimeFormat</a>. You can also use the special value <code>millis</code> to parse timestamps in epoch milliseconds. If you don't specify a format, Kinesis Data Firehose uses <code>java.sql.Timestamp::valueOf</code> by default.
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.
DataTableName:
type: string
pattern: .*
minLength: 1
maxLength: 512
ElasticsearchRetryOptions:
type: object
properties:
DurationInSeconds:
allOf:
- $ref: '#/components/schemas/ElasticsearchRetryDurationInSeconds'
- description: After an initial failure to deliver to Amazon ES, 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 ES.
ElasticsearchIndexRotationPeriod:
type: string
enum:
- NoRotation
- OneHour
- OneDay
- OneWeek
- OneMonth
OrcRowIndexStride:
type: integer
minimum: 1000
ElasticsearchDomainARN:
type: string
pattern: arn:.*
minLength: 1
maxLength: 512
HECToken:
type: string
pattern: .*
minLength: 0
maxLength: 2048
AmazonOpenSearchServerlessDestinationUpdate:
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 Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
CollectionEndpoint:
allOf:
- $ref: '#/components/schemas/AmazonOpenSearchServerlessCollectionEndpoint'
- description: The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
IndexName:
allOf:
- $ref: '#/components/schemas/AmazonOpenSearchServerlessIndexName'
- description: The Serverless offering for Amazon OpenSearch Service index name.
BufferingHints:
allOf:
- $ref: '#/components/schemas/AmazonOpenSearchServerlessBufferingHints'
- description: The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.
RetryOptions:
allOf:
- $ref: '#/components/schemas/AmazonOpenSearchServerlessRetryOptions'
- description: The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for 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 the Serverless offering for Amazon OpenSearch Service.
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. '
CopyCommand:
type: object
required:
- DataTableName
properties:
DataTableName:
allOf:
- $ref: '#/components/schemas/DataTableName'
- description: The name of the target table. The table must already exist in the database.
DataTableColumns:
allOf:
- $ref: '#/components/schemas/DataTableColumns'
- description: A comma-separated list of column names.
CopyOptions:
allOf:
- $ref: '#/components/schemas/CopyOptions'
- description: <p>Optional parameters to use with the Amazon Redshift <code>COPY</code> command. For more information, see the "Optional Parameters" section of <a href="https://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html">Amazon Redshift COPY command</a>. Some possible examples that would apply to Kinesis Data Firehose are as follows:</p> <p> <code>delimiter '\t' lzop;</code> - fields are delimited with "\t" (TAB character) and compressed using lzop.</p> <p> <code>delimiter '|'</code> - fields are delimited with "|" (this is the default delimiter).</p> <p> <code>delimiter '|' escape</code> - the delimiter should be escaped.</p> <p> <code>fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6'</code> - fields are fixed width in the source, with each width specified after every column in the table.</p> <p> <code>JSON 's3://mybucket/jsonpaths.txt'</code> - data is in JSON format, and the path specified is the format of the data.</p> <p>For more examples, see <a href="https://docs.aws.amazon.com/redshift/latest/dg/r_COPY_command_examples.html">Amazon Redshift COPY command examples</a>.</p>
description: Describes a <code>COPY</code> command for Amazon Redshift.
HECEndpointType:
type: string
enum:
- Raw
- Event
SplunkRetryOptions:
type: object
properties:
DurationInSeconds:
allOf:
- $ref: '#/components/schemas/SplunkRetryDurationInSeconds'
- description: The total amount of time that Kinesis Data Firehose spends on retries. This duration starts after the initial attempt to send data to Splunk fails. It doesn't include the periods during which Kinesis Data Firehose waits for acknowledgment from Splunk after each attempt.
description: Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Splunk, or if it doesn't receive an acknowledgment from Splunk.
ProcessorParameterName:
type: string
enum:
- LambdaArn
- NumberOfRetries
- MetadataExtractionQuery
- JsonParsingEngine
- RoleArn
- BufferSizeInMBs
- BufferIntervalInSeconds
- SubRecordType
- Delimiter
DeliveryStreamVersionId:
type: string
pattern: '[0-9]+'
minLength: 1
maxLength: 50
HttpEndpointS3BackupMode:
type: string
enum:
- FailedDataOnly
- AllData
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.
RetryDurationInSeconds:
type: integer
minimum: 0
maximum: 7200
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.
ConcurrentModificationException: {}
HttpEndpointAttributeName:
type: string
pattern: ^(?!\s*$).+
minLength: 1
maxLength: 256
format: password
HECAcknowledgmentTimeoutInSeconds:
type: integer
minimum: 180
maximum: 600
LogStreamName:
type: string
pattern: '[^:*]*'
minLength: 0
maxLength: 512
ParquetPageSizeBytes:
type: integer
minimum: 65536
Password:
type: string
pattern: .*
minLength: 6
maxLength: 512
format: password
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.
DestinationId:
type: string
pattern: '[a-zA-Z0-9-]+'
minLength: 1
maxLength: 100
ElasticsearchClusterEndpoint:
type: string
pattern: https:.*
minLength: 1
maxLength: 512
HttpEndpointConfiguration:
type: object
required:
- Url
properties:
Url:
allOf:
- $ref: '#/components/schemas/HttpEndpointUrl'
- description: <p>The URL of the HTTP endpoint selected as the destination.</p> <important> <p>If you choose an HTTP endpoint as your destination, review and follow the instructions in the <a
# --- 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