logo
Expand description

Amazon Kinesis Data Firehose API Reference

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 Elasticsearch Service (Amazon ES), Amazon Redshift, and Splunk.

If you’re using the service, you’re probably looking for KinesisFirehoseClient and KinesisFirehose.

Structs

Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Kinesis Data Firehose might choose to use different values when it is optimal. The SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a value for one of them, you must also provide a value for the other.

Describes the Amazon CloudWatch logging options for your delivery stream.

Describes a COPY command for Amazon Redshift.

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 Firehose uses the serializer and deserializer that you specify, in addition to the column information from the AWS Glue table, to deserialize your input data from JSON and then serialize it to the Parquet or ORC format. For more information, see Kinesis Data Firehose Record Format Conversion.

Contains information about a delivery stream.

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. You can get DeliveryStreamEncryptionConfiguration by invoking the DescribeDeliveryStream operation.

Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).

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 format using the Serializer. Kinesis Data Firehose supports two types of deserializers: the Apache Hive JSON SerDe and the OpenX JSON SerDe.

Describes the destination for a delivery stream.

Describes the buffering to perform before delivering data to the Amazon ES destination.

Describes the configuration of a destination in Amazon ES.

The destination description in Amazon ES.

Describes an update for a destination in Amazon ES.

Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES.

Describes the encryption for a destination in Amazon S3.

Describes the configuration of a destination in Amazon S3.

Describes a destination in Amazon S3.

Describes an update for a destination in Amazon S3.

Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

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.

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 SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a value for one of them, you must also provide a value for the other.

Describes the metadata that's delivered to the specified HTTP endpoint destination.

Describes the configuration of the HTTP endpoint to which Kinesis Firehose delivers data.

Describes the HTTP endpoint selected as the destination.

Describes the configuration of the HTTP endpoint destination.

Describes the HTTP endpoint destination.

Updates the specified HTTP endpoint destination.

The configuration of the HTTP endpoint request.

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 valid acknowledgment of receipt from the specified HTTP endpoint destination.

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.

Describes an encryption key for a destination in Amazon S3.

A client for the Firehose API.

The stream and role Amazon Resource Names (ARNs) for a Kinesis data stream used as the source for a delivery stream.

Details about a Kinesis data stream used as the source for a Kinesis Data Firehose delivery stream.

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 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 native Hive / HCatalog JsonSerDe.

A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC.

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 Enabled is set to true.

A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet.

Describes a data processing configuration.

Describes a data processor.

Describes the processor parameter.

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 ID. If the record fails to be added to your delivery stream, the result includes an error code and an error message.

The unit of data in a delivery stream.

Describes the configuration of a destination in Amazon Redshift.

Describes a destination in Amazon Redshift.

Describes an update for a destination in Amazon Redshift.

Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift.

Describes the configuration of a destination in Amazon S3.

Describes a destination in Amazon S3.

Describes an update for a destination in Amazon S3.

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 set to true.

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 two types of serializers: the ORC SerDe and the Parquet SerDe.

Details about a Kinesis data stream used as the source for a Kinesis Data Firehose delivery stream.

Describes the configuration of a destination in Splunk.

Describes a destination in Splunk.

Describes an update for a destination in Splunk.

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.

Metadata that you can assign to a delivery stream, consisting of a key-value pair.

The details of the VPC of the Amazon ES destination.

The details of the VPC of the Amazon ES destination.

Enums

Errors returned by CreateDeliveryStream

Errors returned by DeleteDeliveryStream

Errors returned by DescribeDeliveryStream

Errors returned by ListDeliveryStreams

Errors returned by ListTagsForDeliveryStream

Errors returned by PutRecordBatch

Errors returned by PutRecord

Errors returned by StartDeliveryStreamEncryption

Errors returned by StopDeliveryStreamEncryption

Errors returned by TagDeliveryStream

Errors returned by UntagDeliveryStream

Errors returned by UpdateDestination

Traits

Trait representing the capabilities of the Firehose API. Firehose clients implement this trait.