Module Smaws_Client_Firehose.Types

type nonrec warehouse_location = string
type nonrec vpc_endpoint_service_name = string
type nonrec non_empty_string_without_whitespace = string
type nonrec subnet_id_list = non_empty_string_without_whitespace list
type nonrec role_ar_n = string
type nonrec security_group_id_list = non_empty_string_without_whitespace list
type nonrec vpc_configuration_description = {
  1. vpc_id : non_empty_string_without_whitespace;
    (*

    The ID of the Amazon OpenSearch Service destination's VPC.

    *)
  2. security_group_ids : security_group_id_list;
    (*

    The IDs of the security groups that Firehose uses when it creates ENIs in the VPC of the Amazon OpenSearch Service destination. You can use the same security group that the Amazon ES domain uses or different ones. If you specify different security groups, ensure that they allow outbound HTTPS traffic to the Amazon OpenSearch Service domain's security group. Also ensure that the Amazon OpenSearch Service domain's security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your Firehose stream and the Amazon OpenSearch Service domain, make sure the security group inbound rule allows HTTPS traffic. For more information about security group rules, see Security group rules in the Amazon VPC documentation.

    *)
  3. role_ar_n : role_ar_n;
    (*

    The ARN of the IAM role that the Firehose stream uses to create endpoints in the destination VPC. You can use your existing Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Firehose service principal and that it grants the following permissions:

    • ec2:DescribeVpcs
    • ec2:DescribeVpcAttribute
    • ec2:DescribeSubnets
    • ec2:DescribeSecurityGroups
    • ec2:DescribeNetworkInterfaces
    • ec2:CreateNetworkInterface
    • ec2:CreateNetworkInterfacePermission
    • ec2:DeleteNetworkInterface

    If you revoke these permissions after you create the Firehose stream, Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.

    *)
  4. subnet_ids : subnet_id_list;
    (*

    The IDs of the subnets that Firehose uses to create ENIs in the VPC of the Amazon OpenSearch Service destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon OpenSearch Service endpoints. Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.

    The number of ENIs that Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Firehose can create up to three ENIs for this Firehose stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.

    *)
}

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

type nonrec vpc_configuration = {
  1. security_group_ids : security_group_id_list;
    (*

    The IDs of the security groups that you want Firehose to use when it creates ENIs in the VPC of the Amazon OpenSearch Service destination. You can use the same security group that the Amazon OpenSearch Service domain uses or different ones. If you specify different security groups here, ensure that they allow outbound HTTPS traffic to the Amazon OpenSearch Service domain's security group. Also ensure that the Amazon OpenSearch Service domain's security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your delivery stream and the Amazon OpenSearch Service domain, make sure the security group inbound rule allows HTTPS traffic. For more information about security group rules, see Security group rules in the Amazon VPC documentation.

    *)
  2. role_ar_n : role_ar_n;
    (*

    The ARN of the IAM role that you want the Firehose stream to use to create endpoints in the destination VPC. You can use your existing Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Firehose service principal and that it grants the following permissions:

    • ec2:DescribeVpcs
    • ec2:DescribeVpcAttribute
    • ec2:DescribeSubnets
    • ec2:DescribeSecurityGroups
    • ec2:DescribeNetworkInterfaces
    • ec2:CreateNetworkInterface
    • ec2:CreateNetworkInterfacePermission
    • ec2:DeleteNetworkInterface

    When you specify subnets for delivering data to the destination in a private VPC, make sure you have enough number of free IP addresses in chosen subnets. If there is no available free IP address in a specified subnet, Firehose cannot create or add ENIs for the data delivery in the private VPC, and the delivery will be degraded or fail.

    *)
  3. subnet_ids : subnet_id_list;
    (*

    The IDs of the subnets that you want Firehose to use to create ENIs in the VPC of the Amazon OpenSearch Service destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon OpenSearch Service endpoints. Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.

    The number of ENIs that Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Firehose can create up to three ENIs for this Firehose stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.

    *)
}

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

type nonrec username = string
type nonrec update_destination_output = unit
type nonrec delivery_stream_name = string
type nonrec delivery_stream_version_id = string
type nonrec destination_id = string
type nonrec bucket_ar_n = string
type nonrec prefix = string
type nonrec error_output_prefix = string
type nonrec size_in_m_bs = int
type nonrec interval_in_seconds = int
type nonrec buffering_hints = {
  1. interval_in_seconds : interval_in_seconds option;
    (*

    Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300. This parameter is optional but if you specify a value for it, you must also specify a value for SizeInMBs, and vice versa.

    *)
  2. size_in_m_bs : size_in_m_bs option;
    (*

    Buffer incoming data to the specified size, in MiBs, before delivering it to the destination. The default value is 5. This parameter is optional but if you specify a value for it, you must also specify a value for IntervalInSeconds, and vice versa.

    We recommend setting this parameter to a value greater than the amount of data you typically ingest into the Firehose stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.

    *)
}

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.

type nonrec compression_format =
  1. | HADOOP_SNAPPY
  2. | SNAPPY
  3. | ZIP
  4. | GZIP
  5. | UNCOMPRESSED
type nonrec no_encryption_config =
  1. | NoEncryption
type nonrec awskms_key_ar_n = string
type nonrec kms_encryption_config = {
  1. awskms_key_ar_n : awskms_key_ar_n;
    (*

    The Amazon Resource Name (ARN) of the encryption key. Must belong to the same Amazon Web Services Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    *)
}

Describes an encryption key for a destination in Amazon S3.

type nonrec encryption_configuration = {
  1. kms_encryption_config : kms_encryption_config option;
    (*

    The encryption key.

    *)
  2. no_encryption_config : no_encryption_config option;
    (*

    Specifically override existing encryption information to ensure that no encryption is used.

    *)
}

Describes the encryption for a destination in Amazon S3.

type nonrec boolean_object = bool
type nonrec log_group_name = string
type nonrec log_stream_name = string
type nonrec cloud_watch_logging_options = {
  1. log_stream_name : log_stream_name option;
    (*

    The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

    *)
  2. log_group_name : log_group_name option;
    (*

    The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

    *)
  3. enabled : boolean_object option;
    (*

    Enables or disables CloudWatch logging.

    *)
}

Describes the Amazon CloudWatch logging options for your Firehose stream.

type nonrec s3_destination_update = {
  1. cloud_watch_logging_options : cloud_watch_logging_options option;
    (*

    The CloudWatch logging options for your Firehose stream.

    *)
  2. encryption_configuration : encryption_configuration option;
    (*

    The encryption configuration. If no value is specified, the default is no encryption.

    *)
  3. compression_format : compression_format option;
    (*

    The compression format. If no value is specified, the default is UNCOMPRESSED.

    The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

    *)
  4. buffering_hints : buffering_hints option;
    (*

    The buffering option. If no value is specified, BufferingHints object default values are used.

    *)
  5. error_output_prefix : error_output_prefix option;
    (*

    A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

    *)
  6. prefix : prefix option;
    (*

    The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

    *)
  7. bucket_ar_n : bucket_ar_n option;
    (*

    The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    *)
  8. role_ar_n : role_ar_n option;
    (*

    The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    *)
}

Describes an update for a destination in Amazon S3.

type nonrec processor_type =
  1. | AppendDelimiterToRecord
  2. | MetadataExtraction
  3. | Lambda
  4. | CloudWatchLogProcessing
  5. | Decompression
  6. | RecordDeAggregation
type nonrec processor_parameter_name =
  1. | DATA_MESSAGE_EXTRACTION
  2. | COMPRESSION_FORMAT
  3. | Delimiter
  4. | SUB_RECORD_TYPE
  5. | BUFFER_INTERVAL_IN_SECONDS
  6. | BUFFER_SIZE_IN_MB
  7. | ROLE_ARN
  8. | JSON_PARSING_ENGINE
  9. | METADATA_EXTRACTION_QUERY
  10. | LAMBDA_NUMBER_OF_RETRIES
  11. | LAMBDA_ARN
type nonrec processor_parameter_value = string
type nonrec processor_parameter = {
  1. parameter_value : processor_parameter_value;
    (*

    The parameter value.

    *)
  2. parameter_name : processor_parameter_name;
    (*

    The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds. The BufferSizeInMBs ranges between 0.2 MB and up to 3MB. The default buffering hint is 1MB for all destinations, except Splunk. For Splunk, the default buffering hint is 256 KB.

    *)
}

Describes the processor parameter.

type nonrec processor_parameter_list = processor_parameter list
type nonrec processor = {
  1. parameters : processor_parameter_list option;
    (*

    The processor parameters.

    *)
  2. type_ : processor_type;
    (*

    The type of processor.

    *)
}

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.

type nonrec processor_list = processor list
type nonrec processing_configuration = {
  1. processors : processor_list option;
    (*

    The data processors.

    *)
  2. enabled : boolean_object option;
    (*

    Enables or disables data processing.

    *)
}

Describes a data processing configuration.

type nonrec s3_backup_mode =
  1. | Enabled
  2. | Disabled
type nonrec schema_configuration = {
  1. version_id : non_empty_string_without_whitespace option;
    (*

    Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

    *)
  2. region : non_empty_string_without_whitespace option;
    (*

    If you don't specify an Amazon Web Services Region, the default is the current Region.

    *)
  3. table_name : non_empty_string_without_whitespace option;
    (*

    Specifies the Amazon Web Services Glue table that contains the column information that constitutes your data schema.

    If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the TableName property is required and its value must be specified.

    *)
  4. database_name : non_empty_string_without_whitespace option;
    (*

    Specifies the name of the Amazon Web Services Glue database that contains the schema for the output data.

    If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the DatabaseName property is required and its value must be specified.

    *)
  5. catalog_id : non_empty_string_without_whitespace option;
    (*

    The ID of the Amazon Web Services Glue Data Catalog. If you don't supply this, the Amazon Web Services account ID is used by default.

    *)
  6. role_ar_n : non_empty_string_without_whitespace option;
    (*

    The role that Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Firehose. Cross-account roles aren't allowed.

    If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.

    *)
}

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.

type nonrec non_empty_string = string
type nonrec column_to_json_key_mappings = (non_empty_string_without_whitespace * non_empty_string) list
type nonrec open_x_json_ser_de = {
  1. column_to_json_key_mappings : column_to_json_key_mappings option;
    (*

    Maps column names to JSON keys that aren't identical to the column names. This is useful when the JSON contains keys that are Hive keywords. For example, timestamp is a Hive keyword. If you have a JSON key named timestamp, set this parameter to {"ts": "timestamp"} to map this key to a column named ts.

    *)
  2. case_insensitive : boolean_object option;
    (*

    When set to true, which is the default, Firehose converts JSON keys to lowercase before deserializing them.

    *)
  3. convert_dots_in_json_keys_to_underscores : boolean_object option;
    (*

    When set to true, specifies that the names of the keys include dots and that you want Firehose to replace them with underscores. This is useful because Apache Hive does not allow dots in column names. For example, if the JSON contains a key whose name is "a.b", you can define the column name to be "a_b" when using this option.

    The default is false.

    *)
}

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.

type nonrec list_of_non_empty_strings = non_empty_string list
type nonrec hive_json_ser_de = {
  1. timestamp_formats : list_of_non_empty_strings option;
    (*

    Indicates how you want Firehose to parse the date and timestamps that may be present in your input data JSON. To specify these format strings, follow the pattern syntax of JodaTime's DateTimeFormat format strings. For more information, see Class DateTimeFormat. You can also use the special value millis to parse timestamps in epoch milliseconds. If you don't specify a format, Firehose uses java.sql.Timestamp::valueOf by default.

    *)
}

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.

type nonrec deserializer = {
  1. hive_json_ser_de : hive_json_ser_de option;
    (*

    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.

    *)
  2. open_x_json_ser_de : open_x_json_ser_de option;
    (*

    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.

    *)
}

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.

type nonrec input_format_configuration = {
  1. deserializer : deserializer option;
    (*

    Specifies which deserializer to use. You can choose either the Apache Hive JSON SerDe or the OpenX JSON SerDe. If both are non-null, the server rejects the request.

    *)
}

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.

type nonrec block_size_bytes = int
type nonrec parquet_page_size_bytes = int
type nonrec parquet_compression =
  1. | SNAPPY
  2. | GZIP
  3. | UNCOMPRESSED
type nonrec non_negative_integer_object = int
type nonrec parquet_writer_version =
  1. | V2
  2. | V1
type nonrec parquet_ser_de = {
  1. writer_version : parquet_writer_version option;
    (*

    Indicates the version of row format to output. The possible values are V1 and V2. The default is V1.

    *)
  2. max_padding_bytes : non_negative_integer_object option;
    (*

    The maximum amount of padding to apply. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 0.

    *)
  3. enable_dictionary_compression : boolean_object option;
    (*

    Indicates whether to enable dictionary compression.

    *)
  4. compression : parquet_compression option;
    (*

    The compression code to use over data blocks. The possible values are UNCOMPRESSED, SNAPPY, and GZIP, with the default being SNAPPY. Use SNAPPY for higher decompression speed. Use GZIP if the compression ratio is more important than speed.

    *)
  5. page_size_bytes : parquet_page_size_bytes option;
    (*

    The Parquet page size. Column chunks are divided into pages. A page is conceptually an indivisible unit (in terms of compression and encoding). The minimum value is 64 KiB and the default is 1 MiB.

    *)
  6. block_size_bytes : block_size_bytes option;
    (*

    The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Firehose uses this value for padding calculations.

    *)
}

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

type nonrec orc_stripe_size_bytes = int
type nonrec orc_row_index_stride = int
type nonrec proportion = float
type nonrec orc_compression =
  1. | SNAPPY
  2. | ZLIB
  3. | NONE
type nonrec list_of_non_empty_strings_without_whitespace = non_empty_string_without_whitespace list
type nonrec orc_format_version =
  1. | V0_12
  2. | V0_11
type nonrec orc_ser_de = {
  1. format_version : orc_format_version option;
    (*

    The version of the file to write. The possible values are V0_11 and V0_12. The default is V0_12.

    *)
  2. dictionary_key_threshold : proportion option;
    (*

    Represents the fraction of the total number of non-null rows. To turn off dictionary encoding, set this fraction to a number that is less than the number of distinct keys in a dictionary. To always use dictionary encoding, set this threshold to 1.

    *)
  3. bloom_filter_false_positive_probability : proportion option;
    (*

    The Bloom filter false positive probability (FPP). The lower the FPP, the bigger the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1.

    *)
  4. bloom_filter_columns : list_of_non_empty_strings_without_whitespace option;
    (*

    The column names for which you want Firehose to create bloom filters. The default is null.

    *)
  5. compression : orc_compression option;
    (*

    The compression code to use over data blocks. The default is SNAPPY.

    *)
  6. padding_tolerance : proportion option;
    (*

    A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size. The default value is 0.05, which means 5 percent of stripe size.

    For the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the default block padding tolerance of 5 percent reserves a maximum of 3.2 MiB for padding within the 256 MiB block. In such a case, if the available size within the block is more than 3.2 MiB, a new, smaller stripe is inserted to fit within that space. This ensures that no stripe crosses block boundaries and causes remote reads within a node-local task.

    Firehose ignores this parameter when OrcSerDe$EnablePadding is false.

    *)
  7. enable_padding : boolean_object option;
    (*

    Set this to true to indicate that you want stripes to be padded to the HDFS block boundaries. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is false.

    *)
  8. row_index_stride : orc_row_index_stride option;
    (*

    The number of rows between index entries. The default is 10,000 and the minimum is 1,000.

    *)
  9. block_size_bytes : block_size_bytes option;
    (*

    The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Firehose uses this value for padding calculations.

    *)
  10. stripe_size_bytes : orc_stripe_size_bytes option;
    (*

    The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.

    *)
}

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

type nonrec serializer = {
  1. orc_ser_de : orc_ser_de option;
    (*

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

    *)
  2. parquet_ser_de : parquet_ser_de option;
    (*

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

    *)
}

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.

type nonrec output_format_configuration = {
  1. serializer : serializer option;
    (*

    Specifies which serializer to use. You can choose either the ORC SerDe or the Parquet SerDe. If both are non-null, the server rejects the request.

    *)
}

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.

type nonrec data_format_conversion_configuration = {
  1. enabled : boolean_object option;
    (*

    Defaults to true. Set it to false if you want to disable format conversion while preserving the configuration details.

    *)
  2. output_format_configuration : output_format_configuration option;
    (*

    Specifies the serializer that you want Firehose to use to convert the format of your data to the Parquet or ORC format. This parameter is required if Enabled is set to true.

    *)
  3. input_format_configuration : input_format_configuration option;
    (*

    Specifies the deserializer that you want Firehose to use to convert the format of your data from JSON. This parameter is required if Enabled is set to true.

    *)
  4. schema_configuration : schema_configuration option;
    (*

    Specifies the Amazon Web Services Glue Data Catalog table that contains the column information. This parameter is required if Enabled is set to true.

    *)
}

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.

type nonrec retry_duration_in_seconds = int
type nonrec retry_options = {
  1. duration_in_seconds : retry_duration_in_seconds option;
    (*

    The period of time during which Firehose retries to deliver data to the specified destination.

    *)
}

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

type nonrec dynamic_partitioning_configuration = {
  1. enabled : boolean_object option;
    (*

    Specifies that the dynamic partitioning is enabled for this Firehose stream.

    *)
  2. retry_options : retry_options option;
    (*

    The retry behavior in case Firehose is unable to deliver data to an Amazon S3 prefix.

    *)
}

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.

type nonrec file_extension = string
type nonrec custom_time_zone = string
type nonrec extended_s3_destination_update = {
  1. custom_time_zone : custom_time_zone option;
    (*

    The time zone you prefer. UTC is the default.

    *)
  2. file_extension : file_extension option;
    (*

    Specify a file extension. It will override the default file extension

    *)
  3. dynamic_partitioning_configuration : dynamic_partitioning_configuration option;
    (*

    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.

    *)
  4. data_format_conversion_configuration : data_format_conversion_configuration option;
    (*

    The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

    *)
  5. s3_backup_update : s3_destination_update option;
    (*

    The Amazon S3 destination for backup.

    *)
  6. s3_backup_mode : s3_backup_mode option;
    (*

    You can update a Firehose stream to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the Firehose stream to disable it.

    *)
  7. processing_configuration : processing_configuration option;
    (*

    The data processing configuration.

    *)
  8. cloud_watch_logging_options : cloud_watch_logging_options option;
    (*

    The Amazon CloudWatch logging options for your Firehose stream.

    *)
  9. encryption_configuration : encryption_configuration option;
    (*

    The encryption configuration. If no value is specified, the default is no encryption.

    *)
  10. compression_format : compression_format option;
    (*

    The compression format. If no value is specified, the default is UNCOMPRESSED.

    *)
  11. buffering_hints : buffering_hints option;
    (*

    The buffering option.

    *)
  12. error_output_prefix : error_output_prefix option;
    (*

    A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

    *)
  13. prefix : prefix option;
    (*

    The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

    *)
  14. bucket_ar_n : bucket_ar_n option;
    (*

    The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    *)
  15. role_ar_n : role_ar_n option;
    (*

    The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    *)
}

Describes an update for a destination in Amazon S3.

type nonrec cluster_jdbcur_l = string
type nonrec data_table_name = string
type nonrec data_table_columns = string
type nonrec copy_options = string
type nonrec copy_command = {
  1. copy_options : copy_options option;
    (*

    Optional parameters to use with the Amazon Redshift COPY command. For more information, see the "Optional Parameters" section of Amazon Redshift COPY command. Some possible examples that would apply to Firehose are as follows:

    delimiter '\t' lzop; - fields are delimited with "\t" (TAB character) and compressed using lzop.

    delimiter '|' - fields are delimited with "|" (this is the default delimiter).

    delimiter '|' escape - the delimiter should be escaped.

    fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' - fields are fixed width in the source, with each width specified after every column in the table.

    JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and the path specified is the format of the data.

    For more examples, see Amazon Redshift COPY command examples.

    *)
  2. data_table_columns : data_table_columns option;
    (*

    A comma-separated list of column names.

    *)
  3. data_table_name : data_table_name;
    (*

    The name of the target table. The table must already exist in the database.

    *)
}

Describes a COPY command for Amazon Redshift.

type nonrec password = string
type nonrec redshift_retry_duration_in_seconds = int
type nonrec redshift_retry_options = {
  1. duration_in_seconds : redshift_retry_duration_in_seconds option;
    (*

    The length of time during which Firehose retries delivery after a failure, starting from the initial request and including the first attempt. The default value is 3600 seconds (60 minutes). Firehose does not retry if the value of DurationInSeconds is 0 (zero) or if the first delivery attempt takes longer than the current value.

    *)
}

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

type nonrec redshift_s3_backup_mode =
  1. | Enabled
  2. | Disabled
type nonrec secret_ar_n = string
type nonrec secrets_manager_configuration = {
  1. enabled : boolean_object;
    (*

    Specifies whether you want to use the secrets manager feature. When set as True the secrets manager configuration overwrites the existing secrets in the destination configuration. When it's set to False Firehose falls back to the credentials in the destination configuration.

    *)
  2. role_ar_n : role_ar_n option;
    (*

    Specifies the role that Firehose assumes when calling the Secrets Manager API operation. When you provide the role, it overrides any destination specific role defined in the destination configuration. If you do not provide the then we use the destination specific role. This parameter is required for Splunk.

    *)
  3. secret_ar_n : secret_ar_n option;
    (*

    The ARN of the secret that stores your credentials. It must be in the same region as the Firehose stream and the role. The secret ARN can reside in a different account than the Firehose stream and role as Firehose supports cross-account secret access. This parameter is required when Enabled is set to True.

    *)
}

The structure that defines how Firehose accesses the secret.

type nonrec redshift_destination_update = {
  1. secrets_manager_configuration : secrets_manager_configuration option;
    (*

    The configuration that defines how you access secrets for Amazon Redshift.

    *)
  2. cloud_watch_logging_options : cloud_watch_logging_options option;
    (*

    The Amazon CloudWatch logging options for your Firehose stream.

    *)
  3. s3_backup_update : s3_destination_update option;
    (*

    The Amazon S3 destination for backup.

    *)
  4. s3_backup_mode : redshift_s3_backup_mode option;
    (*

    You can update a Firehose stream to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the Firehose stream to disable it.

    *)
  5. processing_configuration : processing_configuration option;
    (*

    The data processing configuration.

    *)
  6. s3_update : s3_destination_update option;
    (*

    The Amazon S3 destination.

    The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationUpdate.S3Update because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.

    *)
  7. retry_options : redshift_retry_options option;
    (*

    The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

    *)
  8. password : password option;
    (*

    The user password.

    *)
  9. username : username option;
    (*

    The name of the user.

    *)
  10. copy_command : copy_command option;
    (*

    The COPY command.

    *)
  11. cluster_jdbcur_l : cluster_jdbcur_l option;
    (*

    The database connection string.

    *)
  12. role_ar_n : role_ar_n option;
    (*

    The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    *)
}

Describes an update for a destination in Amazon Redshift.

type nonrec elasticsearch_domain_ar_n = string
type nonrec elasticsearch_cluster_endpoint = string
type nonrec elasticsearch_index_name = string
type nonrec elasticsearch_type_name = string
type nonrec elasticsearch_index_rotation_period =
  1. | OneMonth
  2. | OneWeek
  3. | OneDay
  4. | OneHour
  5. | NoRotation
type nonrec elasticsearch_buffering_interval_in_seconds = int
type nonrec elasticsearch_buffering_size_in_m_bs = int
type nonrec elasticsearch_buffering_hints = {
  1. size_in_m_bs : elasticsearch_buffering_size_in_m_bs option;
    (*

    Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

    We recommend setting this parameter to a value greater than the amount of data you typically ingest into the Firehose stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.

    *)
  2. interval_in_seconds : elasticsearch_buffering_interval_in_seconds option;
    (*

    Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).

    *)
}

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

type nonrec elasticsearch_retry_duration_in_seconds = int
type nonrec elasticsearch_retry_options = {
  1. duration_in_seconds : elasticsearch_retry_duration_in_seconds option;
    (*

    After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during which Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.

    *)
}

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

type nonrec default_document_id_format =
  1. | NO_DOCUMENT_ID
  2. | FIREHOSE_DEFAULT
type nonrec document_id_options = {
  1. default_document_id_format : default_document_id_format;
    (*

    When the FIREHOSE_DEFAULT option is chosen, Firehose generates a unique document ID for each record based on a unique internal identifier. The generated document ID is stable across multiple delivery attempts, which helps prevent the same record from being indexed multiple times with different document IDs.

    When the NO_DOCUMENT_ID option is chosen, Firehose does not include any document IDs in the requests it sends to the Amazon OpenSearch Service. This causes the Amazon OpenSearch Service domain to generate document IDs. In case of multiple delivery attempts, this may cause the same record to be indexed more than once with different document IDs. This option enables write-heavy operations, such as the ingestion of logs and observability data, to consume less resources in the Amazon OpenSearch Service domain, resulting in improved performance.

    *)
}

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

type nonrec elasticsearch_destination_update = {
  1. document_id_options : document_id_options option;
    (*

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

    *)
  2. cloud_watch_logging_options : cloud_watch_logging_options option;
    (*

    The CloudWatch logging options for your Firehose stream.

    *)
  3. processing_configuration : processing_configuration option;
    (*

    The data processing configuration.

    *)
  4. s3_update : s3_destination_update option;
    (*

    The Amazon S3 destination.

    *)
  5. retry_options : elasticsearch_retry_options option;
    (*

    The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).

    *)
  6. buffering_hints : elasticsearch_buffering_hints option;
    (*

    The buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.

    *)
  7. index_rotation_period : elasticsearch_index_rotation_period option;
    (*

    The Elasticsearch index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon OpenSearch Service Destination. Default value is OneDay.

    *)
  8. type_name : elasticsearch_type_name option;
    (*

    The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Firehose returns an error during runtime.

    If you upgrade Elasticsearch from 6.x to 7.x and don’t update your Firehose stream, Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your Firehose stream with a new index name, provide an empty string for TypeName.

    *)
  9. index_name : elasticsearch_index_name option;
    (*

    The Elasticsearch index name.

    *)
  10. cluster_endpoint : elasticsearch_cluster_endpoint option;
    (*

    The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

    *)
  11. domain_ar_n : elasticsearch_domain_ar_n option;
    (*

    The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    Specify either ClusterEndpoint or DomainARN.

    *)
  12. role_ar_n : role_ar_n option;
    (*

    The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents. For more information, see Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    *)
}

Describes an update for a destination in Amazon OpenSearch Service.

type nonrec amazonopensearchservice_domain_ar_n = string
type nonrec amazonopensearchservice_cluster_endpoint = string
type nonrec amazonopensearchservice_index_name = string
type nonrec amazonopensearchservice_type_name = string
type nonrec amazonopensearchservice_index_rotation_period =
  1. | OneMonth
  2. | OneWeek
  3. | OneDay
  4. | OneHour
  5. | NoRotation
type nonrec amazonopensearchservice_buffering_interval_in_seconds = int
type nonrec amazonopensearchservice_buffering_size_in_m_bs = int
type nonrec amazonopensearchservice_buffering_hints = {
  1. size_in_m_bs : amazonopensearchservice_buffering_size_in_m_bs option;
    (*

    Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

    We recommend setting this parameter to a value greater than the amount of data you typically ingest into the Firehose stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.

    *)
  2. interval_in_seconds : amazonopensearchservice_buffering_interval_in_seconds option;
    (*

    Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).

    *)
}

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

type nonrec amazonopensearchservice_retry_duration_in_seconds = int
type nonrec amazonopensearchservice_retry_options = {
  1. duration_in_seconds : amazonopensearchservice_retry_duration_in_seconds option;
    (*

    After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during which Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.

    *)
}

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

type nonrec amazonopensearchservice_destination_update = {
  1. document_id_options : document_id_options option;
    (*

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

    *)
  2. cloud_watch_logging_options : cloud_watch_logging_options option;
  3. processing_configuration : processing_configuration option;
  4. s3_update : s3_destination_update option;
  5. retry_options : amazonopensearchservice_retry_options option;
    (*

    The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).

    *)
  6. buffering_hints : amazonopensearchservice_buffering_hints option;
    (*

    The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.

    *)
  7. index_rotation_period : amazonopensearchservice_index_rotation_period option;
    (*

    The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.

    *)
  8. type_name : amazonopensearchservice_type_name option;
    (*

    The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Firehose returns an error during runtime.

    If you upgrade Elasticsearch from 6.x to 7.x and don’t update your Firehose stream, Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your Firehose stream with a new index name, provide an empty string for TypeName.

    *)
  9. index_name : amazonopensearchservice_index_name option;
    (*

    The Amazon OpenSearch Service index name.

    *)
  10. cluster_endpoint : amazonopensearchservice_cluster_endpoint option;
    (*

    The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

    *)
  11. domain_ar_n : amazonopensearchservice_domain_ar_n option;
    (*

    The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN.

    *)
  12. role_ar_n : role_ar_n option;
    (*

    The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.

    *)
}

Describes an update for a destination in Amazon OpenSearch Service.

type nonrec hec_endpoint = string
type nonrec hec_endpoint_type =
  1. | Event
  2. | Raw
type nonrec hec_token = string
type nonrec hec_acknowledgment_timeout_in_seconds = int
type nonrec splunk_retry_duration_in_seconds = int
type nonrec splunk_retry_options = {
  1. duration_in_seconds : splunk_retry_duration_in_seconds option;
    (*

    The total amount of time that Firehose spends on retries. This duration starts after the initial attempt to send data to Splunk fails. It doesn't include the periods during which Firehose waits for acknowledgment from Splunk after each attempt.

    *)
}

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

type nonrec splunk_s3_backup_mode =
  1. | AllEvents
  2. | FailedEventsOnly
type nonrec splunk_buffering_interval_in_seconds = int
type nonrec splunk_buffering_size_in_m_bs = int
type nonrec splunk_buffering_hints = {
  1. size_in_m_bs : splunk_buffering_size_in_m_bs option;
    (*

    Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

    *)
  2. interval_in_seconds : splunk_buffering_interval_in_seconds option;
    (*

    Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 60 (1 minute).

    *)
}

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

type nonrec splunk_destination_update = {
  1. secrets_manager_configuration : secrets_manager_configuration option;
    (*

    The configuration that defines how you access secrets for Splunk.

    *)
  2. buffering_hints : splunk_buffering_hints option;
    (*

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

    *)
  3. cloud_watch_logging_options : cloud_watch_logging_options option;
    (*

    The Amazon CloudWatch logging options for your Firehose stream.

    *)
  4. processing_configuration : processing_configuration option;
    (*

    The data processing configuration.

    *)
  5. s3_update : s3_destination_update option;
    (*

    Your update to the configuration of the backup Amazon S3 location.

    *)
  6. s3_backup_mode : splunk_s3_backup_mode option;
    (*

    Specifies how you want Firehose to back up documents to Amazon S3. When set to FailedDocumentsOnly, Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllEvents, Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value is FailedEventsOnly.

    You can update this backup mode from FailedEventsOnly to AllEvents. You can't update it from AllEvents to FailedEventsOnly.

    *)
  7. retry_options : splunk_retry_options option;
    (*

    The retry behavior in case Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.

    *)
  8. hec_acknowledgment_timeout_in_seconds : hec_acknowledgment_timeout_in_seconds option;
    (*

    The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends data. At the end of the timeout period, Firehose either tries to send the data again or considers it an error, based on your retry settings.

    *)
  9. hec_token : hec_token option;
    (*

    A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.

    *)
  10. hec_endpoint_type : hec_endpoint_type option;
    (*

    This type can be either "Raw" or "Event."

    *)
  11. hec_endpoint : hec_endpoint option;
    (*

    The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.

    *)
}

Describes an update for a destination in Splunk.

type nonrec http_endpoint_url = string
type nonrec http_endpoint_name = string
type nonrec http_endpoint_access_key = string
type nonrec http_endpoint_configuration = {
  1. access_key : http_endpoint_access_key option;
    (*

    The access key required for Kinesis Firehose to authenticate with the HTTP endpoint selected as the destination.

    *)
  2. name : http_endpoint_name option;
    (*

    The name of the HTTP endpoint selected as the destination.

    *)
  3. url : http_endpoint_url;
    (*

    The URL of the HTTP endpoint selected as the destination.

    If you choose an HTTP endpoint as your destination, review and follow the instructions in the Appendix - HTTP Endpoint Delivery Request and Response Specifications.

    *)
}

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

type nonrec http_endpoint_buffering_size_in_m_bs = int
type nonrec http_endpoint_buffering_interval_in_seconds = int
type nonrec http_endpoint_buffering_hints = {
  1. interval_in_seconds : http_endpoint_buffering_interval_in_seconds option;
    (*

    Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).

    *)
  2. size_in_m_bs : http_endpoint_buffering_size_in_m_bs option;
    (*

    Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

    We recommend setting this parameter to a value greater than the amount of data you typically ingest into the Firehose stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.

    *)
}

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.

type nonrec content_encoding =
  1. | GZIP
  2. | NONE
type nonrec http_endpoint_attribute_name = string
type nonrec http_endpoint_attribute_value = string
type nonrec http_endpoint_common_attribute = {
  1. attribute_value : http_endpoint_attribute_value;
    (*

    The value of the HTTP endpoint common attribute.

    *)
  2. attribute_name : http_endpoint_attribute_name;
    (*

    The name of the HTTP endpoint common attribute.

    *)
}

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

type nonrec http_endpoint_common_attributes_list = http_endpoint_common_attribute list
type nonrec http_endpoint_request_configuration = {
  1. common_attributes : http_endpoint_common_attributes_list option;
    (*

    Describes the metadata sent to the HTTP endpoint destination.

    *)
  2. content_encoding : content_encoding option;
    (*

    Firehose uses the content encoding to compress the body of a request before sending the request to the destination. For more information, see Content-Encoding in MDN Web Docs, the official Mozilla documentation.

    *)
}

The configuration of the HTTP endpoint request.

type nonrec http_endpoint_retry_duration_in_seconds = int
type nonrec http_endpoint_retry_options = {
  1. duration_in_seconds : http_endpoint_retry_duration_in_seconds option;
    (*

    The total amount of time that Firehose spends on retries. This duration starts after the initial attempt to send data to the custom destination via HTTPS endpoint fails. It doesn't include the periods during which Firehose waits for acknowledgment from the specified destination after each attempt.

    *)
}

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.

type nonrec http_endpoint_s3_backup_mode =
  1. | AllData
  2. | FailedDataOnly
type nonrec http_endpoint_destination_update = {
  1. secrets_manager_configuration : secrets_manager_configuration option;
    (*

    The configuration that defines how you access secrets for HTTP Endpoint destination.

    *)
  2. s3_update : s3_destination_update option;
  3. s3_backup_mode : http_endpoint_s3_backup_mode option;
    (*

    Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData) or only the documents that Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).

    *)
  4. retry_options : http_endpoint_retry_options option;
    (*

    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.

    *)
  5. role_ar_n : role_ar_n option;
    (*

    Firehose uses this IAM role for all the permissions that the delivery stream needs.

    *)
  6. processing_configuration : processing_configuration option;
  7. request_configuration : http_endpoint_request_configuration option;
    (*

    The configuration of the request sent to the HTTP endpoint specified as the destination.

    *)
  8. cloud_watch_logging_options : cloud_watch_logging_options option;
  9. buffering_hints : http_endpoint_buffering_hints option;
    (*

    Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint destination. Firehose teats 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.

    *)
  10. endpoint_configuration : http_endpoint_configuration option;
    (*

    Describes the configuration of the HTTP endpoint destination.

    *)
}

Updates the specified HTTP endpoint destination.

type nonrec amazon_open_search_serverless_collection_endpoint = string
type nonrec amazon_open_search_serverless_index_name = string
type nonrec amazon_open_search_serverless_buffering_interval_in_seconds = int
type nonrec amazon_open_search_serverless_buffering_size_in_m_bs = int
type nonrec amazon_open_search_serverless_buffering_hints = {
  1. size_in_m_bs : amazon_open_search_serverless_buffering_size_in_m_bs option;
    (*

    Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

    We recommend setting this parameter to a value greater than the amount of data you typically ingest into the Firehose stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.

    *)
  2. interval_in_seconds : amazon_open_search_serverless_buffering_interval_in_seconds option;
    (*

    Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).

    *)
}

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

type nonrec amazon_open_search_serverless_retry_duration_in_seconds = int
type nonrec amazon_open_search_serverless_retry_options = {
  1. duration_in_seconds : amazon_open_search_serverless_retry_duration_in_seconds option;
    (*

    After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time during which Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.

    *)
}

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

type nonrec amazon_open_search_serverless_destination_update = {
  1. cloud_watch_logging_options : cloud_watch_logging_options option;
  2. processing_configuration : processing_configuration option;
  3. s3_update : s3_destination_update option;
  4. retry_options : amazon_open_search_serverless_retry_options option;
    (*

    The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).

    *)
  5. buffering_hints : amazon_open_search_serverless_buffering_hints option;
    (*

    The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.

    *)
  6. index_name : amazon_open_search_serverless_index_name option;
    (*

    The Serverless offering for Amazon OpenSearch Service index name.

    *)
  7. collection_endpoint : amazon_open_search_serverless_collection_endpoint option;
    (*

    The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.

    *)
  8. role_ar_n : role_ar_n option;
    (*

    The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.

    *)
}

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

type nonrec snowflake_account_url = string
type nonrec snowflake_private_key = string
type nonrec snowflake_key_passphrase = string
type nonrec snowflake_user = string
type nonrec snowflake_database = string
type nonrec snowflake_schema = string
type nonrec snowflake_table = string
type nonrec snowflake_role = string
type nonrec snowflake_role_configuration = {
  1. snowflake_role : snowflake_role option;
    (*

    The Snowflake role you wish to configure

    *)
  2. enabled : boolean_object option;
    (*

    Enable Snowflake role

    *)
}

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

type nonrec snowflake_data_loading_option =
  1. | VARIANT_CONTENT_AND_METADATA_MAPPING
  2. | VARIANT_CONTENT_MAPPING
  3. | JSON_MAPPING
type nonrec snowflake_meta_data_column_name = string
type nonrec snowflake_content_column_name = string
type nonrec snowflake_retry_duration_in_seconds = int
type nonrec snowflake_retry_options = {
  1. duration_in_seconds : snowflake_retry_duration_in_seconds option;
    (*

    the time period where Firehose will retry sending data to the chosen HTTP endpoint.

    *)
}

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.

type nonrec snowflake_s3_backup_mode =
  1. | AllData
  2. | FailedDataOnly
type nonrec snowflake_buffering_size_in_m_bs = int
type nonrec snowflake_buffering_interval_in_seconds = int
type nonrec snowflake_buffering_hints = {
  1. interval_in_seconds : snowflake_buffering_interval_in_seconds option;
    (*

    Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 0.

    *)
  2. size_in_m_bs : snowflake_buffering_size_in_m_bs option;
    (*

    Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 128.

    *)
}

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

type nonrec snowflake_destination_update = {
  1. buffering_hints : snowflake_buffering_hints option;
    (*

    Describes the buffering to perform before delivering data to the Snowflake destination.

    *)
  2. secrets_manager_configuration : secrets_manager_configuration option;
    (*

    Describes the Secrets Manager configuration in Snowflake.

    *)
  3. s3_update : s3_destination_update option;
  4. s3_backup_mode : snowflake_s3_backup_mode option;
    (*

    Choose an S3 backup mode. Once you set the mode as AllData, you can not change it to FailedDataOnly.

    *)
  5. retry_options : snowflake_retry_options option;
    (*

    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.

    *)
  6. role_ar_n : role_ar_n option;
    (*

    The Amazon Resource Name (ARN) of the Snowflake role

    *)
  7. processing_configuration : processing_configuration option;
  8. cloud_watch_logging_options : cloud_watch_logging_options option;
  9. content_column_name : snowflake_content_column_name option;
    (*

    The name of the content metadata column

    *)
  10. meta_data_column_name : snowflake_meta_data_column_name option;
    (*

    The name of the record metadata column

    *)
  11. data_loading_option : snowflake_data_loading_option option;
    (*

    JSON keys mapped to table column names or choose to split the JSON payload where content is mapped to a record content column and source metadata is mapped to a record metadata column.

    *)
  12. snowflake_role_configuration : snowflake_role_configuration option;
    (*

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

    *)
  13. table : snowflake_table option;
    (*

    All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.

    *)
  14. schema : snowflake_schema option;
    (*

    Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views

    *)
  15. database : snowflake_database option;
    (*

    All data in Snowflake is maintained in databases.

    *)
  16. user : snowflake_user option;
    (*

    User login name for the Snowflake account.

    *)
  17. key_passphrase : snowflake_key_passphrase option;
    (*

    Passphrase to decrypt the private key when the key is encrypted. For information, see Using Key Pair Authentication & Key Rotation.

    *)
  18. private_key : snowflake_private_key option;
    (*

    The private key used to encrypt your Snowflake client. For information, see Using Key Pair Authentication & Key Rotation.

    *)
  19. account_url : snowflake_account_url option;
    (*

    URL for accessing your Snowflake account. This URL must include your account identifier. Note that the protocol (https://) and port number are optional.

    *)
}

Update to configuration settings

type nonrec string_with_letters_digits_underscores_dots = string
type nonrec partition_field = {
  1. source_name : non_empty_string_without_whitespace;
    (*

    The column name to be configured in partition spec.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
}

Represents a single field in a PartitionSpec.

Amazon Data Firehose is in preview release and is subject to change.

type nonrec partition_fields = partition_field list
type nonrec partition_spec = {
  1. identity : partition_fields option;
    (*

    List of identity transforms that performs an identity transformation. The transform takes the source value, and does not modify it. Result type is the source type.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
}

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.

type nonrec destination_table_configuration = {
  1. s3_error_output_prefix : error_output_prefix option;
    (*

    The table specific S3 error output prefix. All the errors that occurred while delivering to this table will be prefixed with this value in S3 destination.

    *)
  2. partition_spec : partition_spec option;
    (*

    The partition spec configuration for a table that is used by automatic table creation.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
  3. unique_keys : list_of_non_empty_strings_without_whitespace option;
    (*

    A list of unique keys for a given Apache Iceberg table. Firehose will use these for running Create, Update, or Delete operations on the given Iceberg table.

    *)
  4. destination_database_name : string_with_letters_digits_underscores_dots;
    (*

    The name of the Apache Iceberg database.

    *)
  5. destination_table_name : string_with_letters_digits_underscores_dots;
    (*

    Specifies the name of the Apache Iceberg Table.

    *)
}

Describes the configuration of a destination in Apache Iceberg Tables.

type nonrec destination_table_configuration_list = destination_table_configuration list
type nonrec schema_evolution_configuration = {
  1. enabled : boolean_object;
    (*

    Specify whether you want to enable schema evolution.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
}

The configuration to enable schema evolution.

Amazon Data Firehose is in preview release and is subject to change.

type nonrec table_creation_configuration = {
  1. enabled : boolean_object;
    (*

    Specify whether you want to enable automatic table creation.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
}

The configuration to enable automatic table creation.

Amazon Data Firehose is in preview release and is subject to change.

type nonrec iceberg_s3_backup_mode =
  1. | AllData
  2. | FailedDataOnly
type nonrec glue_data_catalog_ar_n = string
type nonrec catalog_configuration = {
  1. warehouse_location : warehouse_location option;
    (*

    The warehouse location for Apache Iceberg tables. You must configure this when schema evolution and table creation is enabled.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
  2. catalog_ar_n : glue_data_catalog_ar_n option;
    (*

    Specifies the Glue catalog ARN identifier of the destination Apache Iceberg Tables. You must specify the ARN in the format arn:aws:glue:region:account-id:catalog.

    *)
}

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

type nonrec s3_destination_configuration = {
  1. cloud_watch_logging_options : cloud_watch_logging_options option;
    (*

    The CloudWatch logging options for your Firehose stream.

    *)
  2. encryption_configuration : encryption_configuration option;
    (*

    The encryption configuration. If no value is specified, the default is no encryption.

    *)
  3. compression_format : compression_format option;
    (*

    The compression format. If no value is specified, the default is UNCOMPRESSED.

    The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

    *)
  4. buffering_hints : buffering_hints option;
    (*

    The buffering option. If no value is specified, BufferingHints object default values are used.

    *)
  5. error_output_prefix : error_output_prefix option;
    (*

    A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

    *)
  6. prefix : prefix option;
    (*

    The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

    *)
  7. bucket_ar_n : bucket_ar_n;
    (*

    The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    *)
  8. role_ar_n : role_ar_n;
    (*

    The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    *)
}

Describes the configuration of a destination in Amazon S3.

type nonrec iceberg_destination_update = {
  1. s3_configuration : s3_destination_configuration option;
  2. catalog_configuration : catalog_configuration option;
    (*

    Configuration describing where the destination Iceberg tables are persisted.

    *)
  3. append_only : boolean_object option;
    (*

    Describes whether all incoming data for this delivery stream will be append only (inserts only and not for updates and deletes) for Iceberg delivery. This feature is only applicable for Apache Iceberg Tables.

    The default value is false. If you set this value to true, Firehose automatically increases the throughput limit of a stream based on the throttling levels of the stream. If you set this parameter to true for a stream with updates and deletes, you will see out of order delivery.

    *)
  4. role_ar_n : role_ar_n option;
    (*

    The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling Apache Iceberg Tables.

    *)
  5. retry_options : retry_options option;
  6. s3_backup_mode : iceberg_s3_backup_mode option;
    (*

    Describes how Firehose will backup records. Currently,Firehose only supports FailedDataOnly.

    *)
  7. processing_configuration : processing_configuration option;
  8. cloud_watch_logging_options : cloud_watch_logging_options option;
  9. buffering_hints : buffering_hints option;
  10. table_creation_configuration : table_creation_configuration option;
    (*

    The configuration to enable automatic table creation.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
  11. schema_evolution_configuration : schema_evolution_configuration option;
    (*

    The configuration to enable automatic schema evolution.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
  12. destination_table_configuration_list : destination_table_configuration_list option;
    (*

    Provides a list of DestinationTableConfigurations which Firehose uses to deliver data to Apache Iceberg Tables. Firehose will write data with insert if table specific configuration is not provided here.

    *)
}

Describes an update for a destination in Apache Iceberg Tables.

type nonrec update_destination_input = {
  1. iceberg_destination_update : iceberg_destination_update option;
    (*

    Describes an update for a destination in Apache Iceberg Tables.

    *)
  2. snowflake_destination_update : snowflake_destination_update option;
    (*

    Update to the Snowflake destination configuration settings.

    *)
  3. amazon_open_search_serverless_destination_update : amazon_open_search_serverless_destination_update option;
    (*

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

    *)
  4. http_endpoint_destination_update : http_endpoint_destination_update option;
    (*

    Describes an update to the specified HTTP endpoint destination.

    *)
  5. splunk_destination_update : splunk_destination_update option;
    (*

    Describes an update for a destination in Splunk.

    *)
  6. amazonopensearchservice_destination_update : amazonopensearchservice_destination_update option;
    (*

    Describes an update for a destination in Amazon OpenSearch Service.

    *)
  7. elasticsearch_destination_update : elasticsearch_destination_update option;
    (*

    Describes an update for a destination in Amazon OpenSearch Service.

    *)
  8. redshift_destination_update : redshift_destination_update option;
    (*

    Describes an update for a destination in Amazon Redshift.

    *)
  9. extended_s3_destination_update : extended_s3_destination_update option;
    (*

    Describes an update for a destination in Amazon S3.

    *)
  10. s3_destination_update : s3_destination_update option;
    (*

    [Deprecated] Describes an update for a destination in Amazon S3.

    *)
  11. destination_id : destination_id;
    (*

    The ID of the destination.

    *)
  12. current_delivery_stream_version_id : delivery_stream_version_id;
    (*

    Obtain this value from the VersionId result of DeliveryStreamDescription. This value is required, and helps the service perform conditional operations. For example, if there is an interleaving update and this value is null, then the update destination fails. After the update is successful, the VersionId value is updated. The service then performs a merge of the old configuration with the new configuration.

    *)
  13. delivery_stream_name : delivery_stream_name;
    (*

    The name of the Firehose stream.

    *)
}
type nonrec error_message = string
type nonrec resource_not_found_exception = {
  1. message : error_message option;
    (*

    A message that provides information about the error.

    *)
}

The specified resource could not be found.

type nonrec resource_in_use_exception = {
  1. message : error_message option;
    (*

    A message that provides information about the error.

    *)
}

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

type nonrec invalid_argument_exception = {
  1. message : error_message option;
    (*

    A message that provides information about the error.

    *)
}

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

type nonrec concurrent_modification_exception = {
  1. message : error_message option;
    (*

    A message that provides information about the error.

    *)
}

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

type nonrec untag_delivery_stream_output = unit
type nonrec tag_key = string
type nonrec tag_key_list = tag_key list
type nonrec untag_delivery_stream_input = {
  1. tag_keys : tag_key_list;
    (*

    A list of tag keys. Each corresponding tag is removed from the delivery stream.

    *)
  2. delivery_stream_name : delivery_stream_name;
    (*

    The name of the Firehose stream.

    *)
}
type nonrec limit_exceeded_exception = {
  1. message : error_message option;
    (*

    A message that provides information about the error.

    *)
}

You have already reached the limit for a requested resource.

type nonrec topic_name = string
type nonrec timestamp = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec throughput_hint_in_m_bs = int
type nonrec tag_value = string
type nonrec tag_delivery_stream_output = unit
type nonrec tag = {
  1. value : tag_value option;
    (*

    An optional string, which you can use to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

    *)
  2. key : tag_key;
    (*

    A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

    *)
}

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

type nonrec tag_delivery_stream_input_tag_list = tag list
type nonrec tag_delivery_stream_input = {
  1. tags : tag_delivery_stream_input_tag_list;
    (*

    A set of key-value pairs to use to create the tags.

    *)
  2. delivery_stream_name : delivery_stream_name;
    (*

    The name of the Firehose stream to which you want to add the tags.

    *)
}
type nonrec stop_delivery_stream_encryption_output = unit
type nonrec stop_delivery_stream_encryption_input = {
  1. delivery_stream_name : delivery_stream_name;
    (*

    The name of the Firehose stream for which you want to disable server-side encryption (SSE).

    *)
}
type nonrec start_delivery_stream_encryption_output = unit
type nonrec awskms_key_arn_for_ss_e = string
type nonrec key_type =
  1. | CUSTOMER_MANAGED_CMK
  2. | AWS_OWNED_CMK
type nonrec delivery_stream_encryption_configuration_input = {
  1. key_type : key_type;
    (*

    Indicates the type of customer master key (CMK) to use for encryption. The default setting is Amazon Web Services_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs). When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with KeyType set to CUSTOMER_MANAGED_CMK, Firehose invokes the Amazon KMS operation CreateGrant to create a grant that allows the Firehose service to use the customer managed CMK to perform encryption and decryption. Firehose manages that grant.

    When you invoke StartDeliveryStreamEncryption to change the CMK for a Firehose stream that is encrypted with a customer managed CMK, Firehose schedules the grant it had on the old CMK for retirement.

    You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 Firehose streams. If a CreateDeliveryStream or StartDeliveryStreamEncryption operation exceeds this limit, Firehose throws a LimitExceededException.

    To encrypt your Firehose stream, use symmetric CMKs. Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs in the Amazon Web Services Key Management Service developer guide.

    *)
  2. key_ar_n : awskms_key_arn_for_ss_e option;
    (*

    If you set KeyType to CUSTOMER_MANAGED_CMK, you must specify the Amazon Resource Name (ARN) of the CMK. If you set KeyType to Amazon Web Services_OWNED_CMK, Firehose uses a service-account CMK.

    *)
}

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

type nonrec start_delivery_stream_encryption_input = {
  1. delivery_stream_encryption_configuration_input : delivery_stream_encryption_configuration_input option;
    (*

    Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).

    *)
  2. delivery_stream_name : delivery_stream_name;
    (*

    The name of the Firehose stream for which you want to enable server-side encryption (SSE).

    *)
}
type nonrec error_code = string
type nonrec invalid_kms_resource_exception = {
  1. message : error_message option;
  2. code : error_code option;
}

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.

type nonrec s3_destination_description = {
  1. cloud_watch_logging_options : cloud_watch_logging_options option;
    (*

    The Amazon CloudWatch logging options for your Firehose stream.

    *)
  2. encryption_configuration : encryption_configuration;
    (*

    The encryption configuration. If no value is specified, the default is no encryption.

    *)
  3. compression_format : compression_format;
    (*

    The compression format. If no value is specified, the default is UNCOMPRESSED.

    *)
  4. buffering_hints : buffering_hints;
    (*

    The buffering option. If no value is specified, BufferingHints object default values are used.

    *)
  5. error_output_prefix : error_output_prefix option;
    (*

    A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

    *)
  6. prefix : prefix option;
    (*

    The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

    *)
  7. bucket_ar_n : bucket_ar_n;
    (*

    The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    *)
  8. role_ar_n : role_ar_n;
    (*

    The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    *)
}

Describes a destination in Amazon S3.

type nonrec splunk_destination_description = {
  1. secrets_manager_configuration : secrets_manager_configuration option;
    (*

    The configuration that defines how you access secrets for Splunk.

    *)
  2. buffering_hints : splunk_buffering_hints option;
    (*

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

    *)
  3. cloud_watch_logging_options : cloud_watch_logging_options option;
    (*

    The Amazon CloudWatch logging options for your Firehose stream.

    *)
  4. processing_configuration : processing_configuration option;
    (*

    The data processing configuration.

    *)
  5. s3_destination_description : s3_destination_description option;
    (*

    The Amazon S3 destination.>

    *)
  6. s3_backup_mode : splunk_s3_backup_mode option;
    (*

    Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly.

    *)
  7. retry_options : splunk_retry_options option;
    (*

    The retry behavior in case Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.

    *)
  8. hec_acknowledgment_timeout_in_seconds : hec_acknowledgment_timeout_in_seconds option;
    (*

    The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Firehose either tries to send the data again or considers it an error, based on your retry settings.

    *)
  9. hec_token : hec_token option;
    (*

    A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.

    *)
  10. hec_endpoint_type : hec_endpoint_type option;
    (*

    This type can be either "Raw" or "Event."

    *)
  11. hec_endpoint : hec_endpoint option;
    (*

    The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.

    *)
}

Describes a destination in Splunk.

type nonrec splunk_destination_configuration = {
  1. secrets_manager_configuration : secrets_manager_configuration option;
    (*

    The configuration that defines how you access secrets for Splunk.

    *)
  2. buffering_hints : splunk_buffering_hints option;
    (*

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

    *)
  3. cloud_watch_logging_options : cloud_watch_logging_options option;
    (*

    The Amazon CloudWatch logging options for your Firehose stream.

    *)
  4. processing_configuration : processing_configuration option;
    (*

    The data processing configuration.

    *)
  5. s3_configuration : s3_destination_configuration;
    (*

    The configuration for the backup Amazon S3 location.

    *)
  6. s3_backup_mode : splunk_s3_backup_mode option;
    (*

    Defines how documents should be delivered to Amazon S3. When set to FailedEventsOnly, Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllEvents, Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value is FailedEventsOnly.

    You can update this backup mode from FailedEventsOnly to AllEvents. You can't update it from AllEvents to FailedEventsOnly.

    *)
  7. retry_options : splunk_retry_options option;
    (*

    The retry behavior in case Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk.

    *)
  8. hec_acknowledgment_timeout_in_seconds : hec_acknowledgment_timeout_in_seconds option;
    (*

    The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Firehose either tries to send the data again or considers it an error, based on your retry settings.

    *)
  9. hec_token : hec_token option;
    (*

    This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.

    *)
  10. hec_endpoint_type : hec_endpoint_type;
    (*

    This type can be either "Raw" or "Event."

    *)
  11. hec_endpoint : hec_endpoint;
    (*

    The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.

    *)
}

Describes the configuration of a destination in Splunk.

type nonrec direct_put_source_description = {
  1. throughput_hint_in_m_bs : throughput_hint_in_m_bs option;
    (*

    The value that you configure for this parameter is for information purpose only and does not affect Firehose delivery throughput limit. You can use the Firehose Limits form to request a throughput limit increase.

    *)
}

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

type nonrec kinesis_stream_ar_n = string
type nonrec delivery_start_timestamp = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec kinesis_stream_source_description = {
  1. delivery_start_timestamp : delivery_start_timestamp option;
    (*

    Firehose starts retrieving records from the Kinesis data stream starting with this timestamp.

    *)
  2. role_ar_n : role_ar_n option;
    (*

    The ARN of the role used by the source Kinesis data stream. For more information, see Amazon Web Services Identity and Access Management (IAM) ARN Format.

    *)
  3. kinesis_stream_ar_n : kinesis_stream_ar_n option;
    (*

    The Amazon Resource Name (ARN) of the source Kinesis data stream. For more information, see Amazon Kinesis Data Streams ARN Format.

    *)
}

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

type nonrec msk_cluster_ar_n = string
type nonrec connectivity =
  1. | PRIVATE
  2. | PUBLIC
type nonrec authentication_configuration = {
  1. connectivity : connectivity;
    (*

    The type of connectivity used to access the Amazon MSK cluster.

    *)
  2. role_ar_n : role_ar_n;
    (*

    The ARN of the role used to access the Amazon MSK cluster.

    *)
}

The authentication configuration of the Amazon MSK cluster.

type nonrec read_from_timestamp = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec msk_source_description = {
  1. read_from_timestamp : read_from_timestamp option;
    (*

    The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active.

    If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the ReadFromTimestampUTC parameter to Epoch (1970-01-01T00:00:00Z).

    *)
  2. delivery_start_timestamp : delivery_start_timestamp option;
    (*

    Firehose starts retrieving records from the topic within the Amazon MSK cluster starting with this timestamp.

    *)
  3. authentication_configuration : authentication_configuration option;
    (*

    The authentication configuration of the Amazon MSK cluster.

    *)
  4. topic_name : topic_name option;
    (*

    The topic name within the Amazon MSK cluster.

    *)
  5. msk_cluster_ar_n : msk_cluster_ar_n option;
    (*

    The ARN of the Amazon MSK cluster.

    *)
}

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

type nonrec database_type =
  1. | PostgreSQL
  2. | MySQL
type nonrec database_endpoint = string
type nonrec database_port = int
type nonrec ssl_mode =
  1. | Enabled
  2. | Disabled
type nonrec database_name = string
type nonrec database_include_or_exclude_list = database_name list
type nonrec database_list = {
  1. exclude : database_include_or_exclude_list option;
    (*

    The list of database patterns in source database endpoint to be excluded for Firehose to read from.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
  2. include_ : database_include_or_exclude_list option;
    (*

    The list of database patterns in source database endpoint to be included for Firehose to read from.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
}

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.

type nonrec database_table_name = string
type nonrec database_table_include_or_exclude_list = database_table_name list
type nonrec database_table_list = {
  1. exclude : database_table_include_or_exclude_list option;
    (*

    The list of table patterns in source database endpoint to be excluded for Firehose to read from.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
  2. include_ : database_table_include_or_exclude_list option;
    (*

    The list of table patterns in source database endpoint to be included for Firehose to read from.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
}

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.

type nonrec database_column_name = string
type nonrec database_column_include_or_exclude_list = database_column_name list
type nonrec database_column_list = {
  1. exclude : database_column_include_or_exclude_list option;
    (*

    The list of column patterns in source database to be excluded for Firehose to read from.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
  2. include_ : database_column_include_or_exclude_list option;
    (*

    The list of column patterns in source database to be included for Firehose to read from.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
}

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.

type nonrec snapshot_requested_by =
  1. | FIREHOSE
  2. | USER
type nonrec snapshot_status =
  1. | SUSPENDED
  2. | COMPLETE
  3. | IN_PROGRESS
type nonrec delivery_stream_failure_type =
  1. | UNKNOWN_ERROR
  2. | SECURITY_GROUP_ACCESS_DENIED
  3. | SUBNET_ACCESS_DENIED
  4. | ENI_ACCESS_DENIED
  5. | SECURITY_GROUP_NOT_FOUND
  6. | SUBNET_NOT_FOUND
  7. | DELETE_ENI_FAILED
  8. | CREATE_ENI_FAILED
  9. | KMS_OPT_IN_REQUIRED
  10. | KMS_KEY_NOT_FOUND
  11. | INVALID_KMS_KEY
  12. | DISABLED_KMS_KEY
  13. | KMS_ACCESS_DENIED
  14. | CREATE_KMS_GRANT_FAILED
  15. | RETIRE_KMS_GRANT_FAILED
  16. | VPC_INTERFACE_ENDPOINT_SERVICE_ACCESS_DENIED
  17. | VPC_ENDPOINT_SERVICE_NAME_NOT_FOUND
type nonrec failure_description = {
  1. details : non_empty_string;
    (*

    A message providing details about the error that caused the failure.

    *)
  2. type_ : delivery_stream_failure_type;
    (*

    The type of error that caused the failure.

    *)
}

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

type nonrec database_snapshot_info = {
  1. failure_description : failure_description option;
  2. status : snapshot_status;
    (*

    The status of the current snapshot of the table.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
  3. requested_by : snapshot_requested_by;
    (*

    The principal that sent the request to take the current snapshot on the table.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
  4. request_timestamp : timestamp;
    (*

    The timestamp when the current snapshot is taken on the table.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
  5. table : database_table_name;
    (*

    The fully qualified name of the table in source database endpoint that Firehose reads.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
  6. id : non_empty_string_without_whitespace;
    (*

    The identifier of the current snapshot of the table in source database endpoint.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
}

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.

type nonrec database_snapshot_info_list = database_snapshot_info list
type nonrec database_source_authentication_configuration = {
  1. secrets_manager_configuration : secrets_manager_configuration;
}

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.

type nonrec database_source_vpc_configuration = {
  1. vpc_endpoint_service_name : vpc_endpoint_service_name;
    (*

    The VPC endpoint service name which Firehose uses to create a PrivateLink to the database. The endpoint service must have the Firehose service principle firehose.amazonaws.com as an allowed principal on the VPC endpoint service. The VPC endpoint service name is a string that looks like

    com.amazonaws.vpce..

    .

    Amazon Data Firehose is in preview release and is subject to change.

    *)
}

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.

type nonrec database_source_description = {
  1. database_source_vpc_configuration : database_source_vpc_configuration option;
    (*

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

    *)
  2. database_source_authentication_configuration : database_source_authentication_configuration option;
    (*

    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.

    *)
  3. snapshot_info : database_snapshot_info_list option;
    (*

    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.

    *)
  4. snapshot_watermark_table : database_table_name option;
    (*

    The fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
  5. surrogate_keys : database_column_include_or_exclude_list option;
    (*

    The optional list of table and column names used as unique key columns when taking snapshot if the tables don’t have primary keys configured.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
  6. columns : database_column_list option;
    (*

    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.

    *)
  7. tables : database_table_list option;
    (*

    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.

    *)
  8. databases : database_list option;
    (*

    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.

    *)
  9. ssl_mode : ssl_mode option;
    (*

    The mode to enable or disable SSL when Firehose connects to the database endpoint.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
  10. port : database_port option;
    (*

    The port of the database. This can be one of the following values.

    • 3306 for MySQL database type
    • 5432 for PostgreSQL database type

    Amazon Data Firehose is in preview release and is subject to change.

    *)
  11. endpoint : database_endpoint option;
    (*

    The endpoint of the database server.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
  12. type_ : database_type option;
    (*

    The type of database engine. This can be one of the following values.

    • MySQL
    • PostgreSQL

    Amazon Data Firehose is in preview release and is subject to change.

    *)
}

The top level object for database source description.

Amazon Data Firehose is in preview release and is subject to change.

type nonrec source_description = {
  1. database_source_description : database_source_description option;
    (*

    Details about a database used as the source for a Firehose stream.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
  2. msk_source_description : msk_source_description option;
    (*

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

    *)
  3. kinesis_stream_source_description : kinesis_stream_source_description option;
    (*

    The KinesisStreamSourceDescription value for the source Kinesis data stream.

    *)
  4. direct_put_source_description : direct_put_source_description option;
    (*

    Details about Direct PUT used as the source for a Firehose stream.

    *)
}

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

type nonrec snowflake_vpc_configuration = {
}

Configure a Snowflake VPC

type nonrec snowflake_destination_description = {
  1. buffering_hints : snowflake_buffering_hints option;
    (*

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

    *)
  2. secrets_manager_configuration : secrets_manager_configuration option;
    (*

    The configuration that defines how you access secrets for Snowflake.

    *)
  3. s3_destination_description : s3_destination_description option;
  4. s3_backup_mode : snowflake_s3_backup_mode option;
    (*

    Choose an S3 backup mode

    *)
  5. retry_options : snowflake_retry_options option;
    (*

    The time period where Firehose will retry sending data to the chosen HTTP endpoint.

    *)
  6. role_ar_n : role_ar_n option;
    (*

    The Amazon Resource Name (ARN) of the Snowflake role

    *)
  7. processing_configuration : processing_configuration option;
  8. cloud_watch_logging_options : cloud_watch_logging_options option;
  9. snowflake_vpc_configuration : snowflake_vpc_configuration option;
    (*

    The VPCE ID for Firehose to privately connect with Snowflake. The ID format is com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see Amazon PrivateLink & Snowflake

    *)
  10. content_column_name : snowflake_content_column_name option;
    (*

    The name of the record content column

    *)
  11. meta_data_column_name : snowflake_meta_data_column_name option;
    (*

    The name of the record metadata column

    *)
  12. data_loading_option : snowflake_data_loading_option option;
    (*

    Choose to load JSON keys mapped to table column names or choose to split the JSON payload where content is mapped to a record content column and source metadata is mapped to a record metadata column.

    *)
  13. snowflake_role_configuration : snowflake_role_configuration option;
    (*

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

    *)
  14. table : snowflake_table option;
    (*

    All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.

    *)
  15. schema : snowflake_schema option;
    (*

    Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views

    *)
  16. database : snowflake_database option;
    (*

    All data in Snowflake is maintained in databases.

    *)
  17. user : snowflake_user option;
    (*

    User login name for the Snowflake account.

    *)
  18. account_url : snowflake_account_url option;
    (*

    URL for accessing your Snowflake account. This URL must include your account identifier. Note that the protocol (https://) and port number are optional.

    *)
}

Optional Snowflake destination description

type nonrec snowflake_destination_configuration = {
  1. buffering_hints : snowflake_buffering_hints option;
    (*

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

    *)
  2. secrets_manager_configuration : secrets_manager_configuration option;
    (*

    The configuration that defines how you access secrets for Snowflake.

    *)
  3. s3_configuration : s3_destination_configuration;
  4. s3_backup_mode : snowflake_s3_backup_mode option;
    (*

    Choose an S3 backup mode

    *)
  5. retry_options : snowflake_retry_options option;
    (*

    The time period where Firehose will retry sending data to the chosen HTTP endpoint.

    *)
  6. role_ar_n : role_ar_n;
    (*

    The Amazon Resource Name (ARN) of the Snowflake role

    *)
  7. processing_configuration : processing_configuration option;
  8. cloud_watch_logging_options : cloud_watch_logging_options option;
  9. snowflake_vpc_configuration : snowflake_vpc_configuration option;
    (*

    The VPCE ID for Firehose to privately connect with Snowflake. The ID format is com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see Amazon PrivateLink & Snowflake

    *)
  10. content_column_name : snowflake_content_column_name option;
    (*

    The name of the record content column.

    *)
  11. meta_data_column_name : snowflake_meta_data_column_name option;
    (*

    Specify a column name in the table, where the metadata information has to be loaded. When you enable this field, you will see the following column in the snowflake table, which differs based on the source type.

    For Direct PUT as source

    { "firehoseDeliveryStreamName" : "streamname", "IngestionTime" : "timestamp" }

    For Kinesis Data Stream as source

    "kinesisStreamName" : "streamname", "kinesisShardId" : "Id", "kinesisPartitionKey" : "key", "kinesisSequenceNumber" : "1234", "subsequenceNumber" : "2334", "IngestionTime" : "timestamp" }

    *)
  12. data_loading_option : snowflake_data_loading_option option;
    (*

    Choose to load JSON keys mapped to table column names or choose to split the JSON payload where content is mapped to a record content column and source metadata is mapped to a record metadata column.

    *)
  13. snowflake_role_configuration : snowflake_role_configuration option;
    (*

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

    *)
  14. table : snowflake_table;
    (*

    All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.

    *)
  15. schema : snowflake_schema;
    (*

    Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views

    *)
  16. database : snowflake_database;
    (*

    All data in Snowflake is maintained in databases.

    *)
  17. user : snowflake_user option;
    (*

    User login name for the Snowflake account.

    *)
  18. key_passphrase : snowflake_key_passphrase option;
    (*

    Passphrase to decrypt the private key when the key is encrypted. For information, see Using Key Pair Authentication & Key Rotation.

    *)
  19. private_key : snowflake_private_key option;
    (*

    The private key used to encrypt your Snowflake client. For information, see Using Key Pair Authentication & Key Rotation.

    *)
  20. account_url : snowflake_account_url;
    (*

    URL for accessing your Snowflake account. This URL must include your account identifier. Note that the protocol (https://) and port number are optional.

    *)
}

Configure Snowflake destination

type nonrec service_unavailable_exception = {
  1. message : error_message option;
    (*

    A message that provides information about the error.

    *)
}

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.

type nonrec redshift_destination_description = {
  1. secrets_manager_configuration : secrets_manager_configuration option;
    (*

    The configuration that defines how you access secrets for Amazon Redshift.

    *)
  2. cloud_watch_logging_options : cloud_watch_logging_options option;
    (*

    The Amazon CloudWatch logging options for your Firehose stream.

    *)
  3. s3_backup_description : s3_destination_description option;
    (*

    The configuration for backup in Amazon S3.

    *)
  4. s3_backup_mode : redshift_s3_backup_mode option;
    (*

    The Amazon S3 backup mode.

    *)
  5. processing_configuration : processing_configuration option;
    (*

    The data processing configuration.

    *)
  6. s3_destination_description : s3_destination_description;
    (*

    The Amazon S3 destination.

    *)
  7. retry_options : redshift_retry_options option;
    (*

    The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

    *)
  8. username : username option;
    (*

    The name of the user.

    *)
  9. copy_command : copy_command;
    (*

    The COPY command.

    *)
  10. cluster_jdbcur_l : cluster_jdbcur_l;
    (*

    The database connection string.

    *)
  11. role_ar_n : role_ar_n;
    (*

    The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    *)
}

Describes a destination in Amazon Redshift.

type nonrec redshift_destination_configuration = {
  1. secrets_manager_configuration : secrets_manager_configuration option;
    (*

    The configuration that defines how you access secrets for Amazon Redshift.

    *)
  2. cloud_watch_logging_options : cloud_watch_logging_options option;
    (*

    The CloudWatch logging options for your Firehose stream.

    *)
  3. s3_backup_configuration : s3_destination_configuration option;
    (*

    The configuration for backup in Amazon S3.

    *)
  4. s3_backup_mode : redshift_s3_backup_mode option;
    (*

    The Amazon S3 backup mode. After you create a Firehose stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the Firehose stream to disable it.

    *)
  5. processing_configuration : processing_configuration option;
    (*

    The data processing configuration.

    *)
  6. s3_configuration : s3_destination_configuration;
    (*

    The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions are described in the topic for CreateDeliveryStream.

    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.

    *)
  7. retry_options : redshift_retry_options option;
    (*

    The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

    *)
  8. password : password option;
    (*

    The user password.

    *)
  9. username : username option;
    (*

    The name of the user.

    *)
  10. copy_command : copy_command;
    (*

    The COPY command.

    *)
  11. cluster_jdbcur_l : cluster_jdbcur_l;
    (*

    The database connection string.

    *)
  12. role_ar_n : role_ar_n;
    (*

    The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    *)
}

Describes the configuration of a destination in Amazon Redshift.

type nonrec data = bytes
type nonrec record = {
  1. data : data;
    (*

    The data blob, which is base64-encoded when the blob is serialized. The maximum size of the data blob, before base64-encoding, is 1,000 KiB.

    *)
}

The unit of data in a Firehose stream.

type nonrec put_response_record_id = string
type nonrec put_record_output = {
  1. encrypted : boolean_object option;
    (*

    Indicates whether server-side encryption (SSE) was enabled during this operation.

    *)
  2. record_id : put_response_record_id;
    (*

    The ID of the record.

    *)
}
type nonrec put_record_input = {
  1. record : record;
    (*

    The record.

    *)
  2. delivery_stream_name : delivery_stream_name;
    (*

    The name of the Firehose stream.

    *)
}
type nonrec put_record_batch_response_entry = {
  1. error_message : error_message option;
    (*

    The error message for an individual record result.

    *)
  2. error_code : error_code option;
    (*

    The error code for an individual record result.

    *)
  3. record_id : put_response_record_id option;
    (*

    The ID of the record.

    *)
}

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.

type nonrec put_record_batch_response_entry_list = put_record_batch_response_entry list
type nonrec put_record_batch_request_entry_list = record list
type nonrec put_record_batch_output = {
  1. request_responses : put_record_batch_response_entry_list;
    (*

    The results array. For each record, the index of the response element is the same as the index used in the request array.

    *)
  2. encrypted : boolean_object option;
    (*

    Indicates whether server-side encryption (SSE) was enabled during this operation.

    *)
  3. failed_put_count : non_negative_integer_object;
    (*

    The number of records that might have failed processing. This number might be greater than 0 even if the PutRecordBatch call succeeds. Check FailedPutCount to determine whether there are records that you need to resend.

    *)
}
type nonrec put_record_batch_input = {
  1. records : put_record_batch_request_entry_list;
    (*

    One or more records.

    *)
  2. delivery_stream_name : delivery_stream_name;
    (*

    The name of the Firehose stream.

    *)
}
type nonrec invalid_source_exception = {
  1. message : error_message option;
  2. code : error_code option;
}

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

type nonrec msk_source_configuration = {
  1. read_from_timestamp : read_from_timestamp option;
    (*

    The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active.

    If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the ReadFromTimestamp parameter to Epoch (1970-01-01T00:00:00Z).

    *)
  2. authentication_configuration : authentication_configuration;
    (*

    The authentication configuration of the Amazon MSK cluster.

    *)
  3. topic_name : topic_name;
    (*

    The topic name within the Amazon MSK cluster.

    *)
  4. msk_cluster_ar_n : msk_cluster_ar_n;
    (*

    The ARN of the Amazon MSK cluster.

    *)
}

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

type nonrec list_tags_for_delivery_stream_output_tag_list = tag list
type nonrec list_tags_for_delivery_stream_output = {
  1. has_more_tags : boolean_object;
    (*

    If this is true in the response, more tags are available. To list the remaining tags, set ExclusiveStartTagKey to the key of the last tag returned and call ListTagsForDeliveryStream again.

    *)
  2. tags : list_tags_for_delivery_stream_output_tag_list;
    (*

    A list of tags associated with DeliveryStreamName, starting with the first tag after ExclusiveStartTagKey and up to the specified Limit.

    *)
}
type nonrec list_tags_for_delivery_stream_input_limit = int
type nonrec list_tags_for_delivery_stream_input = {
  1. limit : list_tags_for_delivery_stream_input_limit option;
    (*

    The number of tags to return. If this number is less than the total number of tags associated with the Firehose stream, HasMoreTags is set to true in the response. To list additional tags, set ExclusiveStartTagKey to the last key in the response.

    *)
  2. exclusive_start_tag_key : tag_key option;
    (*

    The key to use as the starting point for the list of tags. If you set this parameter, ListTagsForDeliveryStream gets all tags that occur after ExclusiveStartTagKey.

    *)
  3. delivery_stream_name : delivery_stream_name;
    (*

    The name of the Firehose stream whose tags you want to list.

    *)
}
type nonrec delivery_stream_name_list = delivery_stream_name list
type nonrec list_delivery_streams_output = {
  1. has_more_delivery_streams : boolean_object;
    (*

    Indicates whether there are more Firehose streams available to list.

    *)
  2. delivery_stream_names : delivery_stream_name_list;
    (*

    The names of the Firehose streams.

    *)
}
type nonrec list_delivery_streams_input_limit = int
type nonrec delivery_stream_type =
  1. | DatabaseAsSource
  2. | MSKAsSource
  3. | KinesisStreamAsSource
  4. | DirectPut
type nonrec list_delivery_streams_input = {
  1. exclusive_start_delivery_stream_name : delivery_stream_name option;
    (*

    The list of Firehose streams returned by this call to ListDeliveryStreams will start with the Firehose stream whose name comes alphabetically immediately after the name you specify in ExclusiveStartDeliveryStreamName.

    *)
  2. delivery_stream_type : delivery_stream_type option;
    (*

    The Firehose stream type. This can be one of the following values:

    • DirectPut: Provider applications access the Firehose stream directly.
    • KinesisStreamAsSource: The Firehose stream uses a Kinesis data stream as a source.

    This parameter is optional. If this parameter is omitted, Firehose streams of all types are returned.

    *)
  3. limit : list_delivery_streams_input_limit option;
    (*

    The maximum number of Firehose streams to list. The default value is 10.

    *)
}
type nonrec kinesis_stream_source_configuration = {
  1. role_ar_n : role_ar_n;
    (*

    The ARN of the role that provides access to the source Kinesis data stream. For more information, see Amazon Web Services Identity and Access Management (IAM) ARN Format.

    *)
  2. kinesis_stream_ar_n : kinesis_stream_ar_n;
    (*

    The ARN of the source Kinesis data stream. For more information, see Amazon Kinesis Data Streams ARN Format.

    *)
}

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

type nonrec iceberg_destination_description = {
  1. s3_destination_description : s3_destination_description option;
  2. catalog_configuration : catalog_configuration option;
    (*

    Configuration describing where the destination Iceberg tables are persisted.

    *)
  3. append_only : boolean_object option;
    (*

    Describes whether all incoming data for this delivery stream will be append only (inserts only and not for updates and deletes) for Iceberg delivery. This feature is only applicable for Apache Iceberg Tables.

    The default value is false. If you set this value to true, Firehose automatically increases the throughput limit of a stream based on the throttling levels of the stream. If you set this parameter to true for a stream with updates and deletes, you will see out of order delivery.

    *)
  4. role_ar_n : role_ar_n option;
    (*

    The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling Apache Iceberg Tables.

    *)
  5. retry_options : retry_options option;
  6. s3_backup_mode : iceberg_s3_backup_mode option;
    (*

    Describes how Firehose will backup records. Currently,Firehose only supports FailedDataOnly.

    *)
  7. processing_configuration : processing_configuration option;
  8. cloud_watch_logging_options : cloud_watch_logging_options option;
  9. buffering_hints : buffering_hints option;
  10. table_creation_configuration : table_creation_configuration option;
    (*

    The description of table creation configuration.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
  11. schema_evolution_configuration : schema_evolution_configuration option;
    (*

    The description of automatic schema evolution configuration.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
  12. destination_table_configuration_list : destination_table_configuration_list option;
    (*

    Provides a list of DestinationTableConfigurations which Firehose uses to deliver data to Apache Iceberg Tables. Firehose will write data with insert if table specific configuration is not provided here.

    *)
}

Describes a destination in Apache Iceberg Tables.

type nonrec iceberg_destination_configuration = {
  1. s3_configuration : s3_destination_configuration;
  2. catalog_configuration : catalog_configuration;
    (*

    Configuration describing where the destination Apache Iceberg Tables are persisted.

    *)
  3. append_only : boolean_object option;
    (*

    Describes whether all incoming data for this delivery stream will be append only (inserts only and not for updates and deletes) for Iceberg delivery. This feature is only applicable for Apache Iceberg Tables.

    The default value is false. If you set this value to true, Firehose automatically increases the throughput limit of a stream based on the throttling levels of the stream. If you set this parameter to true for a stream with updates and deletes, you will see out of order delivery.

    *)
  4. role_ar_n : role_ar_n;
    (*

    The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling Apache Iceberg Tables.

    *)
  5. retry_options : retry_options option;
  6. s3_backup_mode : iceberg_s3_backup_mode option;
    (*

    Describes how Firehose will backup records. Currently,S3 backup only supports FailedDataOnly.

    *)
  7. processing_configuration : processing_configuration option;
  8. cloud_watch_logging_options : cloud_watch_logging_options option;
  9. buffering_hints : buffering_hints option;
  10. table_creation_configuration : table_creation_configuration option;
    (*

    The configuration to enable automatic table creation.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
  11. schema_evolution_configuration : schema_evolution_configuration option;
    (*

    The configuration to enable automatic schema evolution.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
  12. destination_table_configuration_list : destination_table_configuration_list option;
    (*

    Provides a list of DestinationTableConfigurations which Firehose uses to deliver data to Apache Iceberg Tables. Firehose will write data with insert if table specific configuration is not provided here.

    *)
}

Specifies the destination configure settings for Apache Iceberg Table.

type nonrec http_endpoint_description = {
  1. name : http_endpoint_name option;
    (*

    The name of the HTTP endpoint selected as the destination.

    *)
  2. url : http_endpoint_url option;
    (*

    The URL of the HTTP endpoint selected as the destination.

    *)
}

Describes the HTTP endpoint selected as the destination.

type nonrec http_endpoint_destination_description = {
  1. secrets_manager_configuration : secrets_manager_configuration option;
    (*

    The configuration that defines how you access secrets for HTTP Endpoint destination.

    *)
  2. s3_destination_description : s3_destination_description option;
  3. s3_backup_mode : http_endpoint_s3_backup_mode option;
    (*

    Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData) or only the documents that Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).

    *)
  4. retry_options : http_endpoint_retry_options option;
    (*

    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.

    *)
  5. role_ar_n : role_ar_n option;
    (*

    Firehose uses this IAM role for all the permissions that the delivery stream needs.

    *)
  6. processing_configuration : processing_configuration option;
  7. request_configuration : http_endpoint_request_configuration option;
    (*

    The configuration of request sent to the HTTP endpoint specified as the destination.

    *)
  8. cloud_watch_logging_options : cloud_watch_logging_options option;
  9. buffering_hints : http_endpoint_buffering_hints option;
    (*

    Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint destination. Firehose teats 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.

    *)
  10. endpoint_configuration : http_endpoint_description option;
    (*

    The configuration of the specified HTTP endpoint destination.

    *)
}

Describes the HTTP endpoint destination.

type nonrec http_endpoint_destination_configuration = {
  1. secrets_manager_configuration : secrets_manager_configuration option;
    (*

    The configuration that defines how you access secrets for HTTP Endpoint destination.

    *)
  2. s3_configuration : s3_destination_configuration;
  3. s3_backup_mode : http_endpoint_s3_backup_mode option;
    (*

    Describes the S3 bucket backup options for the data that Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData) or only the documents that Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).

    *)
  4. retry_options : http_endpoint_retry_options option;
    (*

    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.

    *)
  5. role_ar_n : role_ar_n option;
    (*

    Firehose uses this IAM role for all the permissions that the delivery stream needs.

    *)
  6. processing_configuration : processing_configuration option;
  7. request_configuration : http_endpoint_request_configuration option;
    (*

    The configuration of the request sent to the HTTP endpoint that is specified as the destination.

    *)
  8. cloud_watch_logging_options : cloud_watch_logging_options option;
  9. buffering_hints : http_endpoint_buffering_hints option;
    (*

    The buffering options that can be used before data is delivered to the specified 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 you specify a value for one of them, you must also provide a value for the other.

    *)
  10. endpoint_configuration : http_endpoint_configuration;
    (*

    The configuration of the HTTP endpoint selected as the destination.

    *)
}

Describes the configuration of the HTTP endpoint destination.

type nonrec delivery_stream_ar_n = string
type nonrec delivery_stream_status =
  1. | ACTIVE
  2. | DELETING_FAILED
  3. | DELETING
  4. | CREATING_FAILED
  5. | CREATING
type nonrec delivery_stream_encryption_status =
  1. | DISABLING_FAILED
  2. | DISABLING
  3. | DISABLED
  4. | ENABLING_FAILED
  5. | ENABLING
  6. | ENABLED
type nonrec delivery_stream_encryption_configuration = {
  1. failure_description : failure_description option;
    (*

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

    *)
  2. status : delivery_stream_encryption_status option;
    (*

    This is the server-side encryption (SSE) status for the Firehose stream. For a full description of the different values of this status, see StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. If this status is ENABLING_FAILED or DISABLING_FAILED, it is the status of the most recent attempt to enable or disable SSE, respectively.

    *)
  3. key_type : key_type option;
    (*

    Indicates the type of customer master key (CMK) that is used for encryption. The default setting is Amazon Web Services_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs).

    *)
  4. key_ar_n : awskms_key_arn_for_ss_e option;
    (*

    If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed CMK. If KeyType is Amazon Web Services_OWNED_CMK, DeliveryStreamEncryptionConfiguration doesn't contain a value for KeyARN.

    *)
}

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.

type nonrec extended_s3_destination_description = {
  1. custom_time_zone : custom_time_zone option;
    (*

    The time zone you prefer. UTC is the default.

    *)
  2. file_extension : file_extension option;
    (*

    Specify a file extension. It will override the default file extension

    *)
  3. dynamic_partitioning_configuration : dynamic_partitioning_configuration option;
    (*

    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.

    *)
  4. data_format_conversion_configuration : data_format_conversion_configuration option;
    (*

    The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

    *)
  5. s3_backup_description : s3_destination_description option;
    (*

    The configuration for backup in Amazon S3.

    *)
  6. s3_backup_mode : s3_backup_mode option;
    (*

    The Amazon S3 backup mode.

    *)
  7. processing_configuration : processing_configuration option;
    (*

    The data processing configuration.

    *)
  8. cloud_watch_logging_options : cloud_watch_logging_options option;
    (*

    The Amazon CloudWatch logging options for your Firehose stream.

    *)
  9. encryption_configuration : encryption_configuration;
    (*

    The encryption configuration. If no value is specified, the default is no encryption.

    *)
  10. compression_format : compression_format;
    (*

    The compression format. If no value is specified, the default is UNCOMPRESSED.

    *)
  11. buffering_hints : buffering_hints;
    (*

    The buffering option.

    *)
  12. error_output_prefix : error_output_prefix option;
    (*

    A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

    *)
  13. prefix : prefix option;
    (*

    The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

    *)
  14. bucket_ar_n : bucket_ar_n;
    (*

    The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    *)
  15. role_ar_n : role_ar_n;
    (*

    The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    *)
}

Describes a destination in Amazon S3.

type nonrec elasticsearch_s3_backup_mode =
  1. | AllDocuments
  2. | FailedDocumentsOnly
type nonrec elasticsearch_destination_description = {
  1. document_id_options : document_id_options option;
    (*

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

    *)
  2. vpc_configuration_description : vpc_configuration_description option;
    (*

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

    *)
  3. cloud_watch_logging_options : cloud_watch_logging_options option;
    (*

    The Amazon CloudWatch logging options.

    *)
  4. processing_configuration : processing_configuration option;
    (*

    The data processing configuration.

    *)
  5. s3_destination_description : s3_destination_description option;
    (*

    The Amazon S3 destination.

    *)
  6. s3_backup_mode : elasticsearch_s3_backup_mode option;
    (*

    The Amazon S3 backup mode.

    *)
  7. retry_options : elasticsearch_retry_options option;
    (*

    The Amazon OpenSearch Service retry options.

    *)
  8. buffering_hints : elasticsearch_buffering_hints option;
    (*

    The buffering options.

    *)
  9. index_rotation_period : elasticsearch_index_rotation_period option;
    (*

    The Elasticsearch index rotation period

    *)
  10. type_name : elasticsearch_type_name option;
    (*

    The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.

    *)
  11. index_name : elasticsearch_index_name option;
    (*

    The Elasticsearch index name.

    *)
  12. cluster_endpoint : elasticsearch_cluster_endpoint option;
    (*

    The endpoint to use when communicating with the cluster. Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.

    *)
  13. domain_ar_n : elasticsearch_domain_ar_n option;
    (*

    The ARN of the Amazon OpenSearch Service domain. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon OpenSearch Service.

    *)
  14. role_ar_n : role_ar_n option;
    (*

    The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    *)
}

The destination description in Amazon OpenSearch Service.

type nonrec amazonopensearchservice_s3_backup_mode =
  1. | AllDocuments
  2. | FailedDocumentsOnly
type nonrec amazonopensearchservice_destination_description = {
  1. document_id_options : document_id_options option;
    (*

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

    *)
  2. vpc_configuration_description : vpc_configuration_description option;
  3. cloud_watch_logging_options : cloud_watch_logging_options option;
  4. processing_configuration : processing_configuration option;
  5. s3_destination_description : s3_destination_description option;
  6. s3_backup_mode : amazonopensearchservice_s3_backup_mode option;
    (*

    The Amazon S3 backup mode.

    *)
  7. retry_options : amazonopensearchservice_retry_options option;
    (*

    The Amazon OpenSearch Service retry options.

    *)
  8. buffering_hints : amazonopensearchservice_buffering_hints option;
    (*

    The buffering options.

    *)
  9. index_rotation_period : amazonopensearchservice_index_rotation_period option;
    (*

    The Amazon OpenSearch Service index rotation period

    *)
  10. type_name : amazonopensearchservice_type_name option;
    (*

    The Amazon OpenSearch Service type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.

    *)
  11. index_name : amazonopensearchservice_index_name option;
    (*

    The Amazon OpenSearch Service index name.

    *)
  12. cluster_endpoint : amazonopensearchservice_cluster_endpoint option;
    (*

    The endpoint to use when communicating with the cluster. Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.

    *)
  13. domain_ar_n : amazonopensearchservice_domain_ar_n option;
    (*

    The ARN of the Amazon OpenSearch Service domain.

    *)
  14. role_ar_n : role_ar_n option;
    (*

    The Amazon Resource Name (ARN) of the Amazon Web Services credentials.

    *)
}

The destination description in Amazon OpenSearch Service.

type nonrec amazon_open_search_serverless_s3_backup_mode =
  1. | AllDocuments
  2. | FailedDocumentsOnly
type nonrec amazon_open_search_serverless_destination_description = {
  1. vpc_configuration_description : vpc_configuration_description option;
  2. cloud_watch_logging_options : cloud_watch_logging_options option;
  3. processing_configuration : processing_configuration option;
  4. s3_destination_description : s3_destination_description option;
  5. s3_backup_mode : amazon_open_search_serverless_s3_backup_mode option;
    (*

    The Amazon S3 backup mode.

    *)
  6. retry_options : amazon_open_search_serverless_retry_options option;
    (*

    The Serverless offering for Amazon OpenSearch Service retry options.

    *)
  7. buffering_hints : amazon_open_search_serverless_buffering_hints option;
    (*

    The buffering options.

    *)
  8. index_name : amazon_open_search_serverless_index_name option;
    (*

    The Serverless offering for Amazon OpenSearch Service index name.

    *)
  9. collection_endpoint : amazon_open_search_serverless_collection_endpoint option;
    (*

    The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.

    *)
  10. role_ar_n : role_ar_n option;
    (*

    The Amazon Resource Name (ARN) of the Amazon Web Services credentials.

    *)
}

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

type nonrec destination_description = {
  1. iceberg_destination_description : iceberg_destination_description option;
    (*

    Describes a destination in Apache Iceberg Tables.

    *)
  2. amazon_open_search_serverless_destination_description : amazon_open_search_serverless_destination_description option;
    (*

    The destination in the Serverless offering for Amazon OpenSearch Service.

    *)
  3. snowflake_destination_description : snowflake_destination_description option;
    (*

    Optional description for the destination

    *)
  4. http_endpoint_destination_description : http_endpoint_destination_description option;
    (*

    Describes the specified HTTP endpoint destination.

    *)
  5. splunk_destination_description : splunk_destination_description option;
    (*

    The destination in Splunk.

    *)
  6. amazonopensearchservice_destination_description : amazonopensearchservice_destination_description option;
    (*

    The destination in Amazon OpenSearch Service.

    *)
  7. elasticsearch_destination_description : elasticsearch_destination_description option;
    (*

    The destination in Amazon OpenSearch Service.

    *)
  8. redshift_destination_description : redshift_destination_description option;
    (*

    The destination in Amazon Redshift.

    *)
  9. extended_s3_destination_description : extended_s3_destination_description option;
    (*

    The destination in Amazon S3.

    *)
  10. s3_destination_description : s3_destination_description option;
    (*

    [Deprecated] The destination in Amazon S3.

    *)
  11. destination_id : destination_id;
    (*

    The ID of the destination.

    *)
}

Describes the destination for a Firehose stream.

type nonrec destination_description_list = destination_description list
type nonrec delivery_stream_description = {
  1. has_more_destinations : boolean_object;
    (*

    Indicates whether there are more destinations available to list.

    *)
  2. destinations : destination_description_list;
    (*

    The destinations.

    *)
  3. source : source_description option;
    (*

    If the DeliveryStreamType parameter is KinesisStreamAsSource, a SourceDescription object describing the source Kinesis data stream.

    *)
  4. last_update_timestamp : timestamp option;
    (*

    The date and time that the Firehose stream was last updated.

    *)
  5. create_timestamp : timestamp option;
    (*

    The date and time that the Firehose stream was created.

    *)
  6. version_id : delivery_stream_version_id;
    (*

    Each time the destination is updated for a Firehose stream, the version ID is changed, and the current version ID is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream.

    *)
  7. delivery_stream_type : delivery_stream_type;
    (*

    The Firehose stream type. This can be one of the following values:

    • DirectPut: Provider applications access the Firehose stream directly.
    • KinesisStreamAsSource: The Firehose stream uses a Kinesis data stream as a source.
    *)
  8. delivery_stream_encryption_configuration : delivery_stream_encryption_configuration option;
    (*

    Indicates the server-side encryption (SSE) status for the Firehose stream.

    *)
  9. failure_description : failure_description option;
    (*

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

    *)
  10. delivery_stream_status : delivery_stream_status;
    (*

    The status of the Firehose stream. 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.

    *)
  11. delivery_stream_ar_n : delivery_stream_ar_n;
    (*

    The Amazon Resource Name (ARN) of the Firehose stream. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    *)
  12. delivery_stream_name : delivery_stream_name;
    (*

    The name of the Firehose stream.

    *)
}

Contains information about a Firehose stream.

type nonrec describe_delivery_stream_output = {
  1. delivery_stream_description : delivery_stream_description;
    (*

    Information about the Firehose stream.

    *)
}
type nonrec describe_delivery_stream_input_limit = int
type nonrec describe_delivery_stream_input = {
  1. exclusive_start_destination_id : destination_id option;
    (*

    The ID of the destination to start returning the destination information. Firehose supports one destination per Firehose stream.

    *)
  2. limit : describe_delivery_stream_input_limit option;
    (*

    The limit on the number of destinations to return. You can have one destination per Firehose stream.

    *)
  3. delivery_stream_name : delivery_stream_name;
    (*

    The name of the Firehose stream.

    *)
}
type nonrec delete_delivery_stream_output = unit
type nonrec delete_delivery_stream_input = {
  1. allow_force_delete : boolean_object option;
    (*

    Set this to true if you want to delete the Firehose stream even if Firehose is unable to retire the grant for the CMK. Firehose might be unable to retire the grant due to a customer error, such as when the CMK or the grant are in an invalid state. If you force deletion, you can then use the RevokeGrant operation to revoke the grant you gave to Firehose. If a failure to retire the grant happens due to an Amazon Web Services KMS issue, Firehose keeps retrying the delete operation.

    The default value is false.

    *)
  2. delivery_stream_name : delivery_stream_name;
    (*

    The name of the Firehose stream.

    *)
}
type nonrec create_delivery_stream_output = {
  1. delivery_stream_ar_n : delivery_stream_ar_n option;
    (*

    The ARN of the Firehose stream.

    *)
}
type nonrec direct_put_source_configuration = {
  1. throughput_hint_in_m_bs : throughput_hint_in_m_bs;
    (*

    The value that you configure for this parameter is for information purpose only and does not affect Firehose delivery throughput limit. You can use the Firehose Limits form to request a throughput limit increase.

    *)
}

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

type nonrec extended_s3_destination_configuration = {
  1. custom_time_zone : custom_time_zone option;
    (*

    The time zone you prefer. UTC is the default.

    *)
  2. file_extension : file_extension option;
    (*

    Specify a file extension. It will override the default file extension

    *)
  3. dynamic_partitioning_configuration : dynamic_partitioning_configuration option;
    (*

    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.

    *)
  4. data_format_conversion_configuration : data_format_conversion_configuration option;
    (*

    The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

    *)
  5. s3_backup_configuration : s3_destination_configuration option;
    (*

    The configuration for backup in Amazon S3.

    *)
  6. s3_backup_mode : s3_backup_mode option;
    (*

    The Amazon S3 backup mode. After you create a Firehose stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the Firehose stream to disable it.

    *)
  7. processing_configuration : processing_configuration option;
    (*

    The data processing configuration.

    *)
  8. cloud_watch_logging_options : cloud_watch_logging_options option;
    (*

    The Amazon CloudWatch logging options for your Firehose stream.

    *)
  9. encryption_configuration : encryption_configuration option;
    (*

    The encryption configuration. If no value is specified, the default is no encryption.

    *)
  10. compression_format : compression_format option;
    (*

    The compression format. If no value is specified, the default is UNCOMPRESSED.

    *)
  11. buffering_hints : buffering_hints option;
    (*

    The buffering option.

    *)
  12. error_output_prefix : error_output_prefix option;
    (*

    A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

    *)
  13. prefix : prefix option;
    (*

    The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

    *)
  14. bucket_ar_n : bucket_ar_n;
    (*

    The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    *)
  15. role_ar_n : role_ar_n;
    (*

    The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    *)
}

Describes the configuration of a destination in Amazon S3.

type nonrec elasticsearch_destination_configuration = {
  1. document_id_options : document_id_options option;
    (*

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

    *)
  2. vpc_configuration : vpc_configuration option;
    (*

    The details of the VPC of the Amazon destination.

    *)
  3. cloud_watch_logging_options : cloud_watch_logging_options option;
    (*

    The Amazon CloudWatch logging options for your Firehose stream.

    *)
  4. processing_configuration : processing_configuration option;
    (*

    The data processing configuration.

    *)
  5. s3_configuration : s3_destination_configuration;
    (*

    The configuration for the backup Amazon S3 location.

    *)
  6. s3_backup_mode : elasticsearch_s3_backup_mode option;
    (*

    Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the Amazon OpenSearch Service Destination. Default value is FailedDocumentsOnly.

    You can't change this backup mode after you create the Firehose stream.

    *)
  7. retry_options : elasticsearch_retry_options option;
    (*

    The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).

    *)
  8. buffering_hints : elasticsearch_buffering_hints option;
    (*

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

    *)
  9. index_rotation_period : elasticsearch_index_rotation_period option;
    (*

    The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon OpenSearch Service Destination. The default value is OneDay.

    *)
  10. type_name : elasticsearch_type_name option;
    (*

    The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Firehose returns an error during run time.

    For Elasticsearch 7.x, don't specify a TypeName.

    *)
  11. index_name : elasticsearch_index_name;
    (*

    The Elasticsearch index name.

    *)
  12. cluster_endpoint : elasticsearch_cluster_endpoint option;
    (*

    The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

    *)
  13. domain_ar_n : elasticsearch_domain_ar_n option;
    (*

    The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    Specify either ClusterEndpoint or DomainARN.

    *)
  14. role_ar_n : role_ar_n;
    (*

    The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents. For more information, see Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    *)
}

Describes the configuration of a destination in Amazon OpenSearch Service.

type nonrec amazonopensearchservice_destination_configuration = {
  1. document_id_options : document_id_options option;
    (*

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

    *)
  2. vpc_configuration : vpc_configuration option;
  3. cloud_watch_logging_options : cloud_watch_logging_options option;
  4. processing_configuration : processing_configuration option;
  5. s3_configuration : s3_destination_configuration;
  6. s3_backup_mode : amazonopensearchservice_s3_backup_mode option;
    (*

    Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.

    *)
  7. retry_options : amazonopensearchservice_retry_options option;
    (*

    The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).

    *)
  8. buffering_hints : amazonopensearchservice_buffering_hints option;
    (*

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

    *)
  9. index_rotation_period : amazonopensearchservice_index_rotation_period option;
    (*

    The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.

    *)
  10. type_name : amazonopensearchservice_type_name option;
    (*

    The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Firehose returns an error during run time.

    *)
  11. index_name : amazonopensearchservice_index_name;
    (*

    The ElasticsearAmazon OpenSearch Service index name.

    *)
  12. cluster_endpoint : amazonopensearchservice_cluster_endpoint option;
    (*

    The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

    *)
  13. domain_ar_n : amazonopensearchservice_domain_ar_n option;
    (*

    The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN.

    *)
  14. role_ar_n : role_ar_n;
    (*

    The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.

    *)
}

Describes the configuration of a destination in Amazon OpenSearch Service

type nonrec amazon_open_search_serverless_destination_configuration = {
  1. vpc_configuration : vpc_configuration option;
  2. cloud_watch_logging_options : cloud_watch_logging_options option;
  3. processing_configuration : processing_configuration option;
  4. s3_configuration : s3_destination_configuration;
  5. s3_backup_mode : amazon_open_search_serverless_s3_backup_mode option;
    (*

    Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.

    *)
  6. retry_options : amazon_open_search_serverless_retry_options option;
    (*

    The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).

    *)
  7. buffering_hints : amazon_open_search_serverless_buffering_hints option;
    (*

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

    *)
  8. index_name : amazon_open_search_serverless_index_name;
    (*

    The Serverless offering for Amazon OpenSearch Service index name.

    *)
  9. collection_endpoint : amazon_open_search_serverless_collection_endpoint option;
    (*

    The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.

    *)
  10. role_ar_n : role_ar_n;
    (*

    The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.

    *)
}

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

type nonrec database_surrogate_key_list = non_empty_string_without_whitespace list
type nonrec database_source_configuration = {
  1. database_source_vpc_configuration : database_source_vpc_configuration;
    (*

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

    *)
  2. database_source_authentication_configuration : database_source_authentication_configuration;
    (*

    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.

    *)
  3. snapshot_watermark_table : database_table_name;
    (*

    The fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
  4. surrogate_keys : database_surrogate_key_list option;
    (*

    The optional list of table and column names used as unique key columns when taking snapshot if the tables don’t have primary keys configured.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
  5. columns : database_column_list option;
    (*

    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.

    *)
  6. tables : database_table_list;
    (*

    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.

    *)
  7. databases : database_list;
    (*

    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.

    *)
  8. ssl_mode : ssl_mode option;
    (*

    The mode to enable or disable SSL when Firehose connects to the database endpoint.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
  9. port : database_port;
    (*

    The port of the database. This can be one of the following values.

    • 3306 for MySQL database type
    • 5432 for PostgreSQL database type

    Amazon Data Firehose is in preview release and is subject to change.

    *)
  10. endpoint : database_endpoint;
    (*

    The endpoint of the database server.

    Amazon Data Firehose is in preview release and is subject to change.

    *)
  11. type_ : database_type;
    (*

    The type of database engine. This can be one of the following values.

    • MySQL
    • PostgreSQL

    Amazon Data Firehose is in preview release and is subject to change.

    *)
}

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

Amazon Data Firehose is in preview release and is subject to change.

type nonrec create_delivery_stream_input = {
  1. database_source_configuration : database_source_configuration option;
    (*

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

    Amazon Data Firehose is in preview release and is subject to change.

    *)
  2. iceberg_destination_configuration : iceberg_destination_configuration option;
    (*

    Configure Apache Iceberg Tables destination.

    *)
  3. snowflake_destination_configuration : snowflake_destination_configuration option;
    (*

    Configure Snowflake destination

    *)
  4. msk_source_configuration : msk_source_configuration option;
  5. amazon_open_search_serverless_destination_configuration : amazon_open_search_serverless_destination_configuration option;
    (*

    The destination in the Serverless offering for Amazon OpenSearch Service. You can specify only one destination.

    *)
  6. tags : tag_delivery_stream_input_tag_list option;
    (*

    A set of tags to assign to the Firehose stream. A tag is a key-value pair that you can define and assign to Amazon Web Services resources. 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.

    You can specify up to 50 tags when creating a Firehose stream.

    If you specify tags in the CreateDeliveryStream action, Amazon Data Firehose performs an additional authorization on the firehose:TagDeliveryStream action to verify if users have permissions to create tags. If you do not provide this permission, requests to create new Firehose streams with IAM resource tags will fail with an AccessDeniedException such as following.

    AccessDeniedException

    User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy.

    For an example IAM policy, see Tag example.

    *)
  7. http_endpoint_destination_configuration : http_endpoint_destination_configuration option;
    (*

    Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.

    *)
  8. splunk_destination_configuration : splunk_destination_configuration option;
    (*

    The destination in Splunk. You can specify only one destination.

    *)
  9. amazonopensearchservice_destination_configuration : amazonopensearchservice_destination_configuration option;
    (*

    The destination in Amazon OpenSearch Service. You can specify only one destination.

    *)
  10. elasticsearch_destination_configuration : elasticsearch_destination_configuration option;
    (*

    The destination in Amazon OpenSearch Service. You can specify only one destination.

    *)
  11. redshift_destination_configuration : redshift_destination_configuration option;
    (*

    The destination in Amazon Redshift. You can specify only one destination.

    *)
  12. extended_s3_destination_configuration : extended_s3_destination_configuration option;
    (*

    The destination in Amazon S3. You can specify only one destination.

    *)
  13. s3_destination_configuration : s3_destination_configuration option;
    (*

    [Deprecated] The destination in Amazon S3. You can specify only one destination.

    *)
  14. delivery_stream_encryption_configuration_input : delivery_stream_encryption_configuration_input option;
    (*

    Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).

    *)
  15. kinesis_stream_source_configuration : kinesis_stream_source_configuration option;
    (*

    When a Kinesis data stream is used as the source for the Firehose stream, a KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon Resource Name (ARN) and the role ARN for the source stream.

    *)
  16. direct_put_source_configuration : direct_put_source_configuration option;
    (*

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

    *)
  17. delivery_stream_type : delivery_stream_type option;
    (*

    The Firehose stream type. This parameter can be one of the following values:

    • DirectPut: Provider applications access the Firehose stream directly.
    • KinesisStreamAsSource: The Firehose stream uses a Kinesis data stream as a source.
    *)
  18. delivery_stream_name : delivery_stream_name;
    (*

    The name of the Firehose stream. This name must be unique per Amazon Web Services account in the same Amazon Web Services Region. If the Firehose streams are in different accounts or different Regions, you can have multiple Firehose streams with the same name.

    *)
}