Package-level declarations
Types
Describes the buffering to perform before delivering data to the Serverless offering for Amazon OpenSearch Service destination.
Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.
The destination description in the Serverless offering for Amazon OpenSearch Service.
Describes an update for a destination in the Serverless offering for Amazon OpenSearch Service.
Configures retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.
Describes the buffering to perform before delivering data to the Amazon OpenSearch Service destination.
Describes the configuration of a destination in Amazon OpenSearch Service
The destination description in Amazon OpenSearch Service.
Describes an update for a destination in Amazon OpenSearch Service.
Configures retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service.
The authentication configuration of the Amazon MSK cluster.
Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore 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 containers where the destination Apache Iceberg Tables are persisted.
Describes the Amazon CloudWatch logging options for your Firehose stream.
Another modification has already happened. Fetch VersionId
again and use it to update the destination.
Describes a COPY
command for Amazon Redshift.
The structure used to configure the list of column patterns in source database endpoint for Firehose to read from.
The structure used to configure the list of database patterns in source database endpoint for Firehose to read from.
The structure that describes the snapshot information of a table in source database endpoint that Firehose reads.
The structure to configure the authentication methods for Firehose to connect to source database endpoint.
The top level object for configuring streams with database as a source.
The top level object for database source description.
The structure for details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.
The structure used to configure the list of table patterns in source database endpoint for Firehose to read from.
Specifies that you want Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. Firehose uses the serializer and deserializer that you specify, in addition to the column information from the Amazon Web Services Glue table, to deserialize your input data from JSON and then serialize it to the Parquet or ORC format. For more information, see Firehose Record Format Conversion.
Contains information about a Firehose 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 Firehose to use for converting the input data from JSON. Firehose then serializes the data to its final format using the Serializer. Firehose supports two types of deserializers: the Apache Hive JSON SerDe and the OpenX JSON SerDe.
Describes the destination for a Firehose stream.
Describes the configuration of a destination in Apache Iceberg Tables.
The structure that configures parameters such as ThroughputHintInMBs
for a stream configured with Direct PUT as a source.
The structure that configures parameters such as ThroughputHintInMBs
for a stream configured with Direct PUT as a source.
Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.
Describes the buffering to perform before delivering data to the Amazon OpenSearch Service destination.
Describes the configuration of a destination in Amazon OpenSearch Service.
The destination description in Amazon OpenSearch Service.
Describes an update for a destination in Amazon OpenSearch Service.
Configures retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service.
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.
Base class for all service related exceptions thrown by the Firehose client
The native Hive / HCatalog JsonSerDe. Used by 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. 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 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 destination configure settings for Apache Iceberg Table.
Describes a destination in Apache Iceberg Tables.
Describes an update for a destination in Apache Iceberg Tables.
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.
The specified input parameter has a value that is not valid.
Firehose throws this exception when an attempt to put records or to start or stop Firehose stream encryption fails. This happens when the KMS service throws one of the following exception types: AccessDeniedException
, InvalidStateException
, DisabledException
, or NotFoundException
.
Only requests from CloudWatch Logs are supported when CloudWatch Logs decompression is enabled.
The stream and role Amazon Resource Names (ARNs) for a Kinesis data stream used as the source for a Firehose stream.
Details about a Kinesis data stream used as the source for a Firehose stream.
Describes an encryption key for a destination in Amazon S3.
You have already reached the limit for a requested resource.
The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.
Details about the Amazon MSK cluster used as the source for a Firehose stream.
The OpenX SerDe. Used by 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 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.
Represents a single field in a PartitionSpec
.
Represents how to produce partition data for a table. Partition data is produced by transforming columns in a table. Each column transform is represented by a named PartitionField
.
Describes a data processing configuration.
Describes the processor parameter.
Contains the result for an individual record from a PutRecordBatch request. If the record is successfully added to your Firehose stream, it receives a record ID. If the record fails to be added to your Firehose stream, the result includes an error code and an error message.
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 Firehose is unable to deliver documents to Amazon Redshift.
The resource is already in use and not available for this operation.
The specified resource could not be found.
The retry behavior in case Firehose is unable to deliver data to a destination.
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 Firehose to configure your data before it writes it to Amazon S3. This parameter is required if Enabled
is set to true.
The configuration to enable schema evolution.
The structure that defines how Firehose accesses the secret.
The serializer that you want Firehose to use to convert data to the target format before writing it to Amazon S3. Firehose supports two types of serializers: the ORC SerDe and the Parquet SerDe.
The service is unavailable. Back off and retry the operation. If you continue to see the exception, throughput limits for the Firehose stream may have been exceeded. For more information about limits and how to request an increase, see Amazon Firehose Limits.
Describes the buffering to perform before delivering data to the Snowflake destination. If you do not specify any value, Firehose uses the default values.
Configure Snowflake destination
Optional Snowflake destination description
Update to configuration settings
Specify how long Firehose retries sending data to the New Relic HTTP endpoint. After sending data, Firehose first waits for an acknowledgment from the HTTP endpoint. If an error occurs or the acknowledgment doesn’t arrive within the acknowledgment timeout period, Firehose starts the retry duration counter. It keeps retrying until the retry duration expires. After that, Firehose considers it a data delivery failure and backs up the data to your Amazon S3 bucket. Every time that Firehose sends data to the HTTP endpoint (either the initial attempt or a retry), it restarts the acknowledgement timeout counter and waits for an acknowledgement from the HTTP endpoint. Even if the retry duration expires, Firehose still waits for the acknowledgment until it receives it or the acknowledgement timeout period is reached. If the acknowledgment times out, Firehose determines whether there's time left in the retry counter. If there is time left, it retries again and repeats the logic until it receives an acknowledgment or determines that the retry time has expired. If you don't want Firehose to retry sending data, set this value to 0.
Optionally configure a Snowflake role. Otherwise the default user role will be used.
Configure a Snowflake VPC
Details about a Kinesis data stream used as the source for a Firehose stream.
The buffering options. If no value is specified, the default values for Splunk are used.
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 Firehose is unable to deliver documents to Splunk, or if it doesn't receive an acknowledgment from Splunk.
The configuration to enable automatic table creation.
The details of the VPC of the Amazon OpenSearch or Amazon OpenSearch Serverless destination.
The details of the VPC of the Amazon OpenSearch Service destination.