Values (u.bd1fbe2ccff02fd1cddfdcb5f1e38e71.awso.0.9.1.doc.awso.firehose.Awso

Sourceval service : Awso.Service.t

Sourceval apiVersion : string

Sourceval endpointPrefix : string

Sourceval serviceFullName : string

Sourceval signatureVersion : string

Sourceval protocol : string

Sourceval globalEndpoint : string

Sourceval serviceAbbreviation : string

Sourceval targetPrefix : string

Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t

Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t

Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t

Source

val structure_to_value_aux : 
  ('a * 'b option) list ->
  f:(('a * 'b) list -> 'c) ->
  [> `Structure of 'c ]

Source

val structure_to_value : 
  ('a * 'b option) list ->
  [> `Structure of ('a * 'b) list ]

Source

val structure_to_wrapped_value : 
  wrapper:'a ->
  response:'a ->
  ('b * 'c option) list ->
  [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]

Sourcemodule ProcessorParameterName : sig ... end

Sourcemodule ProcessorParameterValue : sig ... end

Sourcemodule NonEmptyString : sig ... end

Sourcemodule NonEmptyStringWithoutWhitespace : sig ... end

Sourcemodule ProcessorParameter : sig ... end

Describes the processor parameter.

Sourcemodule ListOfNonEmptyStrings : sig ... end

Sourcemodule BooleanObject : sig ... end

Sourcemodule ColumnToJsonKeyMappings : sig ... end

Sourcemodule BlockSizeBytes : sig ... end

Sourcemodule ListOfNonEmptyStringsWithoutWhitespace : sig ... end

Sourcemodule OrcCompression : sig ... end

Sourcemodule OrcFormatVersion : sig ... end

Sourcemodule OrcRowIndexStride : sig ... end

Sourcemodule OrcStripeSizeBytes : sig ... end

Sourcemodule Proportion : sig ... end

Sourcemodule NonNegativeIntegerObject : sig ... end

Sourcemodule ParquetCompression : sig ... end

Sourcemodule ParquetPageSizeBytes : sig ... end

Sourcemodule ParquetWriterVersion : sig ... end

Sourcemodule PartitionField : sig ... end

Represents a single field in a PartitionSpec. Amazon Data Firehose is in preview release and is subject to change.

Sourcemodule ProcessorParameterList : sig ... end

Sourcemodule ProcessorType : sig ... end

Sourcemodule AWSKMSKeyARN : sig ... end

Sourcemodule HiveJsonSerDe : sig ... end

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.

Sourcemodule OpenXJsonSerDe : sig ... end

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.

Sourcemodule OrcSerDe : sig ... end

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

Sourcemodule ParquetSerDe : sig ... end

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

Sourcemodule HttpEndpointAttributeName : sig ... end

Sourcemodule HttpEndpointAttributeValue : sig ... end

Sourcemodule PartitionFields : sig ... end

Sourcemodule Processor : sig ... end

Describes a data processor. If you want to add a new line delimiter between records in objects that are delivered to Amazon S3, choose AppendDelimiterToRecord as a processor type. You don’t have to put a processor parameter when you select AppendDelimiterToRecord.

Sourcemodule IntervalInSeconds : sig ... end

Sourcemodule SizeInMBs : sig ... end

Sourcemodule LogGroupName : sig ... end

Sourcemodule LogStreamName : sig ... end

Sourcemodule KMSEncryptionConfig : sig ... end

Describes an encryption key for a destination in Amazon S3.

Sourcemodule NoEncryptionConfig : sig ... end

Sourcemodule Deserializer : sig ... end

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.

Sourcemodule Serializer : sig ... end

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.

Sourcemodule RetryDurationInSeconds : sig ... end

Sourcemodule HttpEndpointCommonAttribute : sig ... end

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

Sourcemodule ErrorOutputPrefix : sig ... end

Sourcemodule PartitionSpec : sig ... end

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. Here is an example of the schema in JSON. "partitionSpec": { "identity": [ {"sourceName": "column1"}, {"sourceName": "column2"}, {"sourceName": "column3"} ] } Amazon Data Firehose is in preview release and is subject to change.

Sourcemodule StringWithLettersDigitsUnderscoresDots : sig ... end

Sourcemodule DeliveryStreamFailureType : sig ... end

Sourcemodule AmazonOpenSearchServerlessBufferingIntervalInSeconds : sig ... end

Sourcemodule AmazonOpenSearchServerlessBufferingSizeInMBs : sig ... end

Sourcemodule AmazonOpenSearchServerlessRetryDurationInSeconds : sig ... end

Sourcemodule ProcessorList : sig ... end

Sourcemodule BucketARN : sig ... end

Sourcemodule BufferingHints : sig ... end

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.

Sourcemodule CloudWatchLoggingOptions : sig ... end

Describes the Amazon CloudWatch logging options for your Firehose stream.

Sourcemodule CompressionFormat : sig ... end

Sourcemodule EncryptionConfiguration : sig ... end

Describes the encryption for a destination in Amazon S3.

Sourcemodule Prefix : sig ... end

Sourcemodule RoleARN : sig ... end

Sourcemodule SecurityGroupIdList : sig ... end

Sourcemodule SubnetIdList : sig ... end

Sourcemodule AmazonopensearchserviceBufferingIntervalInSeconds : sig ... end

Sourcemodule AmazonopensearchserviceBufferingSizeInMBs : sig ... end

Sourcemodule AmazonopensearchserviceRetryDurationInSeconds : sig ... end

Sourcemodule DefaultDocumentIdFormat : sig ... end

Sourcemodule ElasticsearchBufferingIntervalInSeconds : sig ... end

Sourcemodule ElasticsearchBufferingSizeInMBs : sig ... end

Sourcemodule ElasticsearchRetryDurationInSeconds : sig ... end

Sourcemodule InputFormatConfiguration : sig ... end

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.

Sourcemodule OutputFormatConfiguration : sig ... end

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.

Sourcemodule SchemaConfiguration : sig ... end

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.

Sourcemodule RetryOptions : sig ... end

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

Sourcemodule HttpEndpointBufferingIntervalInSeconds : sig ... end

Sourcemodule HttpEndpointBufferingSizeInMBs : sig ... end

Sourcemodule HttpEndpointName : sig ... end

Sourcemodule HttpEndpointUrl : sig ... end

Sourcemodule ContentEncoding : sig ... end

Sourcemodule HttpEndpointCommonAttributesList : sig ... end

Sourcemodule HttpEndpointRetryDurationInSeconds : sig ... end

Sourcemodule SecretARN : sig ... end

Sourcemodule GlueDataCatalogARN : sig ... end

Sourcemodule WarehouseLocation : sig ... end

Sourcemodule DestinationTableConfiguration : sig ... end

Describes the configuration of a destination in Apache Iceberg Tables.

Sourcemodule CopyOptions : sig ... end

Sourcemodule DataTableColumns : sig ... end

Sourcemodule DataTableName : sig ... end

Sourcemodule RedshiftRetryDurationInSeconds : sig ... end

Sourcemodule SnowflakeBufferingIntervalInSeconds : sig ... end

Sourcemodule SnowflakeBufferingSizeInMBs : sig ... end

Sourcemodule SnowflakeRetryDurationInSeconds : sig ... end

Sourcemodule SnowflakeRole : sig ... end

Sourcemodule SnowflakePrivateLinkVpceId : sig ... end

Sourcemodule SplunkBufferingIntervalInSeconds : sig ... end

Sourcemodule SplunkBufferingSizeInMBs : sig ... end

Sourcemodule SplunkRetryDurationInSeconds : sig ... end

Sourcemodule DatabaseColumnName : sig ... end

Sourcemodule DatabaseName : sig ... end

Sourcemodule DatabaseTableName : sig ... end

Sourcemodule FailureDescription : sig ... end

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

Sourcemodule SnapshotRequestedBy : sig ... end

Sourcemodule SnapshotStatus : sig ... end

Sourcemodule Timestamp : sig ... end

Sourcemodule AmazonOpenSearchServerlessBufferingHints : sig ... end

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

Sourcemodule AmazonOpenSearchServerlessCollectionEndpoint : sig ... end

Sourcemodule AmazonOpenSearchServerlessIndexName : sig ... end

Sourcemodule AmazonOpenSearchServerlessRetryOptions : sig ... end

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

Sourcemodule AmazonOpenSearchServerlessS3BackupMode : sig ... end

Sourcemodule ProcessingConfiguration : sig ... end

Describes a data processing configuration.

Sourcemodule S3DestinationDescription : sig ... end

Describes a destination in Amazon S3.

Sourcemodule VpcConfigurationDescription : sig ... end

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

Sourcemodule AmazonopensearchserviceBufferingHints : sig ... end

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

Sourcemodule AmazonopensearchserviceClusterEndpoint : sig ... end

Sourcemodule AmazonopensearchserviceDomainARN : sig ... end

Sourcemodule AmazonopensearchserviceIndexName : sig ... end

Sourcemodule AmazonopensearchserviceIndexRotationPeriod : sig ... end

Sourcemodule AmazonopensearchserviceRetryOptions : sig ... end

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

Sourcemodule AmazonopensearchserviceS3BackupMode : sig ... end

Sourcemodule AmazonopensearchserviceTypeName : sig ... end

Sourcemodule DocumentIdOptions : sig ... end

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

Sourcemodule ElasticsearchBufferingHints : sig ... end

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

Sourcemodule ElasticsearchClusterEndpoint : sig ... end

Sourcemodule ElasticsearchDomainARN : sig ... end

Sourcemodule ElasticsearchIndexName : sig ... end

Sourcemodule ElasticsearchIndexRotationPeriod : sig ... end

Sourcemodule ElasticsearchRetryOptions : sig ... end

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

Sourcemodule ElasticsearchS3BackupMode : sig ... end

Sourcemodule ElasticsearchTypeName : sig ... end

Sourcemodule CustomTimeZone : sig ... end

Sourcemodule DataFormatConversionConfiguration : sig ... end

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.

Sourcemodule DynamicPartitioningConfiguration : sig ... end

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.

Sourcemodule FileExtension : sig ... end

Sourcemodule S3BackupMode : sig ... end

Sourcemodule HttpEndpointBufferingHints : sig ... end

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.

Sourcemodule HttpEndpointDescription : sig ... end

Describes the HTTP endpoint selected as the destination.

Sourcemodule HttpEndpointRequestConfiguration : sig ... end

The configuration of the HTTP endpoint request.

Sourcemodule HttpEndpointRetryOptions : sig ... end

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.

Sourcemodule HttpEndpointS3BackupMode : sig ... end

Sourcemodule SecretsManagerConfiguration : sig ... end

The structure that defines how Firehose accesses the secret.

Sourcemodule CatalogConfiguration : sig ... end

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

Sourcemodule DestinationTableConfigurationList : sig ... end

Sourcemodule IcebergS3BackupMode : sig ... end

Sourcemodule SchemaEvolutionConfiguration : sig ... end

The configuration to enable schema evolution. Amazon Data Firehose is in preview release and is subject to change.

Sourcemodule TableCreationConfiguration : sig ... end

The configuration to enable automatic table creation. Amazon Data Firehose is in preview release and is subject to change.

Sourcemodule ClusterJDBCURL : sig ... end

Sourcemodule CopyCommand : sig ... end

Describes a COPY command for Amazon Redshift.

Sourcemodule RedshiftRetryOptions : sig ... end

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

Sourcemodule RedshiftS3BackupMode : sig ... end

Sourcemodule Username : sig ... end

Sourcemodule SnowflakeAccountUrl : sig ... end

Sourcemodule SnowflakeBufferingHints : sig ... end

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

Sourcemodule SnowflakeContentColumnName : sig ... end

Sourcemodule SnowflakeDataLoadingOption : sig ... end

Sourcemodule SnowflakeDatabase : sig ... end

Sourcemodule SnowflakeMetaDataColumnName : sig ... end

Sourcemodule SnowflakeRetryOptions : sig ... end

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.

Sourcemodule SnowflakeRoleConfiguration : sig ... end

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

Sourcemodule SnowflakeS3BackupMode : sig ... end

Sourcemodule SnowflakeSchema : sig ... end

Sourcemodule SnowflakeTable : sig ... end

Sourcemodule SnowflakeUser : sig ... end

Sourcemodule SnowflakeVpcConfiguration : sig ... end

Configure a Snowflake VPC

Sourcemodule HECAcknowledgmentTimeoutInSeconds : sig ... end

Sourcemodule HECEndpoint : sig ... end

Sourcemodule HECEndpointType : sig ... end

Sourcemodule HECToken : sig ... end

Sourcemodule SplunkBufferingHints : sig ... end

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

Sourcemodule SplunkRetryOptions : sig ... end

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

Sourcemodule SplunkS3BackupMode : sig ... end

Sourcemodule DatabaseColumnIncludeOrExcludeList : sig ... end

Sourcemodule DatabaseIncludeOrExcludeList : sig ... end

Sourcemodule DatabaseSnapshotInfo : sig ... end

The structure that describes the snapshot information of a table in source database endpoint that Firehose reads. Amazon Data Firehose is in preview release and is subject to change.

Sourcemodule VpcEndpointServiceName : sig ... end

Sourcemodule DatabaseTableIncludeOrExcludeList : sig ... end

Sourcemodule Connectivity : sig ... end

Sourcemodule AmazonOpenSearchServerlessDestinationDescription : sig ... end

The destination description in the Serverless offering for Amazon OpenSearch Service.

Sourcemodule AmazonopensearchserviceDestinationDescription : sig ... end

The destination description in Amazon OpenSearch Service.

Sourcemodule DestinationId : sig ... end

Sourcemodule ElasticsearchDestinationDescription : sig ... end

The destination description in Amazon OpenSearch Service.

Sourcemodule ExtendedS3DestinationDescription : sig ... end

Describes a destination in Amazon S3.

Sourcemodule HttpEndpointDestinationDescription : sig ... end

Describes the HTTP endpoint destination.

Sourcemodule IcebergDestinationDescription : sig ... end

Describes a destination in Apache Iceberg Tables.

Sourcemodule RedshiftDestinationDescription : sig ... end

Describes a destination in Amazon Redshift.

Sourcemodule SnowflakeDestinationDescription : sig ... end

Optional Snowflake destination description

Sourcemodule SplunkDestinationDescription : sig ... end

Describes a destination in Splunk.

Sourcemodule DatabaseColumnList : sig ... end

The structure used to configure the list of column patterns in source database endpoint for Firehose to read from. Amazon Data Firehose is in preview release and is subject to change.

Sourcemodule DatabaseEndpoint : sig ... end

Sourcemodule DatabaseList : sig ... end

The structure used to configure the list of database patterns in source database endpoint for Firehose to read from. Amazon Data Firehose is in preview release and is subject to change.

Sourcemodule DatabasePort : sig ... end

Sourcemodule DatabaseSnapshotInfoList : sig ... end

Sourcemodule DatabaseSourceAuthenticationConfiguration : sig ... end

The structure to configure the authentication methods for Firehose to connect to source database endpoint. Amazon Data Firehose is in preview release and is subject to change.

Sourcemodule DatabaseSourceVPCConfiguration : sig ... end

The structure for details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database. Amazon Data Firehose is in preview release and is subject to change.

Sourcemodule DatabaseTableList : sig ... end

The structure used to configure the list of table patterns in source database endpoint for Firehose to read from. Amazon Data Firehose is in preview release and is subject to change.

Sourcemodule DatabaseType : sig ... end

Sourcemodule SSLMode : sig ... end

Sourcemodule ThroughputHintInMBs : sig ... end

Sourcemodule DeliveryStartTimestamp : sig ... end

Sourcemodule KinesisStreamARN : sig ... end

Sourcemodule AuthenticationConfiguration : sig ... end

The authentication configuration of the Amazon MSK cluster.

Sourcemodule MSKClusterARN : sig ... end

Sourcemodule ReadFromTimestamp : sig ... end

Sourcemodule TopicName : sig ... end

Sourcemodule HttpEndpointAccessKey : sig ... end

Sourcemodule TagKey : sig ... end

Sourcemodule TagValue : sig ... end

Sourcemodule ErrorCode : sig ... end

Sourcemodule ErrorMessage : sig ... end

Sourcemodule PutResponseRecordId : sig ... end

Sourcemodule Data : sig ... end

Sourcemodule DeliveryStreamEncryptionStatus : sig ... end

Sourcemodule KeyType : sig ... end

Sourcemodule DestinationDescription : sig ... end

Describes the destination for a Firehose stream.

Sourcemodule DatabaseSourceDescription : sig ... end

The top level object for database source description. Amazon Data Firehose is in preview release and is subject to change.

Sourcemodule DirectPutSourceDescription : sig ... end

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

Sourcemodule KinesisStreamSourceDescription : sig ... end

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

Sourcemodule MSKSourceDescription : sig ... end

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

Sourcemodule S3DestinationUpdate : sig ... end

Describes an update for a destination in Amazon S3.

Sourcemodule HttpEndpointConfiguration : sig ... end

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

Sourcemodule S3DestinationConfiguration : sig ... end

Describes the configuration of a destination in Amazon S3.

Sourcemodule Password : sig ... end

Sourcemodule SnowflakeKeyPassphrase : sig ... end

Sourcemodule SnowflakePrivateKey : sig ... end

Sourcemodule Tag : sig ... end

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

Sourcemodule PutRecordBatchResponseEntry : sig ... end

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.

Sourcemodule Record : sig ... end

The unit of data in a Firehose stream.

Sourcemodule DeliveryStreamName : sig ... end

Sourcemodule DeliveryStreamARN : sig ... end

Sourcemodule DeliveryStreamEncryptionConfiguration : sig ... end

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.

Sourcemodule DeliveryStreamStatus : sig ... end

Sourcemodule DeliveryStreamType : sig ... end

Sourcemodule DeliveryStreamVersionId : sig ... end

Sourcemodule DestinationDescriptionList : sig ... end

Sourcemodule SourceDescription : sig ... end

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

Sourcemodule VpcConfiguration : sig ... end

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

Sourcemodule DatabaseSurrogateKeyList : sig ... end

Sourcemodule ConcurrentModificationException : sig ... end

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

Sourcemodule InvalidArgumentException : sig ... end

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

Sourcemodule ResourceInUseException : sig ... end

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

Sourcemodule ResourceNotFoundException : sig ... end

The specified resource could not be found.

Sourcemodule AmazonOpenSearchServerlessDestinationUpdate : sig ... end

Describes an update for a destination in the Serverless offering for Amazon OpenSearch Service.

Sourcemodule AmazonopensearchserviceDestinationUpdate : sig ... end

Describes an update for a destination in Amazon OpenSearch Service.

Sourcemodule ElasticsearchDestinationUpdate : sig ... end

Describes an update for a destination in Amazon OpenSearch Service.

Sourcemodule ExtendedS3DestinationUpdate : sig ... end

Describes an update for a destination in Amazon S3.

Sourcemodule HttpEndpointDestinationUpdate : sig ... end

Updates the specified HTTP endpoint destination.

Sourcemodule IcebergDestinationUpdate : sig ... end

Describes an update for a destination in Apache Iceberg Tables.

Sourcemodule RedshiftDestinationUpdate : sig ... end

Describes an update for a destination in Amazon Redshift.

Sourcemodule SnowflakeDestinationUpdate : sig ... end

Update to configuration settings

Sourcemodule SplunkDestinationUpdate : sig ... end

Describes an update for a destination in Splunk.

Sourcemodule LimitExceededException : sig ... end

You have already reached the limit for a requested resource.

Sourcemodule TagKeyList : sig ... end

Sourcemodule TagDeliveryStreamInputTagList : sig ... end

Sourcemodule InvalidKMSResourceException : sig ... end

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.

Sourcemodule DeliveryStreamEncryptionConfigurationInput : sig ... end

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

Sourcemodule InvalidSourceException : sig ... end

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

Sourcemodule ServiceUnavailableException : sig ... end

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.

Sourcemodule PutRecordBatchResponseEntryList : sig ... end

Sourcemodule PutRecordBatchRequestEntryList : sig ... end

Sourcemodule ListTagsForDeliveryStreamOutputTagList : sig ... end

Sourcemodule ListTagsForDeliveryStreamInputLimit : sig ... end

Sourcemodule DeliveryStreamNameList : sig ... end

Sourcemodule ListDeliveryStreamsInputLimit : sig ... end

Sourcemodule DeliveryStreamDescription : sig ... end

Contains information about a Firehose stream.

Sourcemodule DescribeDeliveryStreamInputLimit : sig ... end

Sourcemodule AmazonOpenSearchServerlessDestinationConfiguration : sig ... end

Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.

Sourcemodule AmazonopensearchserviceDestinationConfiguration : sig ... end

Describes the configuration of a destination in Amazon OpenSearch Service

Sourcemodule DatabaseSourceConfiguration : sig ... end

The top level object for configuring streams with database as a source. Amazon Data Firehose is in preview release and is subject to change.

Sourcemodule DirectPutSourceConfiguration : sig ... end

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

Sourcemodule ElasticsearchDestinationConfiguration : sig ... end

Describes the configuration of a destination in Amazon OpenSearch Service.

Sourcemodule ExtendedS3DestinationConfiguration : sig ... end

Describes the configuration of a destination in Amazon S3.

Sourcemodule HttpEndpointDestinationConfiguration : sig ... end

Describes the configuration of the HTTP endpoint destination.

Sourcemodule IcebergDestinationConfiguration : sig ... end

Specifies the destination configure settings for Apache Iceberg Table.

Sourcemodule KinesisStreamSourceConfiguration : sig ... end

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

Sourcemodule MSKSourceConfiguration : sig ... end

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

Sourcemodule RedshiftDestinationConfiguration : sig ... end

Describes the configuration of a destination in Amazon Redshift.

Sourcemodule SnowflakeDestinationConfiguration : sig ... end

Configure Snowflake destination

Sourcemodule SplunkDestinationConfiguration : sig ... end

Describes the configuration of a destination in Splunk.

Sourcemodule UpdateDestinationOutput : sig ... end

Updates the specified destination of the specified Firehose stream. Use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target Firehose stream remains active while the configurations are updated, so data writes to the Firehose stream can continue during this process. The updated configurations are usually effective within a few minutes. Switching between Amazon OpenSearch Service and other services is not supported. For an Amazon OpenSearch Service destination, you can only update to another Amazon OpenSearch Service destination. If the destination type is the same, Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values are retained. For example, in the Amazon S3 destination, if EncryptionConfiguration is not specified, then the existing EncryptionConfiguration is maintained on the destination. If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Firehose does not merge any parameters. In this case, all parameters must be specified. Firehose uses CurrentDeliveryStreamVersionId to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and can be retrieved using DescribeDeliveryStream. Use the new version ID to set CurrentDeliveryStreamVersionId in the next call.

Sourcemodule UpdateDestinationInput : sig ... end

Updates the specified destination of the specified Firehose stream. Use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target Firehose stream remains active while the configurations are updated, so data writes to the Firehose stream can continue during this process. The updated configurations are usually effective within a few minutes. Switching between Amazon OpenSearch Service and other services is not supported. For an Amazon OpenSearch Service destination, you can only update to another Amazon OpenSearch Service destination. If the destination type is the same, Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values are retained. For example, in the Amazon S3 destination, if EncryptionConfiguration is not specified, then the existing EncryptionConfiguration is maintained on the destination. If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Firehose does not merge any parameters. In this case, all parameters must be specified. Firehose uses CurrentDeliveryStreamVersionId to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and can be retrieved using DescribeDeliveryStream. Use the new version ID to set CurrentDeliveryStreamVersionId in the next call.

Sourcemodule UntagDeliveryStreamOutput : sig ... end

Removes tags from the specified Firehose stream. Removed tags are deleted, and you can't recover them after this operation successfully completes. If you specify a tag that doesn't exist, the operation ignores it. This operation has a limit of five transactions per second per account.

Sourcemodule UntagDeliveryStreamInput : sig ... end

Removes tags from the specified Firehose stream. Removed tags are deleted, and you can't recover them after this operation successfully completes. If you specify a tag that doesn't exist, the operation ignores it. This operation has a limit of five transactions per second per account.

Sourcemodule TagDeliveryStreamOutput : sig ... end

Adds or updates tags for the specified Firehose stream. A tag is a key-value pair that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the Firehose stream. For more information about tags, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide. Each Firehose stream can have up to 50 tags. This operation has a limit of five transactions per second per account.

Sourcemodule TagDeliveryStreamInput : sig ... end

Adds or updates tags for the specified Firehose stream. A tag is a key-value pair that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the Firehose stream. For more information about tags, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide. Each Firehose stream can have up to 50 tags. This operation has a limit of five transactions per second per account.

Sourcemodule StopDeliveryStreamEncryptionOutput : sig ... end

Disables server-side encryption (SSE) for the Firehose stream. This operation is asynchronous. It returns immediately. When you invoke it, Firehose first sets the encryption status of the stream to DISABLING, and then to DISABLED. You can continue to read and write data to your stream while its status is DISABLING. It can take up to 5 seconds after the encryption status changes to DISABLED before all records written to the Firehose stream are no longer subject to encryption. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively. To check the encryption state of a Firehose stream, use DescribeDeliveryStream. If SSE is enabled using a customer managed CMK and then you invoke StopDeliveryStreamEncryption, Firehose schedules the related KMS grant for retirement and then retires it after it ensures that it is finished delivering records to the destination. The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per Firehose stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same Firehose stream in a 24-hour period.

Sourcemodule StopDeliveryStreamEncryptionInput : sig ... end

Disables server-side encryption (SSE) for the Firehose stream. This operation is asynchronous. It returns immediately. When you invoke it, Firehose first sets the encryption status of the stream to DISABLING, and then to DISABLED. You can continue to read and write data to your stream while its status is DISABLING. It can take up to 5 seconds after the encryption status changes to DISABLED before all records written to the Firehose stream are no longer subject to encryption. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively. To check the encryption state of a Firehose stream, use DescribeDeliveryStream. If SSE is enabled using a customer managed CMK and then you invoke StopDeliveryStreamEncryption, Firehose schedules the related KMS grant for retirement and then retires it after it ensures that it is finished delivering records to the destination. The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per Firehose stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same Firehose stream in a 24-hour period.

Sourcemodule StartDeliveryStreamEncryptionOutput : sig ... end

Enables server-side encryption (SSE) for the Firehose stream. This operation is asynchronous. It returns immediately. When you invoke it, Firehose first sets the encryption status of the stream to ENABLING, and then to ENABLED. The encryption status of a Firehose stream is the Status property in DeliveryStreamEncryptionConfiguration. If the operation fails, the encryption status changes to ENABLING_FAILED. You can continue to read and write data to your Firehose stream while the encryption status is ENABLING, but the data is not encrypted. It can take up to 5 seconds after the encryption status changes to ENABLED before all records written to the Firehose stream are encrypted. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively. To check the encryption status of a Firehose stream, use DescribeDeliveryStream. Even if encryption is currently enabled for a Firehose stream, you can still invoke this operation on it to change the ARN of the CMK or both its type and ARN. If you invoke this method to change the CMK, and the old CMK is of type CUSTOMER_MANAGED_CMK, Firehose schedules the grant it had on the old CMK for retirement. If the new CMK is of type CUSTOMER_MANAGED_CMK, Firehose creates a grant that enables it to use the new CMK to encrypt and decrypt data and to manage the grant. For the KMS grant creation to be successful, the Firehose API operations StartDeliveryStreamEncryption and CreateDeliveryStream should not be called with session credentials that are more than 6 hours old. If a Firehose stream already has encryption enabled and then you invoke this operation to change the ARN of the CMK or both its type and ARN and you get ENABLING_FAILED, this only means that the attempt to change the CMK failed. In this case, encryption remains enabled with the old CMK. If the encryption status of your Firehose stream is ENABLING_FAILED, you can invoke this operation again with a valid CMK. The CMK must be enabled and the key policy mustn't explicitly deny the permission for Firehose to invoke KMS encrypt and decrypt operations. You can enable SSE for a Firehose stream only if it's a Firehose stream that uses DirectPut as its source. The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per Firehose stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same Firehose stream in a 24-hour period.

Sourcemodule StartDeliveryStreamEncryptionInput : sig ... end

Enables server-side encryption (SSE) for the Firehose stream. This operation is asynchronous. It returns immediately. When you invoke it, Firehose first sets the encryption status of the stream to ENABLING, and then to ENABLED. The encryption status of a Firehose stream is the Status property in DeliveryStreamEncryptionConfiguration. If the operation fails, the encryption status changes to ENABLING_FAILED. You can continue to read and write data to your Firehose stream while the encryption status is ENABLING, but the data is not encrypted. It can take up to 5 seconds after the encryption status changes to ENABLED before all records written to the Firehose stream are encrypted. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively. To check the encryption status of a Firehose stream, use DescribeDeliveryStream. Even if encryption is currently enabled for a Firehose stream, you can still invoke this operation on it to change the ARN of the CMK or both its type and ARN. If you invoke this method to change the CMK, and the old CMK is of type CUSTOMER_MANAGED_CMK, Firehose schedules the grant it had on the old CMK for retirement. If the new CMK is of type CUSTOMER_MANAGED_CMK, Firehose creates a grant that enables it to use the new CMK to encrypt and decrypt data and to manage the grant. For the KMS grant creation to be successful, the Firehose API operations StartDeliveryStreamEncryption and CreateDeliveryStream should not be called with session credentials that are more than 6 hours old. If a Firehose stream already has encryption enabled and then you invoke this operation to change the ARN of the CMK or both its type and ARN and you get ENABLING_FAILED, this only means that the attempt to change the CMK failed. In this case, encryption remains enabled with the old CMK. If the encryption status of your Firehose stream is ENABLING_FAILED, you can invoke this operation again with a valid CMK. The CMK must be enabled and the key policy mustn't explicitly deny the permission for Firehose to invoke KMS encrypt and decrypt operations. You can enable SSE for a Firehose stream only if it's a Firehose stream that uses DirectPut as its source. The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per Firehose stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same Firehose stream in a 24-hour period.

Sourcemodule PutRecordOutput : sig ... end

Writes a single data record into an Firehose stream. To write multiple data records into a Firehose stream, use PutRecordBatch. Applications using these operations are referred to as producers. By default, each Firehose stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. If you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each Firehose stream. For more information about limits and how to request an increase, see Amazon Firehose Limits. Firehose accumulates and publishes a particular metric for a customer account in one minute intervals. It is possible that the bursts of incoming bytes/records ingested to a Firehose stream last only for a few seconds. Due to this, the actual spikes in the traffic might not be fully visible in the customer's 1 minute CloudWatch metrics. You must specify the name of the Firehose stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KiB in size, and any kind of data. For example, it can be a segment from a log file, geographic location data, website clickstream data, and so on. For multi record de-aggregation, you can not put more than 500 records even if the data blob length is less than 1000 KiB. If you include more than 500 records, the request succeeds but the record de-aggregation doesn't work as expected and transformation lambda is invoked with the complete base64 encoded data blob instead of de-aggregated base64 decoded records. Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination. The PutRecord operation returns a RecordId, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation. If the PutRecord operation throws a ServiceUnavailableException, the API is automatically reinvoked (retried) 3 times. If the exception persists, it is possible that the throughput limits have been exceeded for the Firehose stream. Re-invoking the Put API operations (for example, PutRecord and PutRecordBatch) can result in data duplicates. For larger data assets, allow for a longer time out before retrying Put API operations. Data records sent to Firehose are stored for 24 hours from the time they are added to a Firehose stream as it tries to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available. Don't concatenate two or more base64 strings to form the data fields of your records. Instead, concatenate the raw data, then perform base64 encoding.

Sourcemodule PutRecordInput : sig ... end

Writes a single data record into an Firehose stream. To write multiple data records into a Firehose stream, use PutRecordBatch. Applications using these operations are referred to as producers. By default, each Firehose stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. If you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each Firehose stream. For more information about limits and how to request an increase, see Amazon Firehose Limits. Firehose accumulates and publishes a particular metric for a customer account in one minute intervals. It is possible that the bursts of incoming bytes/records ingested to a Firehose stream last only for a few seconds. Due to this, the actual spikes in the traffic might not be fully visible in the customer's 1 minute CloudWatch metrics. You must specify the name of the Firehose stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KiB in size, and any kind of data. For example, it can be a segment from a log file, geographic location data, website clickstream data, and so on. For multi record de-aggregation, you can not put more than 500 records even if the data blob length is less than 1000 KiB. If you include more than 500 records, the request succeeds but the record de-aggregation doesn't work as expected and transformation lambda is invoked with the complete base64 encoded data blob instead of de-aggregated base64 decoded records. Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination. The PutRecord operation returns a RecordId, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation. If the PutRecord operation throws a ServiceUnavailableException, the API is automatically reinvoked (retried) 3 times. If the exception persists, it is possible that the throughput limits have been exceeded for the Firehose stream. Re-invoking the Put API operations (for example, PutRecord and PutRecordBatch) can result in data duplicates. For larger data assets, allow for a longer time out before retrying Put API operations. Data records sent to Firehose are stored for 24 hours from the time they are added to a Firehose stream as it tries to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available. Don't concatenate two or more base64 strings to form the data fields of your records. Instead, concatenate the raw data, then perform base64 encoding.

Sourcemodule PutRecordBatchOutput : sig ... end

Writes multiple data records into a Firehose stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a Firehose stream, use PutRecord. Applications using these operations are referred to as producers. Firehose accumulates and publishes a particular metric for a customer account in one minute intervals. It is possible that the bursts of incoming bytes/records ingested to a Firehose stream last only for a few seconds. Due to this, the actual spikes in the traffic might not be fully visible in the customer's 1 minute CloudWatch metrics. For information about service quota, see Amazon Firehose Quota. Each PutRecordBatch request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before base64 encoding), up to a limit of 4 MB for the entire request. These limits cannot be changed. You must specify the name of the Firehose stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data. For example, it could be a segment from a log file, geographic location data, website clickstream data, and so on. For multi record de-aggregation, you can not put more than 500 records even if the data blob length is less than 1000 KiB. If you include more than 500 records, the request succeeds but the record de-aggregation doesn't work as expected and transformation lambda is invoked with the complete base64 encoded data blob instead of de-aggregated base64 decoded records. Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination. The PutRecordBatch response includes a count of failed records, FailedPutCount, and an array of responses, RequestResponses. Even if the PutRecordBatch call succeeds, the value of FailedPutCount may be greater than 0, indicating that there are records for which the operation didn't succeed. Each entry in the RequestResponses array provides additional information about the processed record. It directly correlates with a record in the request array using the same ordering, from the top to the bottom. The response array always includes the same number of records as the request array. RequestResponses includes both successfully and unsuccessfully processed records. Firehose tries to process all records in each PutRecordBatch request. A single record failure does not stop the processing of subsequent records. A successfully processed record includes a RecordId value, which is unique for the record. An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error, and is one of the following values: ServiceUnavailableException or InternalFailure. ErrorMessage provides more detailed information about the error. If there is an internal server error or a timeout, the write might have completed or it might have failed. If FailedPutCount is greater than 0, retry the request, resending only those records that might have failed processing. This minimizes the possible duplicate records and also reduces the total bytes sent (and corresponding charges). We recommend that you handle any duplicates at the destination. If PutRecordBatch throws ServiceUnavailableException, the API is automatically reinvoked (retried) 3 times. If the exception persists, it is possible that the throughput limits have been exceeded for the Firehose stream. Re-invoking the Put API operations (for example, PutRecord and PutRecordBatch) can result in data duplicates. For larger data assets, allow for a longer time out before retrying Put API operations. Data records sent to Firehose are stored for 24 hours from the time they are added to a Firehose stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available. Don't concatenate two or more base64 strings to form the data fields of your records. Instead, concatenate the raw data, then perform base64 encoding.

Sourcemodule PutRecordBatchInput : sig ... end

Writes multiple data records into a Firehose stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a Firehose stream, use PutRecord. Applications using these operations are referred to as producers. Firehose accumulates and publishes a particular metric for a customer account in one minute intervals. It is possible that the bursts of incoming bytes/records ingested to a Firehose stream last only for a few seconds. Due to this, the actual spikes in the traffic might not be fully visible in the customer's 1 minute CloudWatch metrics. For information about service quota, see Amazon Firehose Quota. Each PutRecordBatch request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before base64 encoding), up to a limit of 4 MB for the entire request. These limits cannot be changed. You must specify the name of the Firehose stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data. For example, it could be a segment from a log file, geographic location data, website clickstream data, and so on. For multi record de-aggregation, you can not put more than 500 records even if the data blob length is less than 1000 KiB. If you include more than 500 records, the request succeeds but the record de-aggregation doesn't work as expected and transformation lambda is invoked with the complete base64 encoded data blob instead of de-aggregated base64 decoded records. Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination. The PutRecordBatch response includes a count of failed records, FailedPutCount, and an array of responses, RequestResponses. Even if the PutRecordBatch call succeeds, the value of FailedPutCount may be greater than 0, indicating that there are records for which the operation didn't succeed. Each entry in the RequestResponses array provides additional information about the processed record. It directly correlates with a record in the request array using the same ordering, from the top to the bottom. The response array always includes the same number of records as the request array. RequestResponses includes both successfully and unsuccessfully processed records. Firehose tries to process all records in each PutRecordBatch request. A single record failure does not stop the processing of subsequent records. A successfully processed record includes a RecordId value, which is unique for the record. An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error, and is one of the following values: ServiceUnavailableException or InternalFailure. ErrorMessage provides more detailed information about the error. If there is an internal server error or a timeout, the write might have completed or it might have failed. If FailedPutCount is greater than 0, retry the request, resending only those records that might have failed processing. This minimizes the possible duplicate records and also reduces the total bytes sent (and corresponding charges). We recommend that you handle any duplicates at the destination. If PutRecordBatch throws ServiceUnavailableException, the API is automatically reinvoked (retried) 3 times. If the exception persists, it is possible that the throughput limits have been exceeded for the Firehose stream. Re-invoking the Put API operations (for example, PutRecord and PutRecordBatch) can result in data duplicates. For larger data assets, allow for a longer time out before retrying Put API operations. Data records sent to Firehose are stored for 24 hours from the time they are added to a Firehose stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available. Don't concatenate two or more base64 strings to form the data fields of your records. Instead, concatenate the raw data, then perform base64 encoding.

Sourcemodule ListTagsForDeliveryStreamOutput : sig ... end

Lists the tags for the specified Firehose stream. This operation has a limit of five transactions per second per account.

Sourcemodule ListTagsForDeliveryStreamInput : sig ... end

Lists the tags for the specified Firehose stream. This operation has a limit of five transactions per second per account.

Sourcemodule ListDeliveryStreamsOutput : sig ... end

Lists your Firehose streams in alphabetical order of their names. The number of Firehose streams might be too large to return using a single call to ListDeliveryStreams. You can limit the number of Firehose streams returned, using the Limit parameter. To determine whether there are more delivery streams to list, check the value of HasMoreDeliveryStreams in the output. If there are more Firehose streams to list, you can request them by calling this operation again and setting the ExclusiveStartDeliveryStreamName parameter to the name of the last Firehose stream returned in the last call.

Sourcemodule ListDeliveryStreamsInput : sig ... end

Lists your Firehose streams in alphabetical order of their names. The number of Firehose streams might be too large to return using a single call to ListDeliveryStreams. You can limit the number of Firehose streams returned, using the Limit parameter. To determine whether there are more delivery streams to list, check the value of HasMoreDeliveryStreams in the output. If there are more Firehose streams to list, you can request them by calling this operation again and setting the ExclusiveStartDeliveryStreamName parameter to the name of the last Firehose stream returned in the last call.

Sourcemodule DescribeDeliveryStreamOutput : sig ... end

Describes the specified Firehose stream and its status. For example, after your Firehose stream is created, call DescribeDeliveryStream to see whether the Firehose stream is ACTIVE and therefore ready for data to be sent to it. If the status of a Firehose stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it. If the status is DELETING_FAILED, you can force deletion by invoking DeleteDeliveryStream again but with DeleteDeliveryStreamInput$AllowForceDelete set to true.

Sourcemodule DescribeDeliveryStreamInput : sig ... end

Describes the specified Firehose stream and its status. For example, after your Firehose stream is created, call DescribeDeliveryStream to see whether the Firehose stream is ACTIVE and therefore ready for data to be sent to it. If the status of a Firehose stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it. If the status is DELETING_FAILED, you can force deletion by invoking DeleteDeliveryStream again but with DeleteDeliveryStreamInput$AllowForceDelete set to true.

Sourcemodule DeleteDeliveryStreamOutput : sig ... end

Deletes a Firehose stream and its data. You can delete a Firehose stream only if it is in one of the following states: ACTIVE, DELETING, CREATING_FAILED, or DELETING_FAILED. You can't delete a Firehose stream that is in the CREATING state. To check the state of a Firehose stream, use DescribeDeliveryStream. DeleteDeliveryStream is an asynchronous API. When an API request to DeleteDeliveryStream succeeds, the Firehose stream is marked for deletion, and it goes into the DELETING state.While the Firehose stream is in the DELETING state, the service might continue to accept records, but it doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, first stop any applications that are sending records before you delete a Firehose stream. Removal of a Firehose stream that is in the DELETING state is a low priority operation for the service. A stream may remain in the DELETING state for several minutes. Therefore, as a best practice, applications should not wait for streams in the DELETING state to be removed.

Sourcemodule DeleteDeliveryStreamInput : sig ... end

Deletes a Firehose stream and its data. You can delete a Firehose stream only if it is in one of the following states: ACTIVE, DELETING, CREATING_FAILED, or DELETING_FAILED. You can't delete a Firehose stream that is in the CREATING state. To check the state of a Firehose stream, use DescribeDeliveryStream. DeleteDeliveryStream is an asynchronous API. When an API request to DeleteDeliveryStream succeeds, the Firehose stream is marked for deletion, and it goes into the DELETING state.While the Firehose stream is in the DELETING state, the service might continue to accept records, but it doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, first stop any applications that are sending records before you delete a Firehose stream. Removal of a Firehose stream that is in the DELETING state is a low priority operation for the service. A stream may remain in the DELETING state for several minutes. Therefore, as a best practice, applications should not wait for streams in the DELETING state to be removed.

Sourcemodule CreateDeliveryStreamOutput : sig ... end

Creates a Firehose stream. By default, you can create up to 5,000 Firehose streams per Amazon Web Services Region. This is an asynchronous operation that immediately returns. The initial status of the Firehose stream is CREATING. After the Firehose stream is created, its status is ACTIVE and it now accepts data. If the Firehose stream creation fails, the status transitions to CREATING_FAILED. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a Firehose stream, use DescribeDeliveryStream. If the status of a Firehose stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it. A Firehose stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the KinesisStreamSourceConfiguration parameter. To create a Firehose stream with server-side encryption (SSE) enabled, include DeliveryStreamEncryptionConfigurationInput in your request. This is optional. You can also invoke StartDeliveryStreamEncryption to turn on SSE for an existing Firehose stream that doesn't have SSE enabled. A Firehose stream is configured with a single destination, such as Amazon Simple Storage Service (Amazon S3), Amazon Redshift, Amazon OpenSearch Service, Amazon OpenSearch Serverless, Splunk, and any custom HTTP endpoint or HTTP endpoints owned by or supported by third-party service providers, including Datadog, Dynatrace, LogicMonitor, MongoDB, New Relic, and Sumo Logic. You must specify only one of the following destination configuration parameters: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration, or SplunkDestinationConfiguration. When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries might be such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3. A few notes about Amazon Redshift as a destination: An Amazon Redshift destination requires an S3 bucket as intermediate location. Firehose first delivers data to Amazon S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter. The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats. We strongly recommend that you use the user name and password you provide exclusively with Firehose, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions. Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see Grant Firehose Access to an Amazon S3 Destination in the Amazon Firehose Developer Guide.

Sourcemodule CreateDeliveryStreamInput : sig ... end

Creates a Firehose stream. By default, you can create up to 5,000 Firehose streams per Amazon Web Services Region. This is an asynchronous operation that immediately returns. The initial status of the Firehose stream is CREATING. After the Firehose stream is created, its status is ACTIVE and it now accepts data. If the Firehose stream creation fails, the status transitions to CREATING_FAILED. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a Firehose stream, use DescribeDeliveryStream. If the status of a Firehose stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it. A Firehose stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the KinesisStreamSourceConfiguration parameter. To create a Firehose stream with server-side encryption (SSE) enabled, include DeliveryStreamEncryptionConfigurationInput in your request. This is optional. You can also invoke StartDeliveryStreamEncryption to turn on SSE for an existing Firehose stream that doesn't have SSE enabled. A Firehose stream is configured with a single destination, such as Amazon Simple Storage Service (Amazon S3), Amazon Redshift, Amazon OpenSearch Service, Amazon OpenSearch Serverless, Splunk, and any custom HTTP endpoint or HTTP endpoints owned by or supported by third-party service providers, including Datadog, Dynatrace, LogicMonitor, MongoDB, New Relic, and Sumo Logic. You must specify only one of the following destination configuration parameters: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration, or SplunkDestinationConfiguration. When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries might be such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3. A few notes about Amazon Redshift as a destination: An Amazon Redshift destination requires an S3 bucket as intermediate location. Firehose first delivers data to Amazon S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter. The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats. We strongly recommend that you use the user name and password you provide exclusively with Firehose, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions. Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see Grant Firehose Access to an Amazon S3 Destination in the Amazon Firehose Developer Guide.