AWS Kinesis #X Amz Target=Firehose 20150804.DescribeDeliveryStream API
The #X Amz Target=Firehose 20150804.DescribeDeliveryStream API from AWS Kinesis — 1 operation(s) for #x amz target=firehose 20150804.describedeliverystream.
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.0.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.
1 operations
1 paths
148 schemas
1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
AWS Kinesis #X Amz Target=Firehose 20150804.DescribeDeliveryStream API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac— Amazon Signature authorization v4
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.
#X Amz Target=Firehose 20150804.DescribeDeliveryStream 1
POST
/#X-Amz-Target=Firehose_20150804.DescribeDeliveryStream
Describes the specified delivery stream and its status. For example, after your delivery stream is created, call DescribeDeliveryStream to see whether the delivery stream is ACTIVE and therefore read…
Schemas 148
The contract defines 148 schemas that model the data the API accepts and returns. The most detailed are AmazonopensearchserviceDestinationDescription (13 properties), ExtendedS3DestinationDescription (13 properties), ElasticsearchDestinationDescription (13 properties), DeliveryStreamDescription (12 properties). Each schema is shown below with its type and property counts.
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
DeliveryStreamType
string
HECEndpoint
string
ElasticsearchS3BackupMode
string
HttpEndpointCommonAttribute
object
Describes the metadata that's delivered to the specified HTTP endpoint destination.
2 properties
2 required
ProcessorParameterList
array
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
HttpEndpointDescription
object
Describes the HTTP endpoint selected as the destination.
2 properties
DeliveryStreamEncryptionStatus
string
CloudWatchLoggingOptions
object
Describes the Amazon CloudWatch logging options for your delivery stream.
3 properties
DeliveryStreamStatus
string
S3BackupMode
string
AmazonopensearchserviceTypeName
string
DescribeDeliveryStreamInput
object
3 properties
1 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
DescribeDeliveryStreamInputLimit
integer
HttpEndpointCommonAttributesList
array
LogGroupName
string
AmazonopensearchserviceBufferingHints
object
Describes the buffering to perform before delivering data to the Amazon OpenSearch Service destination.
2 properties
DescribeDeliveryStreamOutput
object
1 property
1 required
AmazonOpenSearchServerlessBufferingHints
object
Describes the buffering to perform before delivering data to the Serverless offering for Amazon OpenSearch Service destination.
2 properties
HttpEndpointRetryDurationInSeconds
integer
Processor
object
Describes a data processor.
2 properties
1 required
NonEmptyString
string
CopyOptions
string
ProcessorType
string
AmazonopensearchserviceBufferingSizeInMBs
integer
ElasticsearchDestinationDescription
object
The destination description in Amazon ES.
13 properties
RedshiftS3BackupMode
string
OrcCompression
string
OrcStripeSizeBytes
integer
ProcessorParameter
object
Describes the processor parameter.
2 properties
2 required
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
KeyType
string
HttpEndpointUrl
string
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
DataTableName
string
AmazonopensearchserviceDestinationDescription
object
The destination description in Amazon OpenSearch Service.
13 properties
ElasticsearchRetryOptions
object
Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES.
1 property
ElasticsearchIndexRotationPeriod
string
OrcRowIndexStride
integer
ElasticsearchDomainARN
string
HECToken
string
SubnetIdList
array
CopyCommand
object
Describes a COPY command for Amazon Redshift.
3 properties
1 required
AmazonopensearchserviceRetryOptions
object
Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.
1 property
HECEndpointType
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
ProcessorParameterName
string
DeliveryStreamVersionId
string
DeliveryStreamARN
string
ExtendedS3DestinationDescription
object
Describes a destination in Amazon S3.
13 properties
5 required
KMSEncryptionConfig
object
Describes an encryption key for a destination in Amazon S3.
1 property
1 required
HttpEndpointS3BackupMode
string
RetryDurationInSeconds
integer
HttpEndpointAttributeName
string
VpcConfigurationDescription
object
The details of the VPC of the Amazon ES destination.
4 properties
4 required
AmazonopensearchserviceS3BackupMode
string
HECAcknowledgmentTimeoutInSeconds
integer
LogStreamName
string
ParquetPageSizeBytes
integer
RedshiftRetryOptions
object
Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift.
1 property
DestinationId
string
ElasticsearchClusterEndpoint
string
AmazonOpenSearchServerlessBufferingSizeInMBs
integer
ProcessingConfiguration
object
Describes a data processing configuration.
2 properties
Prefix
string
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
AWSKMSKeyARN
string
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
ElasticsearchBufferingIntervalInSeconds
integer
ListOfNonEmptyStringsWithoutWhitespace
array
S3DestinationDescription
object
Describes a destination in Amazon S3.
8 properties
5 required
RedshiftRetryDurationInSeconds
integer
EncryptionConfiguration
object
Describes the encryption for a destination in Amazon S3.
2 properties
AmazonOpenSearchServerlessDestinationDescription
object
The destination description in the Serverless offering for Amazon OpenSearch Service.
10 properties
DeliveryStreamDescription
object
Contains information about a delivery stream.
12 properties
7 required
SplunkDestinationDescription
object
Describes a destination in Splunk.
9 properties
HttpEndpointRequestConfiguration
object
The configuration of the HTTP endpoint request.
2 properties
Timestamp
string
SizeInMBs
integer
HttpEndpointBufferingSizeInMBs
integer
ClusterJDBCURL
string
NonEmptyStringWithoutWhitespace
string
ElasticsearchBufferingHints
object
Describes the buffering to perform before delivering data to the Amazon ES destination.
2 properties
RedshiftDestinationDescription
object
Describes a destination in Amazon Redshift.
10 properties
5 required
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
ErrorOutputPrefix
string
ColumnToJsonKeyMappings
object
KinesisStreamARN
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
ProcessorList
array
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
IntervalInSeconds
integer
Username
string
DataTableColumns
string
HttpEndpointAttributeValue
string
RoleARN
string
SecurityGroupIdList
array
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
ResourceNotFoundException
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
AmazonOpenSearchServerlessRetryDurationInSeconds
integer
DestinationDescriptionList
array
RetryOptions
object
The retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon S3 prefix.
1 property
HttpEndpointDestinationDescription
object
Describes the HTTP endpoint destination.
9 properties
SourceDescription
object
Details about a Kinesis data stream used as the source for a Kinesis Data Firehose delivery stream.
1 property
ListOfNonEmptyStrings
array
AmazonopensearchserviceIndexName
string
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
Proportion
number
DeliveryStreamName
string
ElasticsearchRetryDurationInSeconds
integer
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
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
SplunkS3BackupMode
string
ElasticsearchBufferingSizeInMBs
integer
OrcFormatVersion
string
AmazonOpenSearchServerlessCollectionEndpoint
string
DeliveryStartTimestamp
string
KinesisStreamSourceDescription
object
Details about a Kinesis data stream used as the source for a Kinesis Data Firehose delivery stream.
3 properties
AmazonopensearchserviceDomainARN
string
CompressionFormat
string
AmazonopensearchserviceBufferingIntervalInSeconds
integer
BucketARN
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
ElasticsearchIndexName
string
NonNegativeIntegerObject
integer
NoEncryptionConfig
string
HttpEndpointBufferingIntervalInSeconds
integer
HttpEndpointName
string
BooleanObject
boolean
ProcessorParameterValue
string
ContentEncoding
string
AmazonOpenSearchServerlessBufferingIntervalInSeconds
integer
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
AmazonopensearchserviceClusterEndpoint
string
AmazonopensearchserviceIndexRotationPeriod
string
ElasticsearchTypeName
string
AmazonOpenSearchServerlessS3BackupMode
string
AmazonopensearchserviceRetryDurationInSeconds
integer
BlockSizeBytes
integer
DeliveryStreamFailureType
string
ParquetCompression
string
AmazonOpenSearchServerlessIndexName
string
SplunkRetryDurationInSeconds
integer
DestinationDescription
object
Describes the destination for a delivery stream.
9 properties
1 required
ParquetWriterVersion
string
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from AWS Kinesis 12
Other APIs AWS Kinesis publishes across the network.
Amazon Managed Service for Apache Flink API
AWS Kinesis CreateSignalingChannel API
AWS Kinesis CreateStream API
AWS Kinesis DeleteSignalingChannel API
AWS Kinesis DeleteStream API
AWS Kinesis DescribeEdgeConfiguration API
AWS Kinesis DescribeImageGenerationConfiguration API
AWS Kinesis DescribeMappedResourceConfiguration API
AWS Kinesis DescribeMediaStorageConfiguration API
AWS Kinesis DescribeNotificationConfiguration API
AWS Kinesis DescribeSignalingChannel API
AWS Kinesis DescribeStream API
##X Amz Target=Firehose 20150804.DescribeDeliveryStream