AWS Kinesis Amazon Kinesis Firehose API
The Amazon Kinesis Firehose API from AWS Kinesis — 12 operation(s) for amazon kinesis firehose.
AWS Kinesis Amazon Kinesis Firehose API is one of 32 APIs that AWS Kinesis publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Amazon Kinesis Firehose. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, pricing, and a getting-started guide.
This API exposes 12 operations across 12 paths, and defines 215 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.
12 operations
12 paths
215 schemas
12 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
AWS Kinesis Amazon Kinesis Firehose 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 12
Across 12 paths, the API surfaces 12 operations — 12 POST. Each is listed below with its method, path, parameters, and response codes.
Amazon Kinesis Firehose 12
POST
/#X-Amz-Target=Firehose_20150804.CreateDeliveryStream
Create delivery stream
POST
/#X-Amz-Target=Firehose_20150804.DeleteDeliveryStream
Delete delivery stream
POST
/#X-Amz-Target=Firehose_20150804.DescribeDeliveryStream
Describe delivery stream
POST
/#X-Amz-Target=Firehose_20150804.ListDeliveryStreams
List delivery streams
POST
/#X-Amz-Target=Firehose_20150804.ListTagsForDeliveryStream
List tags for delivery stream
POST
/#X-Amz-Target=Firehose_20150804.PutRecord
Put record
POST
/#X-Amz-Target=Firehose_20150804.PutRecordBatch
Put record batch
POST
/#X-Amz-Target=Firehose_20150804.StartDeliveryStreamEncryption
Start delivery stream encryption
POST
/#X-Amz-Target=Firehose_20150804.StopDeliveryStreamEncryption
Stop delivery stream encryption
POST
/#X-Amz-Target=Firehose_20150804.TagDeliveryStream
Tag delivery stream
POST
/#X-Amz-Target=Firehose_20150804.UntagDeliveryStream
Untag delivery stream
POST
/#X-Amz-Target=Firehose_20150804.UpdateDestination
Update destination
Schemas 215
The contract defines 215 schemas that model the data the API accepts and returns. The most detailed are ExtendedS3DestinationDescription (13 properties), ElasticsearchDestinationDescription (13 properties), AmazonopensearchserviceDestinationDescription (13 properties), CreateDeliveryStreamInput (13 properties). Each schema is shown below with its type and property counts.
KinesisStreamARN
string
ElasticsearchS3BackupMode
string
ListTagsForDeliveryStreamInputLimit
integer
S3BackupMode
string
ExtendedS3DestinationConfiguration
object
Describes the configuration of a destination in Amazon S3.
13 properties
2 required
DestinationId
string
ProcessorType
string
DeliveryStreamNameList
array
HttpEndpointRetryDurationInSeconds
integer
ProcessorParameterValue
string
KinesisStreamSourceConfiguration
object
The stream and role Amazon Resource Names (ARNs) for a Kinesis data stream used as the source for a delivery stream.
2 properties
2 required
ListTagsForDeliveryStreamOutputTagList
array
DataTableColumns
string
StartDeliveryStreamEncryptionInput
object
2 properties
1 required
S3DestinationDescription
object
Describes a destination in Amazon S3.
8 properties
5 required
HttpEndpointAttributeName
string
HttpEndpointConfiguration
object
Describes the configuration of the HTTP endpoint to which Kinesis Firehose delivers data.
3 properties
1 required
ResourceInUseException
AmazonopensearchserviceDestinationConfiguration
object
Describes the configuration of a destination in Amazon OpenSearch Service
13 properties
3 required
ParquetPageSizeBytes
integer
DeliveryStreamEncryptionConfigurationInput
object
Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
2 properties
1 required
HttpEndpointName
string
Username
string
Tag
object
Metadata that you can assign to a delivery stream, consisting of a key-value pair.
2 properties
1 required
ElasticsearchDestinationUpdate
object
Describes an update for a destination in Amazon ES.
11 properties
PutRecordBatchInput
object
2 properties
2 required
TagDeliveryStreamInput
object
2 properties
2 required
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
PutRecordOutput
object
2 properties
1 required
ListOfNonEmptyStringsWithoutWhitespace
array
EncryptionConfiguration
object
Describes the encryption for a destination in Amazon S3.
2 properties
DeliveryStreamVersionId
string
OrcCompression
string
AmazonopensearchserviceIndexRotationPeriod
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
StopDeliveryStreamEncryptionOutput
object
LogGroupName
string
AWSKMSKeyARN
string
AmazonopensearchserviceRetryDurationInSeconds
integer
ElasticsearchClusterEndpoint
string
HttpEndpointAccessKey
string
TagValue
string
ProcessorParameterList
array
AmazonopensearchserviceDestinationDescription
object
The destination description in Amazon OpenSearch Service.
13 properties
HttpEndpointAttributeValue
string
ElasticsearchIndexName
string
HttpEndpointDescription
object
Describes the HTTP endpoint selected as the destination.
2 properties
SourceDescription
object
Details about a Kinesis data stream used as the source for a Kinesis Data Firehose delivery stream.
1 property
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
HttpEndpointCommonAttributesList
array
ElasticsearchIndexRotationPeriod
string
PutRecordBatchOutput
object
3 properties
2 required
ColumnToJsonKeyMappings
object
BlockSizeBytes
integer
Proportion
number
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
AmazonopensearchserviceTypeName
string
AmazonopensearchserviceBufferingHints
object
Describes the buffering to perform before delivering data to the Amazon OpenSearch Service destination.
2 properties
Record
object
The unit of data in a delivery stream.
1 property
1 required
ParquetWriterVersion
string
VpcConfigurationDescription
object
The details of the VPC of the Amazon ES destination.
4 properties
4 required
AmazonopensearchserviceS3BackupMode
string
AmazonOpenSearchServerlessRetryDurationInSeconds
integer
Prefix
string
SecurityGroupIdList
array
CreateDeliveryStreamOutput
object
1 property
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
DeliveryStreamEncryptionStatus
string
NoEncryptionConfig
string
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
UpdateDestinationInput
object
11 properties
3 required
HttpEndpointUrl
string
KeyType
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
Password
string
HttpEndpointCommonAttribute
object
Describes the metadata that's delivered to the specified HTTP endpoint destination.
2 properties
2 required
S3DestinationUpdate
object
Describes an update for a destination in Amazon S3.
8 properties
SubnetIdList
array
CopyOptions
string
BucketARN
string
ElasticsearchDestinationDescription
object
The destination description in Amazon ES.
13 properties
ListOfNonEmptyStrings
array
DescribeDeliveryStreamInput
object
3 properties
1 required
OrcFormatVersion
string
HttpEndpointBufferingSizeInMBs
integer
HttpEndpointRequestConfiguration
object
The configuration of the HTTP endpoint request.
2 properties
ListTagsForDeliveryStreamInput
object
3 properties
1 required
ErrorOutputPrefix
string
AmazonOpenSearchServerlessIndexName
string
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
RedshiftRetryDurationInSeconds
integer
AmazonopensearchserviceDestinationUpdate
object
Describes an update for a destination in Amazon OpenSearch Service.
11 properties
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
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
BooleanObject
boolean
SplunkDestinationConfiguration
object
Describes the configuration of a destination in Splunk.
9 properties
4 required
DestinationDescriptionList
array
ResourceNotFoundException
InvalidArgumentException
RetryOptions
object
The retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon S3 prefix.
1 property
CreateDeliveryStreamInput
object
13 properties
1 required
ElasticsearchDestinationConfiguration
object
Describes the configuration of a destination in Amazon ES.
13 properties
3 required
ElasticsearchDomainARN
string
UntagDeliveryStreamOutput
object
HttpEndpointDestinationDescription
object
Describes the HTTP endpoint destination.
9 properties
ErrorCode
string
AmazonOpenSearchServerlessS3BackupMode
string
NonEmptyStringWithoutWhitespace
string
TagDeliveryStreamInputTagList
array
Processor
object
Describes a data processor.
2 properties
1 required
ElasticsearchRetryDurationInSeconds
integer
SplunkS3BackupMode
string
ProcessingConfiguration
object
Describes a data processing configuration.
2 properties
TagKey
string
AmazonopensearchserviceBufferingIntervalInSeconds
integer
HttpEndpointBufferingIntervalInSeconds
integer
AmazonOpenSearchServerlessDestinationDescription
object
The destination description in the Serverless offering for Amazon OpenSearch Service.
10 properties
VpcConfiguration
object
The details of the VPC of the Amazon ES destination.
3 properties
3 required
HECEndpointType
string
ParquetCompression
string
DeliveryStreamStatus
string
TagDeliveryStreamOutput
object
RetryDurationInSeconds
integer
DeliveryStreamFailureType
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
ErrorMessage
string
IntervalInSeconds
integer
DescribeDeliveryStreamInputLimit
integer
UpdateDestinationOutput
object
ListDeliveryStreamsOutput
object
2 properties
2 required
ProcessorList
array
SplunkDestinationUpdate
object
Describes an update for a destination in Splunk.
9 properties
StopDeliveryStreamEncryptionInput
object
1 property
1 required
DescribeDeliveryStreamOutput
object
1 property
1 required
AmazonopensearchserviceDomainARN
string
TagKeyList
array
ClusterJDBCURL
string
ElasticsearchBufferingIntervalInSeconds
integer
Data
string
KMSEncryptionConfig
object
Describes an encryption key for a destination in Amazon S3.
1 property
1 required
ExtendedS3DestinationDescription
object
Describes a destination in Amazon S3.
13 properties
5 required
AmazonOpenSearchServerlessBufferingIntervalInSeconds
integer
ExtendedS3DestinationUpdate
object
Describes an update for a destination in Amazon S3.
13 properties
HttpEndpointDestinationConfiguration
object
Describes the configuration of the HTTP endpoint destination.
9 properties
2 required
ListTagsForDeliveryStreamOutput
object
2 properties
2 required
ConcurrentModificationException
RedshiftDestinationUpdate
object
Describes an update for a destination in Amazon Redshift.
11 properties
HECAcknowledgmentTimeoutInSeconds
integer
SizeInMBs
integer
Timestamp
string
AmazonopensearchserviceBufferingSizeInMBs
integer
PutRecordBatchResponseEntry
object
Contains the result for an individual record from a PutRecordBatch request. If the record is successfully added to your delivery stream, it receives a record I…
3 properties
LimitExceededException
ServiceUnavailableException
ElasticsearchBufferingSizeInMBs
integer
HttpEndpointDestinationUpdate
object
Updates the specified HTTP endpoint destination.
9 properties
DeliveryStreamName
string
InvalidKMSResourceException
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
RedshiftRetryOptions
object
Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift.
1 property
ElasticsearchRetryOptions
object
Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES.
1 property
CompressionFormat
string
OrcStripeSizeBytes
integer
PutRecordInput
object
2 properties
2 required
AmazonopensearchserviceIndexName
string
SplunkDestinationDescription
object
Describes a destination in Splunk.
9 properties
AmazonOpenSearchServerlessBufferingSizeInMBs
integer
AmazonOpenSearchServerlessDestinationConfiguration
object
Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.
10 properties
3 required
StartDeliveryStreamEncryptionOutput
object
ListDeliveryStreamsInput
object
3 properties
AmazonOpenSearchServerlessBufferingHints
object
Describes the buffering to perform before delivering data to the Serverless offering for Amazon OpenSearch Service destination.
2 properties
RedshiftDestinationDescription
object
Describes a destination in Amazon Redshift.
10 properties
5 required
UntagDeliveryStreamInput
object
2 properties
2 required
KinesisStreamSourceDescription
object
Details about a Kinesis data stream used as the source for a Kinesis Data Firehose delivery stream.
3 properties
ElasticsearchTypeName
string
AmazonOpenSearchServerlessCollectionEndpoint
string
DeleteDeliveryStreamInput
object
2 properties
1 required
ProcessorParameter
object
Describes the processor parameter.
2 properties
2 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
ElasticsearchBufferingHints
object
Describes the buffering to perform before delivering data to the Amazon ES destination.
2 properties
SplunkRetryDurationInSeconds
integer
DeliveryStartTimestamp
string
AmazonopensearchserviceClusterEndpoint
string
OrcRowIndexStride
integer
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
HttpEndpointS3BackupMode
string
LogStreamName
string
DataTableName
string
AmazonOpenSearchServerlessDestinationUpdate
object
Describes an update for a destination in the Serverless offering for Amazon OpenSearch Service.
8 properties
HECEndpoint
string
DeliveryStreamDescription
object
Contains information about a delivery stream.
12 properties
7 required
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
NonNegativeIntegerObject
integer
NonEmptyString
string
ContentEncoding
string
RoleARN
string
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
DeliveryStreamType
string
CopyCommand
object
Describes a COPY command for Amazon Redshift.
3 properties
1 required
PutRecordBatchRequestEntryList
array
S3DestinationConfiguration
object
Describes the configuration of a destination in Amazon S3.
8 properties
2 required
ProcessorParameterName
string
CloudWatchLoggingOptions
object
Describes the Amazon CloudWatch logging options for your delivery stream.
3 properties
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
HECToken
string
PutResponseRecordId
string
AmazonopensearchserviceRetryOptions
object
Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.
1 property
DeliveryStreamARN
string
RedshiftS3BackupMode
string
DeleteDeliveryStreamOutput
object
ListDeliveryStreamsInputLimit
integer
RedshiftDestinationConfiguration
object
Describes the configuration of a destination in Amazon Redshift.
11 properties
6 required
PutRecordBatchResponseEntryList
array
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
DestinationDescription
object
Describes the destination for a delivery stream.
9 properties
1 required
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 ListStreams API
AWS Kinesis Amazon Kinesis Analytics API
AWS Kinesis Amazon Kinesis API
AWS Kinesis Create Signaling Channel API
AWS Kinesis Create Stream API
AWS Kinesis Delete Signaling Channel API
AWS Kinesis Delete Stream API
AWS Kinesis Describe Edge Configuration API
AWS Kinesis Describe Image Generation Configuration API
AWS Kinesis Describe Mapped Resource Configuration API
AWS Kinesis Describe Media Storage Configuration API
#Amazon Kinesis Firehose
Where this information came from
This is an independent, third-party profile of AWS Kinesis Amazon Kinesis Firehose API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.