Package-level declarations

Types

Link copied to clipboard

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.

Link copied to clipboard

Configures retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.

Link copied to clipboard

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.

Link copied to clipboard

Describes an update for a destination in Amazon OpenSearch Service.

Link copied to clipboard

Configures retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service.

Link copied to clipboard

The authentication configuration of the Amazon MSK cluster.

Link copied to clipboard

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.

Link copied to clipboard

Describes the containers where the destination Apache Iceberg Tables are persisted.

Link copied to clipboard

Describes the Amazon CloudWatch logging options for your Firehose stream.

Link copied to clipboard
sealed class CompressionFormat
Link copied to clipboard

Another modification has already happened. Fetch VersionId again and use it to update the destination.

Link copied to clipboard
sealed class Connectivity
Link copied to clipboard
sealed class ContentEncoding
Link copied to clipboard

Describes a COPY command for Amazon Redshift.

Link copied to clipboard

The structure used to configure the list of column patterns in source database endpoint for Firehose to read from.

Link copied to clipboard

The structure used to configure the list of database patterns in source database endpoint for Firehose to read from.

Link copied to clipboard

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.

Link copied to clipboard

The top level object for configuring streams with database as a source.

Link copied to clipboard

The top level object for database source description.

Link copied to clipboard

The structure for details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.

Link copied to clipboard

The structure used to configure the list of table patterns in source database endpoint for Firehose to read from.

Link copied to clipboard
sealed class DatabaseType
Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard

Contains information about a Firehose stream.

Link copied to clipboard

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).

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class DeliveryStreamType
Link copied to clipboard

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.

Link copied to clipboard

Describes the destination for a Firehose stream.

Link copied to clipboard

Describes the configuration of a destination in Apache Iceberg Tables.

Link copied to clipboard

The structure that configures parameters such as ThroughputHintInMBs for a stream configured with Direct PUT as a source.

Link copied to clipboard

The structure that configures parameters such as ThroughputHintInMBs for a stream configured with Direct PUT as a source.

Link copied to clipboard

Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.

Link copied to clipboard

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.

Link copied to clipboard

Describes the buffering to perform before delivering data to the Amazon OpenSearch Service destination.

Link copied to clipboard

Describes the configuration of a destination in Amazon OpenSearch Service.

Link copied to clipboard

The destination description in Amazon OpenSearch Service.

Link copied to clipboard

Describes an update for a destination in Amazon OpenSearch Service.

Link copied to clipboard

Configures retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service.

Link copied to clipboard
Link copied to clipboard

Describes the encryption for a destination in Amazon S3.

Link copied to clipboard

Describes the configuration of a destination in Amazon S3.

Link copied to clipboard

Describes a destination in Amazon S3.

Link copied to clipboard

Describes an update for a destination in Amazon S3.

Link copied to clipboard

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

Link copied to clipboard

Base class for all service related exceptions thrown by the Firehose client

Link copied to clipboard
sealed class HecEndpointType
Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Describes the HTTP endpoint selected as the destination.

Link copied to clipboard

Describes the configuration of the HTTP endpoint destination.

Link copied to clipboard

Describes the HTTP endpoint destination.

Link copied to clipboard

Updates the specified HTTP endpoint destination.

Link copied to clipboard

The configuration of the HTTP endpoint request.

Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard

Specifies the destination configure settings for Apache Iceberg Table.

Link copied to clipboard

Describes a destination in Apache Iceberg Tables.

Link copied to clipboard

Describes an update for a destination in Apache Iceberg Tables.

Link copied to clipboard
sealed class IcebergS3BackupMode
Link copied to clipboard

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.

Link copied to clipboard

The specified input parameter has a value that is not valid.

Link copied to clipboard

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.

Link copied to clipboard

Only requests from CloudWatch Logs are supported when CloudWatch Logs decompression is enabled.

Link copied to clipboard
sealed class KeyType
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Describes an encryption key for a destination in Amazon S3.

Link copied to clipboard

You have already reached the limit for a requested resource.

Link copied to clipboard

The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.

Link copied to clipboard

Details about the Amazon MSK cluster used as the source for a Firehose stream.

Link copied to clipboard
sealed class NoEncryptionConfig
Link copied to clipboard

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.

Link copied to clipboard
sealed class OrcCompression
Link copied to clipboard
sealed class OrcFormatVersion
Link copied to clipboard
class OrcSerDe

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

Link copied to clipboard

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.

Link copied to clipboard
sealed class ParquetCompression
Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

Represents a single field in a PartitionSpec.

Link copied to clipboard

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.

Link copied to clipboard

Describes a data processing configuration.

Link copied to clipboard
class Processor

Describes a data processor.

Link copied to clipboard

Describes the processor parameter.

Link copied to clipboard
Link copied to clipboard
sealed class ProcessorType
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class Record

The unit of data in a Firehose stream.

Link copied to clipboard

Describes the configuration of a destination in Amazon Redshift.

Link copied to clipboard

Describes a destination in Amazon Redshift.

Link copied to clipboard

Describes an update for a destination in Amazon Redshift.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

The resource is already in use and not available for this operation.

Link copied to clipboard

The specified resource could not be found.

Link copied to clipboard

The retry behavior in case Firehose is unable to deliver data to a destination.

Link copied to clipboard
sealed class S3BackupMode
Link copied to clipboard

Describes the configuration of a destination in Amazon S3.

Link copied to clipboard

Describes a destination in Amazon S3.

Link copied to clipboard

Describes an update for a destination in Amazon S3.

Link copied to clipboard

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.

Link copied to clipboard

The configuration to enable schema evolution.

Link copied to clipboard

The structure that defines how Firehose accesses the secret.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
sealed class SnapshotRequestedBy
Link copied to clipboard
sealed class SnapshotStatus
Link copied to clipboard

Describes the buffering to perform before delivering data to the Snowflake destination. If you do not specify any value, Firehose uses the default values.

Link copied to clipboard
Link copied to clipboard

Configure Snowflake destination

Link copied to clipboard

Optional Snowflake destination description

Link copied to clipboard

Update to configuration settings

Link copied to clipboard

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.

Link copied to clipboard

Optionally configure a Snowflake role. Otherwise the default user role will be used.

Link copied to clipboard
Link copied to clipboard

Configure a Snowflake VPC

Link copied to clipboard

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

Link copied to clipboard

The buffering options. If no value is specified, the default values for Splunk are used.

Link copied to clipboard

Describes the configuration of a destination in Splunk.

Link copied to clipboard

Describes a destination in Splunk.

Link copied to clipboard

Describes an update for a destination in Splunk.

Link copied to clipboard

Configures retry behavior in case Firehose is unable to deliver documents to Splunk, or if it doesn't receive an acknowledgment from Splunk.

Link copied to clipboard
sealed class SplunkS3BackupMode
Link copied to clipboard
sealed class SslMode
Link copied to clipboard

The configuration to enable automatic table creation.

Link copied to clipboard
class Tag

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The details of the VPC of the Amazon OpenSearch or Amazon OpenSearch Serverless destination.

Link copied to clipboard

The details of the VPC of the Amazon OpenSearch Service destination.