openapi: 3.0.0
info:
version: 2015-08-04
x-release: v4
title: 'Amazon Kinesis Firehose CreateSignalingChannel #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:
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. '
DeliveryStreamType:
type: string
enum:
- DirectPut
- KinesisStreamAsSource
HECEndpoint:
type: string
pattern: .*
minLength: 0
maxLength: 2048
ElasticsearchS3BackupMode:
type: string
enum:
- FailedDocumentsOnly
- AllDocuments
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.
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. '
HttpEndpointDescription:
type: object
properties:
Url:
allOf:
- $ref: '#/components/schemas/HttpEndpointUrl'
- description: The URL of the HTTP endpoint selected as the destination.
Name:
allOf:
- $ref: '#/components/schemas/HttpEndpointName'
- description: The name of the HTTP endpoint selected as the destination.
description: 'Describes the HTTP endpoint selected as the destination. '
DeliveryStreamEncryptionStatus:
type: string
enum:
- ENABLED
- ENABLING
- ENABLING_FAILED
- DISABLED
- DISABLING
- DISABLING_FAILED
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.
DeliveryStreamStatus:
type: string
enum:
- CREATING
- CREATING_FAILED
- DELETING
- DELETING_FAILED
- ACTIVE
S3BackupMode:
type: string
enum:
- Disabled
- Enabled
AmazonopensearchserviceTypeName:
type: string
pattern: .*
minLength: 0
maxLength: 100
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.
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.
DescribeDeliveryStreamInputLimit:
type: integer
minimum: 1
maximum: 10000
HttpEndpointCommonAttributesList:
type: array
items:
$ref: '#/components/schemas/HttpEndpointCommonAttribute'
minItems: 0
maxItems: 50
LogGroupName:
type: string
pattern: '[\.\-_/#A-Za-z0-9]*'
minLength: 0
maxLength: 512
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. '
DescribeDeliveryStreamOutput:
type: object
required:
- DeliveryStreamDescription
properties:
DeliveryStreamDescription:
allOf:
- $ref: '#/components/schemas/DeliveryStreamDescription'
- description: Information about the delivery stream.
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.
HttpEndpointRetryDurationInSeconds:
type: integer
minimum: 0
maximum: 7200
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
ElasticsearchDestinationDescription:
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>.
DomainARN:
allOf:
- $ref: '#/components/schemas/ElasticsearchDomainARN'
- description: <p>The ARN of the Amazon ES domain. 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>.</p> <p>Kinesis Data Firehose uses either <code>ClusterEndpoint</code> or <code>DomainARN</code> to send data to Amazon ES.</p>
ClusterEndpoint:
allOf:
- $ref: '#/components/schemas/ElasticsearchClusterEndpoint'
- description: The endpoint to use when communicating with the cluster. Kinesis Data Firehose uses either this <code>ClusterEndpoint</code> or the <code>DomainARN</code> field to send data to Amazon ES.
IndexName:
allOf:
- $ref: '#/components/schemas/ElasticsearchIndexName'
- description: The Elasticsearch index name.
TypeName:
allOf:
- $ref: '#/components/schemas/ElasticsearchTypeName'
- description: The Elasticsearch 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 <code>TypeName</code>.
IndexRotationPeriod:
allOf:
- $ref: '#/components/schemas/ElasticsearchIndexRotationPeriod'
- description: The Elasticsearch index rotation period
BufferingHints:
allOf:
- $ref: '#/components/schemas/ElasticsearchBufferingHints'
- description: The buffering options.
RetryOptions:
allOf:
- $ref: '#/components/schemas/ElasticsearchRetryOptions'
- description: The Amazon ES retry options.
S3BackupMode:
allOf:
- $ref: '#/components/schemas/ElasticsearchS3BackupMode'
- description: The Amazon S3 backup mode.
S3DestinationDescription:
allOf:
- $ref: '#/components/schemas/S3DestinationDescription'
- description: The Amazon S3 destination.
ProcessingConfiguration:
allOf:
- $ref: '#/components/schemas/ProcessingConfiguration'
- description: The data processing configuration.
CloudWatchLoggingOptions:
allOf:
- $ref: '#/components/schemas/CloudWatchLoggingOptions'
- description: The Amazon CloudWatch logging options.
VpcConfigurationDescription:
allOf:
- $ref: '#/components/schemas/VpcConfigurationDescription'
- description: The details of the VPC of the Amazon ES destination.
description: The destination description in Amazon ES.
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.
KeyType:
type: string
enum:
- AWS_OWNED_CMK
- CUSTOMER_MANAGED_CMK
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
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.
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
SubnetIdList:
type: array
items:
$ref: '#/components/schemas/NonEmptyStringWithoutWhitespace'
minItems: 1
maxItems: 16
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.
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. '
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
DeliveryStreamARN:
type: string
pattern: arn:.*
minLength: 1
maxLength: 512
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.
# --- 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