# Amazon Data Firehose API Reference

> Amazon 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 supported destinations.

- [Welcome](https://docs.aws.amazon.com/firehose/latest/APIReference/Welcome.md)
- [Common Error Types](https://docs.aws.amazon.com/firehose/latest/APIReference/CommonErrors.md)

## [Actions](https://docs.aws.amazon.com/firehose/latest/APIReference/API_Operations.md)

- [CreateDeliveryStream](https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.md): Creates a Firehose stream.
- [DeleteDeliveryStream](https://docs.aws.amazon.com/firehose/latest/APIReference/API_DeleteDeliveryStream.md): Deletes a Firehose stream and its data.
- [DescribeDeliveryStream](https://docs.aws.amazon.com/firehose/latest/APIReference/API_DescribeDeliveryStream.md): Describes the specified Firehose stream and its status.
- [ListDeliveryStreams](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ListDeliveryStreams.md): Lists your Firehose streams in alphabetical order of their names.
- [ListTagsForDeliveryStream](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ListTagsForDeliveryStream.md): Lists the tags for the specified Firehose stream.
- [PutRecord](https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecord.md): Writes a single data record into an Firehose stream.
- [PutRecordBatch](https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.md): Writes multiple data records into a Firehose stream in a single call, which can achieve higher throughput per producer than when writing single records.
- [StartDeliveryStreamEncryption](https://docs.aws.amazon.com/firehose/latest/APIReference/API_StartDeliveryStreamEncryption.md): Enables server-side encryption (SSE) for the Firehose stream.
- [StopDeliveryStreamEncryption](https://docs.aws.amazon.com/firehose/latest/APIReference/API_StopDeliveryStreamEncryption.md): Disables server-side encryption (SSE) for the Firehose stream.
- [TagDeliveryStream](https://docs.aws.amazon.com/firehose/latest/APIReference/API_TagDeliveryStream.md): Adds or updates tags for the specified Firehose stream.
- [UntagDeliveryStream](https://docs.aws.amazon.com/firehose/latest/APIReference/API_UntagDeliveryStream.md): Removes tags from the specified Firehose stream.
- [UpdateDestination](https://docs.aws.amazon.com/firehose/latest/APIReference/API_UpdateDestination.md): Updates the specified destination of the specified Firehose stream.


## [Data Types](https://docs.aws.amazon.com/firehose/latest/APIReference/API_Types.md)

- [AmazonOpenSearchServerlessBufferingHints](https://docs.aws.amazon.com/firehose/latest/APIReference/API_AmazonOpenSearchServerlessBufferingHints.md): Describes the buffering to perform before delivering data to the Serverless offering for Amazon OpenSearch Service destination.
- [AmazonOpenSearchServerlessDestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_AmazonOpenSearchServerlessDestinationConfiguration.md): Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.
- [AmazonOpenSearchServerlessDestinationDescription](https://docs.aws.amazon.com/firehose/latest/APIReference/API_AmazonOpenSearchServerlessDestinationDescription.md): The destination description in the Serverless offering for Amazon OpenSearch Service.
- [AmazonOpenSearchServerlessDestinationUpdate](https://docs.aws.amazon.com/firehose/latest/APIReference/API_AmazonOpenSearchServerlessDestinationUpdate.md): Describes an update for a destination in the Serverless offering for Amazon OpenSearch Service.
- [AmazonOpenSearchServerlessRetryOptions](https://docs.aws.amazon.com/firehose/latest/APIReference/API_AmazonOpenSearchServerlessRetryOptions.md): Configures retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.
- [AmazonopensearchserviceBufferingHints](https://docs.aws.amazon.com/firehose/latest/APIReference/API_AmazonopensearchserviceBufferingHints.md): Describes the buffering to perform before delivering data to the Amazon OpenSearch Service destination.
- [AmazonopensearchserviceDestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_AmazonopensearchserviceDestinationConfiguration.md): Describes the configuration of a destination in Amazon OpenSearch Service
- [AmazonopensearchserviceDestinationDescription](https://docs.aws.amazon.com/firehose/latest/APIReference/API_AmazonopensearchserviceDestinationDescription.md): The destination description in Amazon OpenSearch Service.
- [AmazonopensearchserviceDestinationUpdate](https://docs.aws.amazon.com/firehose/latest/APIReference/API_AmazonopensearchserviceDestinationUpdate.md): Describes an update for a destination in Amazon OpenSearch Service.
- [AmazonopensearchserviceRetryOptions](https://docs.aws.amazon.com/firehose/latest/APIReference/API_AmazonopensearchserviceRetryOptions.md): Configures retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service.
- [AuthenticationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_AuthenticationConfiguration.md): The authentication configuration of the Amazon MSK cluster.
- [BufferingHints](https://docs.aws.amazon.com/firehose/latest/APIReference/API_BufferingHints.md): Describes hints for the buffering to perform before delivering data to the destination.
- [CatalogConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_CatalogConfiguration.md): Describes the containers where the destination Apache Iceberg Tables are persisted.
- [CloudWatchLoggingOptions](https://docs.aws.amazon.com/firehose/latest/APIReference/API_CloudWatchLoggingOptions.md): Describes the Amazon CloudWatch logging options for your Firehose stream.
- [CopyCommand](https://docs.aws.amazon.com/firehose/latest/APIReference/API_CopyCommand.md): Describes a COPY command for Amazon Redshift.
- [DatabaseColumnList](https://docs.aws.amazon.com/firehose/latest/APIReference/API_DatabaseColumnList.md): The structure used to configure the list of column patterns in source database endpoint for Firehose to read from.
- [DatabaseList](https://docs.aws.amazon.com/firehose/latest/APIReference/API_DatabaseList.md): The structure used to configure the list of database patterns in source database endpoint for Firehose to read from.
- [DatabaseSnapshotInfo](https://docs.aws.amazon.com/firehose/latest/APIReference/API_DatabaseSnapshotInfo.md): The structure that describes the snapshot information of a table in source database endpoint that Firehose reads.
- [DatabaseSourceAuthenticationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_DatabaseSourceAuthenticationConfiguration.md): The structure to configure the authentication methods for Firehose to connect to source database endpoint.
- [DatabaseSourceConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_DatabaseSourceConfiguration.md): The top level object for configuring streams with database as a source.
- [DatabaseSourceDescription](https://docs.aws.amazon.com/firehose/latest/APIReference/API_DatabaseSourceDescription.md): The top level object for database source description.
- [DatabaseSourceVPCConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_DatabaseSourceVPCConfiguration.md): The structure for details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.
- [DatabaseTableList](https://docs.aws.amazon.com/firehose/latest/APIReference/API_DatabaseTableList.md): The structure used to configure the list of table patterns in source database endpoint for Firehose to read from.
- [DataFormatConversionConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_DataFormatConversionConfiguration.md): Specifies that you want Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
- [DeliveryStreamDescription](https://docs.aws.amazon.com/firehose/latest/APIReference/API_DeliveryStreamDescription.md): Contains information about a Firehose stream.
- [DeliveryStreamEncryptionConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_DeliveryStreamEncryptionConfiguration.md): 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 the CMK.
- [DeliveryStreamEncryptionConfigurationInput](https://docs.aws.amazon.com/firehose/latest/APIReference/API_DeliveryStreamEncryptionConfigurationInput.md): Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
- [Deserializer](https://docs.aws.amazon.com/firehose/latest/APIReference/API_Deserializer.md): The deserializer you want Firehose to use for converting the input data from JSON.
- [DestinationDescription](https://docs.aws.amazon.com/firehose/latest/APIReference/API_DestinationDescription.md): Describes the destination for a Firehose stream.
- [DestinationTableConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_DestinationTableConfiguration.md): Describes the configuration of a destination in Apache Iceberg Tables.
- [DirectPutSourceConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_DirectPutSourceConfiguration.md): The structure that configures parameters such as ThroughputHintInMBs for a stream configured with Direct PUT as a source.
- [DirectPutSourceDescription](https://docs.aws.amazon.com/firehose/latest/APIReference/API_DirectPutSourceDescription.md): The structure that configures parameters such as ThroughputHintInMBs for a stream configured with Direct PUT as a source.
- [DocumentIdOptions](https://docs.aws.amazon.com/firehose/latest/APIReference/API_DocumentIdOptions.md): Indicates the method for setting up document ID.
- [DynamicPartitioningConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_DynamicPartitioningConfiguration.md): The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys.
- [ElasticsearchBufferingHints](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ElasticsearchBufferingHints.md): Describes the buffering to perform before delivering data to the Amazon OpenSearch Service destination.
- [ElasticsearchDestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ElasticsearchDestinationConfiguration.md): Describes the configuration of a destination in Amazon OpenSearch Service.
- [ElasticsearchDestinationDescription](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ElasticsearchDestinationDescription.md): The destination description in Amazon OpenSearch Service.
- [ElasticsearchDestinationUpdate](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ElasticsearchDestinationUpdate.md): Describes an update for a destination in Amazon OpenSearch Service.
- [ElasticsearchRetryOptions](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ElasticsearchRetryOptions.md): Configures retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service.
- [EncryptionConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_EncryptionConfiguration.md): Describes the encryption for a destination in Amazon S3.
- [ExtendedS3DestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ExtendedS3DestinationConfiguration.md): Describes the configuration of a destination in Amazon S3.
- [ExtendedS3DestinationDescription](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ExtendedS3DestinationDescription.md): Describes a destination in Amazon S3.
- [ExtendedS3DestinationUpdate](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ExtendedS3DestinationUpdate.md): Describes an update for a destination in Amazon S3.
- [FailureDescription](https://docs.aws.amazon.com/firehose/latest/APIReference/API_FailureDescription.md): Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
- [HiveJsonSerDe](https://docs.aws.amazon.com/firehose/latest/APIReference/API_HiveJsonSerDe.md): The native Hive / HCatalog JsonSerDe.
- [HttpEndpointBufferingHints](https://docs.aws.amazon.com/firehose/latest/APIReference/API_HttpEndpointBufferingHints.md): Describes the buffering options that can be applied before data is delivered to the HTTP endpoint destination.
- [HttpEndpointCommonAttribute](https://docs.aws.amazon.com/firehose/latest/APIReference/API_HttpEndpointCommonAttribute.md): Describes the metadata that's delivered to the specified HTTP endpoint destination.
- [HttpEndpointConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_HttpEndpointConfiguration.md): Describes the configuration of the HTTP endpoint to which Kinesis Firehose delivers data.
- [HttpEndpointDescription](https://docs.aws.amazon.com/firehose/latest/APIReference/API_HttpEndpointDescription.md): Describes the HTTP endpoint selected as the destination.
- [HttpEndpointDestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_HttpEndpointDestinationConfiguration.md): Describes the configuration of the HTTP endpoint destination.
- [HttpEndpointDestinationDescription](https://docs.aws.amazon.com/firehose/latest/APIReference/API_HttpEndpointDestinationDescription.md): Describes the HTTP endpoint destination.
- [HttpEndpointDestinationUpdate](https://docs.aws.amazon.com/firehose/latest/APIReference/API_HttpEndpointDestinationUpdate.md): Updates the specified HTTP endpoint destination.
- [HttpEndpointRequestConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_HttpEndpointRequestConfiguration.md): The configuration of the HTTP endpoint request.
- [HttpEndpointRetryOptions](https://docs.aws.amazon.com/firehose/latest/APIReference/API_HttpEndpointRetryOptions.md): Describes the retry behavior in case Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.
- [IcebergDestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_IcebergDestinationConfiguration.md): Specifies the destination configure settings for Apache Iceberg Table.
- [IcebergDestinationDescription](https://docs.aws.amazon.com/firehose/latest/APIReference/API_IcebergDestinationDescription.md): Describes a destination in Apache Iceberg Tables.
- [IcebergDestinationUpdate](https://docs.aws.amazon.com/firehose/latest/APIReference/API_IcebergDestinationUpdate.md): Describes an update for a destination in Apache Iceberg Tables.
- [InputFormatConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_InputFormatConfiguration.md): Specifies the deserializer you want to use to convert the format of the input data.
- [KinesisStreamSourceConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_KinesisStreamSourceConfiguration.md): The stream and role Amazon Resource Names (ARNs) for a Kinesis data stream used as the source for a Firehose stream.
- [KinesisStreamSourceDescription](https://docs.aws.amazon.com/firehose/latest/APIReference/API_KinesisStreamSourceDescription.md): Details about a Kinesis data stream used as the source for a Firehose stream.
- [KMSEncryptionConfig](https://docs.aws.amazon.com/firehose/latest/APIReference/API_KMSEncryptionConfig.md): Describes an encryption key for a destination in Amazon S3.
- [MSKSourceConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_MSKSourceConfiguration.md): The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.
- [MSKSourceDescription](https://docs.aws.amazon.com/firehose/latest/APIReference/API_MSKSourceDescription.md): Details about the Amazon MSK cluster used as the source for a Firehose stream.
- [OpenXJsonSerDe](https://docs.aws.amazon.com/firehose/latest/APIReference/API_OpenXJsonSerDe.md): The OpenX SerDe.
- [OrcSerDe](https://docs.aws.amazon.com/firehose/latest/APIReference/API_OrcSerDe.md): A serializer to use for converting data to the ORC format before storing it in Amazon S3.
- [OutputFormatConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_OutputFormatConfiguration.md): Specifies the serializer that you want Firehose to use to convert the format of your data before it writes it to Amazon S3.
- [ParquetSerDe](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ParquetSerDe.md): A serializer to use for converting data to the Parquet format before storing it in Amazon S3.
- [PartitionField](https://docs.aws.amazon.com/firehose/latest/APIReference/API_PartitionField.md): Represents a single field in a PartitionSpec.
- [PartitionSpec](https://docs.aws.amazon.com/firehose/latest/APIReference/API_PartitionSpec.md): Represents how to produce partition data for a table.
- [ProcessingConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ProcessingConfiguration.md): Describes a data processing configuration.
- [Processor](https://docs.aws.amazon.com/firehose/latest/APIReference/API_Processor.md): Describes a data processor.
- [ProcessorParameter](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ProcessorParameter.md): Describes the processor parameter.
- [PutRecordBatchResponseEntry](https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatchResponseEntry.md): Contains the result for an individual record from a PutRecordBatch request.
- [Record](https://docs.aws.amazon.com/firehose/latest/APIReference/API_Record.md): The unit of data in a Firehose stream.
- [RedshiftDestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_RedshiftDestinationConfiguration.md): Describes the configuration of a destination in Amazon Redshift.
- [RedshiftDestinationDescription](https://docs.aws.amazon.com/firehose/latest/APIReference/API_RedshiftDestinationDescription.md): Describes a destination in Amazon Redshift.
- [RedshiftDestinationUpdate](https://docs.aws.amazon.com/firehose/latest/APIReference/API_RedshiftDestinationUpdate.md): Describes an update for a destination in Amazon Redshift.
- [RedshiftRetryOptions](https://docs.aws.amazon.com/firehose/latest/APIReference/API_RedshiftRetryOptions.md): Configures retry behavior in case Firehose is unable to deliver documents to Amazon Redshift.
- [RetryOptions](https://docs.aws.amazon.com/firehose/latest/APIReference/API_RetryOptions.md): The retry behavior in case Firehose is unable to deliver data to a destination.
- [S3DestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_S3DestinationConfiguration.md): Describes the configuration of a destination in Amazon S3.
- [S3DestinationDescription](https://docs.aws.amazon.com/firehose/latest/APIReference/API_S3DestinationDescription.md): Describes a destination in Amazon S3.
- [S3DestinationUpdate](https://docs.aws.amazon.com/firehose/latest/APIReference/API_S3DestinationUpdate.md): Describes an update for a destination in Amazon S3.
- [SchemaConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_SchemaConfiguration.md): Specifies the schema to which you want Firehose to configure your data before it writes it to Amazon S3.
- [SchemaEvolutionConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_SchemaEvolutionConfiguration.md): The configuration to enable schema evolution.
- [SecretsManagerConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_SecretsManagerConfiguration.md): The structure that defines how Firehose accesses the secret.
- [Serializer](https://docs.aws.amazon.com/firehose/latest/APIReference/API_Serializer.md): The serializer that you want Firehose to use to convert data to the target format before writing it to Amazon S3.
- [SnowflakeBufferingHints](https://docs.aws.amazon.com/firehose/latest/APIReference/API_SnowflakeBufferingHints.md): Describes the buffering to perform before delivering data to the Snowflake destination.
- [SnowflakeDestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_SnowflakeDestinationConfiguration.md): Configure Snowflake destination
- [SnowflakeDestinationDescription](https://docs.aws.amazon.com/firehose/latest/APIReference/API_SnowflakeDestinationDescription.md): Optional Snowflake destination description
- [SnowflakeDestinationUpdate](https://docs.aws.amazon.com/firehose/latest/APIReference/API_SnowflakeDestinationUpdate.md): Update to configuration settings
- [SnowflakeRetryOptions](https://docs.aws.amazon.com/firehose/latest/APIReference/API_SnowflakeRetryOptions.md): Specify how long Firehose retries sending data to the New Relic HTTP endpoint.
- [SnowflakeRoleConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_SnowflakeRoleConfiguration.md): Optionally configure a Snowflake role.
- [SnowflakeVpcConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_SnowflakeVpcConfiguration.md): Configure a Snowflake VPC
- [SourceDescription](https://docs.aws.amazon.com/firehose/latest/APIReference/API_SourceDescription.md): Details about a Kinesis data stream used as the source for a Firehose stream.
- [SplunkBufferingHints](https://docs.aws.amazon.com/firehose/latest/APIReference/API_SplunkBufferingHints.md): The buffering options.
- [SplunkDestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_SplunkDestinationConfiguration.md): Describes the configuration of a destination in Splunk.
- [SplunkDestinationDescription](https://docs.aws.amazon.com/firehose/latest/APIReference/API_SplunkDestinationDescription.md): Describes a destination in Splunk.
- [SplunkDestinationUpdate](https://docs.aws.amazon.com/firehose/latest/APIReference/API_SplunkDestinationUpdate.md): Describes an update for a destination in Splunk.
- [SplunkRetryOptions](https://docs.aws.amazon.com/firehose/latest/APIReference/API_SplunkRetryOptions.md): Configures retry behavior in case Firehose is unable to deliver documents to Splunk, or if it doesn't receive an acknowledgment from Splunk.
- [TableCreationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_TableCreationConfiguration.md): The configuration to enable automatic table creation.
- [Tag](https://docs.aws.amazon.com/firehose/latest/APIReference/API_Tag.md): Metadata that you can assign to a Firehose stream, consisting of a key-value pair.
- [VpcConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_VpcConfiguration.md): The details of the VPC of the Amazon OpenSearch or Amazon OpenSearch Serverless destination.
- [VpcConfigurationDescription](https://docs.aws.amazon.com/firehose/latest/APIReference/API_VpcConfigurationDescription.md): The details of the VPC of the Amazon OpenSearch Service destination.


## Full content

The entire guide is also available as a single markdown file, useful for feeding the full guide to an LLM in one pass:

- [Complete guide (single file)](https://docs.aws.amazon.com/firehose/latest/APIReference/full.md)