AWS Kinesis #X Amz Target=Firehose 20150804.DescribeDeliveryStream API is one of 100 APIs that AWS Kinesis publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include #X Amz Target=Firehose 20150804.DescribeDeliveryStream. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, pricing, and a getting-started guide.
This API exposes
1 operation
across 1 path,
and defines 148 schemas.
It is described by OpenAPI 3.2.0, at version 2015-08-04.
Requests are made against 4 base URLs: http://firehose.{region}.amazonaws.com, https://firehose.{region}.amazonaws.com, http://firehose.{region}.amazonaws.com.cn, https://firehose.{region}.amazonaws.com.cn.
The identity and technical contract details declared by the specification.
HttpEndpointAttributeName
string
AmazonopensearchserviceBufferingIntervalInSeconds
integer
ProcessorParameter
object
Describes the processor parameter.
2 properties
2 required
ListOfNonEmptyStringsWithoutWhitespace
array
DescribeDeliveryStreamInput
object
3 properties
1 required
ElasticsearchBufferingIntervalInSeconds
integer
AmazonopensearchserviceIndexName
string
AmazonOpenSearchServerlessCollectionEndpoint
string
AmazonopensearchserviceRetryOptions
object
Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.
1 property
OpenXJsonSerDe
object
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…
3 properties
DestinationDescriptionList
array
ExtendedS3DestinationDescription
object
Describes a destination in Amazon S3.
13 properties
5 required
SchemaConfiguration
object
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 Enabled is…
6 properties
Serializer
object
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 t…
2 properties
DeliveryStreamVersionId
string
HttpEndpointRetryOptions
object
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 val…
1 property
DeliveryStreamType
string
AmazonOpenSearchServerlessS3BackupMode
string
KMSEncryptionConfig
object
Describes an encryption key for a destination in Amazon S3.
1 property
1 required
ElasticsearchDomainARN
string
DeliveryStartTimestamp
string
AmazonopensearchserviceDestinationDescription
object
The destination description in Amazon OpenSearch Service.
13 properties
CloudWatchLoggingOptions
object
Describes the Amazon CloudWatch logging options for your delivery stream.
3 properties
RedshiftRetryOptions
object
Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift.
1 property
S3DestinationDescription
object
Describes a destination in Amazon S3.
8 properties
5 required
ElasticsearchClusterEndpoint
string
ProcessorParameterName
string
Deserializer
object
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 for…
2 properties
DestinationDescription
object
Describes the destination for a delivery stream.
9 properties
1 required
SecurityGroupIdList
array
NoEncryptionConfig
string
HttpEndpointBufferingHints
object
Describes the buffering options that can be applied before data is delivered to the HTTP endpoint destination. Kinesis Data Firehose treats these options as hi…
2 properties
HttpEndpointBufferingSizeInMBs
integer
ElasticsearchIndexRotationPeriod
string
ParquetWriterVersion
string
AmazonopensearchserviceIndexRotationPeriod
string
ElasticsearchS3BackupMode
string
AmazonopensearchserviceBufferingHints
object
Describes the buffering to perform before delivering data to the Amazon OpenSearch Service destination.
2 properties
ParquetSerDe
object
A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet .
6 properties
RedshiftRetryDurationInSeconds
integer
ElasticsearchBufferingSizeInMBs
integer
RetryDurationInSeconds
integer
AmazonopensearchserviceDomainARN
string
HttpEndpointRequestConfiguration
object
The configuration of the HTTP endpoint request.
2 properties
HttpEndpointS3BackupMode
string
ParquetPageSizeBytes
integer
ElasticsearchDestinationDescription
object
The destination description in Amazon ES.
13 properties
ResourceNotFoundException
SplunkS3BackupMode
string
IntervalInSeconds
integer
RedshiftS3BackupMode
string
HttpEndpointAttributeValue
string
ProcessingConfiguration
object
Describes a data processing configuration.
2 properties
ElasticsearchRetryOptions
object
Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES.
1 property
ListOfNonEmptyStrings
array
Processor
object
Describes a data processor.
2 properties
1 required
OrcStripeSizeBytes
integer
AmazonOpenSearchServerlessRetryOptions
object
Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.
1 property
HttpEndpointCommonAttributesList
array
ElasticsearchBufferingHints
object
Describes the buffering to perform before delivering data to the Amazon ES destination.
2 properties
ProcessorParameterValue
string
RetryOptions
object
The retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon S3 prefix.
1 property
AmazonOpenSearchServerlessIndexName
string
AmazonOpenSearchServerlessDestinationDescription
object
The destination description in the Serverless offering for Amazon OpenSearch Service.
10 properties
ProcessorParameterList
array
ElasticsearchIndexName
string
AmazonopensearchserviceBufferingSizeInMBs
integer
AmazonOpenSearchServerlessRetryDurationInSeconds
integer
KinesisStreamSourceDescription
object
Details about a Kinesis data stream used as the source for a Kinesis Data Firehose delivery stream.
3 properties
ColumnToJsonKeyMappings
object
NonEmptyStringWithoutWhitespace
string
DescribeDeliveryStreamOutput
object
1 property
1 required
ElasticsearchTypeName
string
AmazonopensearchserviceClusterEndpoint
string
ElasticsearchRetryDurationInSeconds
integer
VpcConfigurationDescription
object
The details of the VPC of the Amazon ES destination.
4 properties
4 required
OrcRowIndexStride
integer
FailureDescription
object
Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream , DeleteDeliveryStream , StartDeliveryStrea…
2 properties
2 required
SourceDescription
object
Details about a Kinesis data stream used as the source for a Kinesis Data Firehose delivery stream.
1 property
DeliveryStreamName
string
SplunkRetryOptions
object
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.
1 property
SplunkRetryDurationInSeconds
integer
HttpEndpointDescription
object
Describes the HTTP endpoint selected as the destination.
2 properties
DeliveryStreamFailureType
string
DescribeDeliveryStreamInputLimit
integer
DeliveryStreamEncryptionStatus
string
CopyCommand
object
Describes a COPY command for Amazon Redshift.
3 properties
1 required
DynamicPartitioningConfiguration
object
The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Curr…
2 properties
HiveJsonSerDe
object
The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for s…
1 property
OrcSerDe
object
A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC .
10 properties
DeliveryStreamDescription
object
Contains information about a delivery stream.
12 properties
7 required
BufferingHints
object
Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Kinesis Data Firehose…
2 properties
SplunkDestinationDescription
object
Describes a destination in Splunk.
9 properties
AmazonOpenSearchServerlessBufferingSizeInMBs
integer
HECAcknowledgmentTimeoutInSeconds
integer
HttpEndpointDestinationDescription
object
Describes the HTTP endpoint destination.
9 properties
InputFormatConfiguration
object
Specifies the deserializer you want to use to convert the format of the input data. This parameter is required if Enabled is set to true.
1 property
AmazonopensearchserviceTypeName
string
HttpEndpointBufferingIntervalInSeconds
integer
NonNegativeIntegerObject
integer
HttpEndpointRetryDurationInSeconds
integer
AmazonOpenSearchServerlessBufferingHints
object
Describes the buffering to perform before delivering data to the Serverless offering for Amazon OpenSearch Service destination.
2 properties
HttpEndpointCommonAttribute
object
Describes the metadata that's delivered to the specified HTTP endpoint destination.
2 properties
2 required
ParquetCompression
string
DataFormatConversionConfiguration
object
Specifies that you want Kinesis Data Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. Kinesis Data Fi…
4 properties
AmazonOpenSearchServerlessBufferingIntervalInSeconds
integer
DeliveryStreamStatus
string
AmazonopensearchserviceS3BackupMode
string
AmazonopensearchserviceRetryDurationInSeconds
integer
RedshiftDestinationDescription
object
Describes a destination in Amazon Redshift.
10 properties
5 required
OutputFormatConfiguration
object
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 requ…
1 property
DeliveryStreamEncryptionConfiguration
object
Contains information about the server-side encryption (SSE) status for the delivery stream, the type customer master key (CMK) in use, if any, and the ARN of t…
4 properties
EncryptionConfiguration
object
Describes the encryption for a destination in Amazon S3.
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs AWS Kinesis publishes across the network.
