# Packages
Package firehoseiface provides an interface to enable mocking the Amazon Kinesis Firehose service client for testing your code.
# Functions
AmazonOpenSearchServerlessS3BackupMode_Values returns all elements of the AmazonOpenSearchServerlessS3BackupMode enum.
AmazonopensearchserviceIndexRotationPeriod_Values returns all elements of the AmazonopensearchserviceIndexRotationPeriod enum.
AmazonopensearchserviceS3BackupMode_Values returns all elements of the AmazonopensearchserviceS3BackupMode enum.
CompressionFormat_Values returns all elements of the CompressionFormat enum.
Connectivity_Values returns all elements of the Connectivity enum.
ContentEncoding_Values returns all elements of the ContentEncoding enum.
DefaultDocumentIdFormat_Values returns all elements of the DefaultDocumentIdFormat enum.
DeliveryStreamEncryptionStatus_Values returns all elements of the DeliveryStreamEncryptionStatus enum.
DeliveryStreamFailureType_Values returns all elements of the DeliveryStreamFailureType enum.
DeliveryStreamStatus_Values returns all elements of the DeliveryStreamStatus enum.
DeliveryStreamType_Values returns all elements of the DeliveryStreamType enum.
ElasticsearchIndexRotationPeriod_Values returns all elements of the ElasticsearchIndexRotationPeriod enum.
ElasticsearchS3BackupMode_Values returns all elements of the ElasticsearchS3BackupMode enum.
HECEndpointType_Values returns all elements of the HECEndpointType enum.
HttpEndpointS3BackupMode_Values returns all elements of the HttpEndpointS3BackupMode enum.
IcebergS3BackupMode_Values returns all elements of the IcebergS3BackupMode enum.
KeyType_Values returns all elements of the KeyType enum.
New creates a new instance of the Firehose client with a session.
NoEncryptionConfig_Values returns all elements of the NoEncryptionConfig enum.
OrcCompression_Values returns all elements of the OrcCompression enum.
OrcFormatVersion_Values returns all elements of the OrcFormatVersion enum.
ParquetCompression_Values returns all elements of the ParquetCompression enum.
ParquetWriterVersion_Values returns all elements of the ParquetWriterVersion enum.
ProcessorParameterName_Values returns all elements of the ProcessorParameterName enum.
ProcessorType_Values returns all elements of the ProcessorType enum.
RedshiftS3BackupMode_Values returns all elements of the RedshiftS3BackupMode enum.
S3BackupMode_Values returns all elements of the S3BackupMode enum.
SnowflakeDataLoadingOption_Values returns all elements of the SnowflakeDataLoadingOption enum.
SnowflakeS3BackupMode_Values returns all elements of the SnowflakeS3BackupMode enum.
SplunkS3BackupMode_Values returns all elements of the SplunkS3BackupMode enum.
# Constants
AmazonOpenSearchServerlessS3BackupModeAllDocuments is a AmazonOpenSearchServerlessS3BackupMode enum value.
AmazonOpenSearchServerlessS3BackupModeFailedDocumentsOnly is a AmazonOpenSearchServerlessS3BackupMode enum value.
AmazonopensearchserviceIndexRotationPeriodNoRotation is a AmazonopensearchserviceIndexRotationPeriod enum value.
AmazonopensearchserviceIndexRotationPeriodOneDay is a AmazonopensearchserviceIndexRotationPeriod enum value.
AmazonopensearchserviceIndexRotationPeriodOneHour is a AmazonopensearchserviceIndexRotationPeriod enum value.
AmazonopensearchserviceIndexRotationPeriodOneMonth is a AmazonopensearchserviceIndexRotationPeriod enum value.
AmazonopensearchserviceIndexRotationPeriodOneWeek is a AmazonopensearchserviceIndexRotationPeriod enum value.
AmazonopensearchserviceS3BackupModeAllDocuments is a AmazonopensearchserviceS3BackupMode enum value.
AmazonopensearchserviceS3BackupModeFailedDocumentsOnly is a AmazonopensearchserviceS3BackupMode enum value.
CompressionFormatGzip is a CompressionFormat enum value.
CompressionFormatHadoopSnappy is a CompressionFormat enum value.
CompressionFormatSnappy is a CompressionFormat enum value.
CompressionFormatUncompressed is a CompressionFormat enum value.
CompressionFormatZip is a CompressionFormat enum value.
ConnectivityPrivate is a Connectivity enum value.
ConnectivityPublic is a Connectivity enum value.
ContentEncodingGzip is a ContentEncoding enum value.
ContentEncodingNone is a ContentEncoding enum value.
DefaultDocumentIdFormatFirehoseDefault is a DefaultDocumentIdFormat enum value.
DefaultDocumentIdFormatNoDocumentId is a DefaultDocumentIdFormat enum value.
DeliveryStreamEncryptionStatusDisabled is a DeliveryStreamEncryptionStatus enum value.
DeliveryStreamEncryptionStatusDisabling is a DeliveryStreamEncryptionStatus enum value.
DeliveryStreamEncryptionStatusDisablingFailed is a DeliveryStreamEncryptionStatus enum value.
DeliveryStreamEncryptionStatusEnabled is a DeliveryStreamEncryptionStatus enum value.
DeliveryStreamEncryptionStatusEnabling is a DeliveryStreamEncryptionStatus enum value.
DeliveryStreamEncryptionStatusEnablingFailed is a DeliveryStreamEncryptionStatus enum value.
DeliveryStreamFailureTypeCreateEniFailed is a DeliveryStreamFailureType enum value.
DeliveryStreamFailureTypeCreateKmsGrantFailed is a DeliveryStreamFailureType enum value.
DeliveryStreamFailureTypeDeleteEniFailed is a DeliveryStreamFailureType enum value.
DeliveryStreamFailureTypeDisabledKmsKey is a DeliveryStreamFailureType enum value.
DeliveryStreamFailureTypeEniAccessDenied is a DeliveryStreamFailureType enum value.
DeliveryStreamFailureTypeInvalidKmsKey is a DeliveryStreamFailureType enum value.
DeliveryStreamFailureTypeKmsAccessDenied is a DeliveryStreamFailureType enum value.
DeliveryStreamFailureTypeKmsKeyNotFound is a DeliveryStreamFailureType enum value.
DeliveryStreamFailureTypeKmsOptInRequired is a DeliveryStreamFailureType enum value.
DeliveryStreamFailureTypeRetireKmsGrantFailed is a DeliveryStreamFailureType enum value.
DeliveryStreamFailureTypeSecurityGroupAccessDenied is a DeliveryStreamFailureType enum value.
DeliveryStreamFailureTypeSecurityGroupNotFound is a DeliveryStreamFailureType enum value.
DeliveryStreamFailureTypeSubnetAccessDenied is a DeliveryStreamFailureType enum value.
DeliveryStreamFailureTypeSubnetNotFound is a DeliveryStreamFailureType enum value.
DeliveryStreamFailureTypeUnknownError is a DeliveryStreamFailureType enum value.
DeliveryStreamStatusActive is a DeliveryStreamStatus enum value.
DeliveryStreamStatusCreating is a DeliveryStreamStatus enum value.
DeliveryStreamStatusCreatingFailed is a DeliveryStreamStatus enum value.
DeliveryStreamStatusDeleting is a DeliveryStreamStatus enum value.
DeliveryStreamStatusDeletingFailed is a DeliveryStreamStatus enum value.
DeliveryStreamTypeDirectPut is a DeliveryStreamType enum value.
DeliveryStreamTypeKinesisStreamAsSource is a DeliveryStreamType enum value.
DeliveryStreamTypeMskasSource is a DeliveryStreamType enum value.
ElasticsearchIndexRotationPeriodNoRotation is a ElasticsearchIndexRotationPeriod enum value.
ElasticsearchIndexRotationPeriodOneDay is a ElasticsearchIndexRotationPeriod enum value.
ElasticsearchIndexRotationPeriodOneHour is a ElasticsearchIndexRotationPeriod enum value.
ElasticsearchIndexRotationPeriodOneMonth is a ElasticsearchIndexRotationPeriod enum value.
ElasticsearchIndexRotationPeriodOneWeek is a ElasticsearchIndexRotationPeriod enum value.
ElasticsearchS3BackupModeAllDocuments is a ElasticsearchS3BackupMode enum value.
ElasticsearchS3BackupModeFailedDocumentsOnly is a ElasticsearchS3BackupMode enum value.
ID to lookup a service endpoint with.
ErrCodeConcurrentModificationException for service response error code "ConcurrentModificationException".
ErrCodeInvalidArgumentException for service response error code "InvalidArgumentException".
ErrCodeInvalidKMSResourceException for service response error code "InvalidKMSResourceException".
ErrCodeInvalidSourceException for service response error code "InvalidSourceException".
ErrCodeLimitExceededException for service response error code "LimitExceededException".
ErrCodeResourceInUseException for service response error code "ResourceInUseException".
ErrCodeResourceNotFoundException for service response error code "ResourceNotFoundException".
ErrCodeServiceUnavailableException for service response error code "ServiceUnavailableException".
HECEndpointTypeEvent is a HECEndpointType enum value.
HECEndpointTypeRaw is a HECEndpointType enum value.
HttpEndpointS3BackupModeAllData is a HttpEndpointS3BackupMode enum value.
HttpEndpointS3BackupModeFailedDataOnly is a HttpEndpointS3BackupMode enum value.
IcebergS3BackupModeAllData is a IcebergS3BackupMode enum value.
IcebergS3BackupModeFailedDataOnly is a IcebergS3BackupMode enum value.
KeyTypeAwsOwnedCmk is a KeyType enum value.
KeyTypeCustomerManagedCmk is a KeyType enum value.
NoEncryptionConfigNoEncryption is a NoEncryptionConfig enum value.
OrcCompressionNone is a OrcCompression enum value.
OrcCompressionSnappy is a OrcCompression enum value.
OrcCompressionZlib is a OrcCompression enum value.
OrcFormatVersionV011 is a OrcFormatVersion enum value.
OrcFormatVersionV012 is a OrcFormatVersion enum value.
ParquetCompressionGzip is a ParquetCompression enum value.
ParquetCompressionSnappy is a ParquetCompression enum value.
ParquetCompressionUncompressed is a ParquetCompression enum value.
ParquetWriterVersionV1 is a ParquetWriterVersion enum value.
ParquetWriterVersionV2 is a ParquetWriterVersion enum value.
ProcessorParameterNameBufferIntervalInSeconds is a ProcessorParameterName enum value.
ProcessorParameterNameBufferSizeInMbs is a ProcessorParameterName enum value.
ProcessorParameterNameCompressionFormat is a ProcessorParameterName enum value.
ProcessorParameterNameDataMessageExtraction is a ProcessorParameterName enum value.
ProcessorParameterNameDelimiter is a ProcessorParameterName enum value.
ProcessorParameterNameJsonParsingEngine is a ProcessorParameterName enum value.
ProcessorParameterNameLambdaArn is a ProcessorParameterName enum value.
ProcessorParameterNameMetadataExtractionQuery is a ProcessorParameterName enum value.
ProcessorParameterNameNumberOfRetries is a ProcessorParameterName enum value.
ProcessorParameterNameRoleArn is a ProcessorParameterName enum value.
ProcessorParameterNameSubRecordType is a ProcessorParameterName enum value.
ProcessorTypeAppendDelimiterToRecord is a ProcessorType enum value.
ProcessorTypeCloudWatchLogProcessing is a ProcessorType enum value.
ProcessorTypeDecompression is a ProcessorType enum value.
ProcessorTypeLambda is a ProcessorType enum value.
ProcessorTypeMetadataExtraction is a ProcessorType enum value.
ProcessorTypeRecordDeAggregation is a ProcessorType enum value.
RedshiftS3BackupModeDisabled is a RedshiftS3BackupMode enum value.
RedshiftS3BackupModeEnabled is a RedshiftS3BackupMode enum value.
S3BackupModeDisabled is a S3BackupMode enum value.
S3BackupModeEnabled is a S3BackupMode enum value.
ServiceID is a unique identifier of a specific service.
Name of service.
SnowflakeDataLoadingOptionJsonMapping is a SnowflakeDataLoadingOption enum value.
SnowflakeDataLoadingOptionVariantContentAndMetadataMapping is a SnowflakeDataLoadingOption enum value.
SnowflakeDataLoadingOptionVariantContentMapping is a SnowflakeDataLoadingOption enum value.
SnowflakeS3BackupModeAllData is a SnowflakeS3BackupMode enum value.
SnowflakeS3BackupModeFailedDataOnly is a SnowflakeS3BackupMode enum value.
SplunkS3BackupModeAllEvents is a SplunkS3BackupMode enum value.
SplunkS3BackupModeFailedEventsOnly is a SplunkS3BackupMode enum value.
# Structs
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.
Describes the containers where the destination Apache Iceberg Tables are persisted.
Describes the Amazon CloudWatch logging options for your delivery stream.
Another modification has already happened.
Describes a COPY command for Amazon Redshift.
Specifies that you want Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
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.
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.
Describes the destination for a delivery stream.
Describes the configuration of a destination in Apache Iceberg Tables.
Indicates the method for setting up 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.
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 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.
Firehose provides the API operation methods for making requests to Amazon Kinesis Firehose.
The native Hive / HCatalog JsonSerDe.
Describes the buffering options that can be applied before data is delivered to the HTTP endpoint destination.
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.
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 delivery stream encryption fails.
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 delivery stream.
Details about a Kinesis data stream used as the source for a Firehose delivery 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 delivery stream.
The OpenX SerDe.
A serializer to use for converting data to the ORC format before storing it in Amazon S3.
Specifies the serializer that you want Firehose to use to convert the format of your data before it writes it to Amazon S3.
A serializer to use for converting data to the Parquet format before storing it in Amazon S3.
Describes a data processing configuration.
Describes a data processor.
Describes the processor parameter.
Contains the result for an individual record from a PutRecordBatch request.
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 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 an Amazon S3 prefix.
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.
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.
The service is unavailable.
Describes the buffering to perform before delivering data to the Snowflake destination.
Configure Snowflake destination.
Optional Snowflake destination description.
Update to configuration settings.
Specify how long Firehose retries sending data to the New Relic HTTP endpoint.
Optionally configure a Snowflake role.
Configure a Snowflake VPC.
Details about a Kinesis data stream used as the source for a Firehose delivery stream.
The buffering options.
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.
Metadata that you can assign to a delivery stream, consisting of a key-value pair.
The details of the VPC of the Amazon OpenSearch or Amazon OpenSearch Serverless destination.
The details of the VPC of the Amazon ES destination.