Smaws_Client_TimestreamWrite (smaws-clients.Smaws_Client

Types

module Types : sig ... end

Builders

val make_records_ingested : 
  ?magnetic_store:Types.integer ->
  ?memory_store:Types.integer ->
  ?total:Types.integer ->
  unit ->
  Types.records_ingested

val make_write_records_response : 
  ?records_ingested:Types.records_ingested ->
  unit ->
  Types.write_records_response

val make_dimension : 
  ?dimension_value_type:Types.dimension_value_type ->
  value:Types.schema_value ->
  name:Types.schema_name ->
  unit ->
  Types.dimension

val make_measure_value : 
  type_:Types.measure_value_type ->
  value:Types.string_value2048 ->
  name:Types.schema_name ->
  unit ->
  Types.measure_value

val make_record : 
  ?measure_values:Types.measure_values ->
  ?version:Types.record_version ->
  ?time_unit:Types.time_unit ->
  ?time:Types.string_value256 ->
  ?measure_value_type:Types.measure_value_type ->
  ?measure_value:Types.string_value2048 ->
  ?measure_name:Types.schema_name ->
  ?dimensions:Types.dimensions ->
  unit ->
  Types.record

val make_write_records_request : 
  ?common_attributes:Types.record ->
  records:Types.records ->
  table_name:Types.resource_name ->
  database_name:Types.resource_name ->
  unit ->
  Types.write_records_request

val make_rejected_record : 
  ?existing_version:Types.record_version ->
  ?reason:Types.error_message ->
  ?record_index:Types.record_index ->
  unit ->
  Types.rejected_record

val make_retention_properties : 
  magnetic_store_retention_period_in_days:
    Types.magnetic_store_retention_period_in_days ->
  memory_store_retention_period_in_hours:
    Types.memory_store_retention_period_in_hours ->
  unit ->
  Types.retention_properties

val make_s3_configuration : 
  ?kms_key_id:Types.string_value2048 ->
  ?encryption_option:Types.s3_encryption_option ->
  ?object_key_prefix:Types.s3_object_key_prefix ->
  ?bucket_name:Types.s3_bucket_name ->
  unit ->
  Types.s3_configuration

val make_magnetic_store_rejected_data_location : 
  ?s3_configuration:Types.s3_configuration ->
  unit ->
  Types.magnetic_store_rejected_data_location

val make_magnetic_store_write_properties : 
  ?magnetic_store_rejected_data_location:
    Types.magnetic_store_rejected_data_location ->
  enable_magnetic_store_writes:Types.boolean_ ->
  unit ->
  Types.magnetic_store_write_properties

val make_partition_key : 
  ?enforcement_in_record:Types.partition_key_enforcement_level ->
  ?name:Types.schema_name ->
  type_:Types.partition_key_type ->
  unit ->
  Types.partition_key

val make_schema : 
  ?composite_partition_key:Types.partition_key_list ->
  unit ->
  Types.schema

val make_table : 
  ?schema:Types.schema ->
  ?magnetic_store_write_properties:Types.magnetic_store_write_properties ->
  ?last_updated_time:Types.date ->
  ?creation_time:Types.date ->
  ?retention_properties:Types.retention_properties ->
  ?table_status:Types.table_status ->
  ?database_name:Types.resource_name ->
  ?table_name:Types.resource_name ->
  ?arn:Types.string_ ->
  unit ->
  Types.table

val make_update_table_response : 
  ?table:Types.table ->
  unit ->
  Types.update_table_response

val make_update_table_request : 
  ?schema:Types.schema ->
  ?magnetic_store_write_properties:Types.magnetic_store_write_properties ->
  ?retention_properties:Types.retention_properties ->
  table_name:Types.resource_name ->
  database_name:Types.resource_name ->
  unit ->
  Types.update_table_request

val make_database : 
  ?last_updated_time:Types.date ->
  ?creation_time:Types.date ->
  ?kms_key_id:Types.string_value2048 ->
  ?table_count:Types.long ->
  ?database_name:Types.resource_name ->
  ?arn:Types.string_ ->
  unit ->
  Types.database

val make_update_database_response : 
  ?database:Types.database ->
  unit ->
  Types.update_database_response

val make_update_database_request : 
  kms_key_id:Types.string_value2048 ->
  database_name:Types.resource_name ->
  unit ->
  Types.update_database_request

val make_untag_resource_response : unit -> unit

val make_untag_resource_request : 
  tag_keys:Types.tag_key_list ->
  resource_ar_n:Types.amazon_resource_name ->
  unit ->
  Types.untag_resource_request

val make_tag_resource_response : unit -> unit

val make_tag : value:Types.tag_value -> key:Types.tag_key -> unit -> Types.tag

val make_tag_resource_request : 
  tags:Types.tag_list ->
  resource_ar_n:Types.amazon_resource_name ->
  unit ->
  Types.tag_resource_request

val make_resume_batch_load_task_response : unit -> unit

val make_resume_batch_load_task_request : 
  task_id:Types.batch_load_task_id ->
  unit ->
  Types.resume_batch_load_task_request

val make_list_tags_for_resource_response : 
  ?tags:Types.tag_list ->
  unit ->
  Types.list_tags_for_resource_response

val make_list_tags_for_resource_request : 
  resource_ar_n:Types.amazon_resource_name ->
  unit ->
  Types.list_tags_for_resource_request

val make_list_tables_response : 
  ?next_token:Types.string_ ->
  ?tables:Types.table_list ->
  unit ->
  Types.list_tables_response

val make_list_tables_request : 
  ?max_results:Types.pagination_limit ->
  ?next_token:Types.string_ ->
  ?database_name:Types.resource_name ->
  unit ->
  Types.list_tables_request

val make_list_databases_response : 
  ?next_token:Types.string_ ->
  ?databases:Types.database_list ->
  unit ->
  Types.list_databases_response

val make_list_databases_request : 
  ?max_results:Types.pagination_limit ->
  ?next_token:Types.string_ ->
  unit ->
  Types.list_databases_request

val make_batch_load_task : 
  ?resumable_until:Types.date ->
  ?last_updated_time:Types.date ->
  ?creation_time:Types.date ->
  ?table_name:Types.resource_name ->
  ?database_name:Types.resource_name ->
  ?task_status:Types.batch_load_status ->
  ?task_id:Types.batch_load_task_id ->
  unit ->
  Types.batch_load_task

val make_list_batch_load_tasks_response : 
  ?batch_load_tasks:Types.batch_load_task_list ->
  ?next_token:Types.string_ ->
  unit ->
  Types.list_batch_load_tasks_response

val make_list_batch_load_tasks_request : 
  ?task_status:Types.batch_load_status ->
  ?max_results:Types.page_limit ->
  ?next_token:Types.string_ ->
  unit ->
  Types.list_batch_load_tasks_request

val make_describe_table_response : 
  ?table:Types.table ->
  unit ->
  Types.describe_table_response

val make_describe_table_request : 
  table_name:Types.resource_name ->
  database_name:Types.resource_name ->
  unit ->
  Types.describe_table_request

val make_endpoint : 
  cache_period_in_minutes:Types.long ->
  address:Types.string_ ->
  unit ->
  Types.endpoint

val make_describe_endpoints_response : 
  endpoints:Types.endpoints ->
  unit ->
  Types.describe_endpoints_response

val make_describe_endpoints_request : unit -> unit

val make_describe_database_response : 
  ?database:Types.database ->
  unit ->
  Types.describe_database_response

val make_describe_database_request : 
  database_name:Types.resource_name ->
  unit ->
  Types.describe_database_request

val make_data_source_s3_configuration : 
  ?object_key_prefix:Types.s3_object_key ->
  bucket_name:Types.s3_bucket_name ->
  unit ->
  Types.data_source_s3_configuration

val make_csv_configuration : 
  ?trim_white_space:Types.boolean_ ->
  ?null_value:Types.string_value256 ->
  ?quote_char:Types.string_value1 ->
  ?escape_char:Types.string_value1 ->
  ?column_separator:Types.string_value1 ->
  unit ->
  Types.csv_configuration

val make_data_source_configuration : 
  ?csv_configuration:Types.csv_configuration ->
  data_format:Types.batch_load_data_format ->
  data_source_s3_configuration:Types.data_source_s3_configuration ->
  unit ->
  Types.data_source_configuration

val make_batch_load_progress_report : 
  ?bytes_metered:Types.long ->
  ?file_failures:Types.long ->
  ?record_ingestion_failures:Types.long ->
  ?parse_failures:Types.long ->
  ?records_ingested:Types.long ->
  ?records_processed:Types.long ->
  unit ->
  Types.batch_load_progress_report

val make_report_s3_configuration : 
  ?kms_key_id:Types.string_value2048 ->
  ?encryption_option:Types.s3_encryption_option ->
  ?object_key_prefix:Types.s3_object_key_prefix ->
  bucket_name:Types.s3_bucket_name ->
  unit ->
  Types.report_s3_configuration

val make_report_configuration : 
  ?report_s3_configuration:Types.report_s3_configuration ->
  unit ->
  Types.report_configuration

val make_dimension_mapping : 
  ?destination_column:Types.schema_name ->
  ?source_column:Types.schema_name ->
  unit ->
  Types.dimension_mapping

val make_multi_measure_attribute_mapping : 
  ?measure_value_type:Types.scalar_measure_value_type ->
  ?target_multi_measure_attribute_name:Types.schema_name ->
  source_column:Types.schema_name ->
  unit ->
  Types.multi_measure_attribute_mapping

val make_multi_measure_mappings : 
  ?target_multi_measure_name:Types.schema_name ->
  multi_measure_attribute_mappings:Types.multi_measure_attribute_mapping_list ->
  unit ->
  Types.multi_measure_mappings

val make_mixed_measure_mapping : 
  ?multi_measure_attribute_mappings:Types.multi_measure_attribute_mapping_list ->
  ?target_measure_name:Types.schema_name ->
  ?source_column:Types.schema_name ->
  ?measure_name:Types.schema_name ->
  measure_value_type:Types.measure_value_type ->
  unit ->
  Types.mixed_measure_mapping

val make_data_model : 
  ?measure_name_column:Types.string_value256 ->
  ?mixed_measure_mappings:Types.mixed_measure_mapping_list ->
  ?multi_measure_mappings:Types.multi_measure_mappings ->
  ?time_unit:Types.time_unit ->
  ?time_column:Types.string_value256 ->
  dimension_mappings:Types.dimension_mappings ->
  unit ->
  Types.data_model

val make_data_model_s3_configuration : 
  ?object_key:Types.s3_object_key ->
  ?bucket_name:Types.s3_bucket_name ->
  unit ->
  Types.data_model_s3_configuration

val make_data_model_configuration : 
  ?data_model_s3_configuration:Types.data_model_s3_configuration ->
  ?data_model:Types.data_model ->
  unit ->
  Types.data_model_configuration

val make_batch_load_task_description : 
  ?resumable_until:Types.date ->
  ?last_updated_time:Types.date ->
  ?creation_time:Types.date ->
  ?record_version:Types.record_version ->
  ?task_status:Types.batch_load_status ->
  ?target_table_name:Types.resource_name ->
  ?target_database_name:Types.resource_name ->
  ?data_model_configuration:Types.data_model_configuration ->
  ?report_configuration:Types.report_configuration ->
  ?progress_report:Types.batch_load_progress_report ->
  ?data_source_configuration:Types.data_source_configuration ->
  ?error_message:Types.string_value2048 ->
  ?task_id:Types.batch_load_task_id ->
  unit ->
  Types.batch_load_task_description

val make_describe_batch_load_task_response : 
  batch_load_task_description:Types.batch_load_task_description ->
  unit ->
  Types.describe_batch_load_task_response

val make_describe_batch_load_task_request : 
  task_id:Types.batch_load_task_id ->
  unit ->
  Types.describe_batch_load_task_request

val make_delete_table_request : 
  table_name:Types.resource_name ->
  database_name:Types.resource_name ->
  unit ->
  Types.delete_table_request

val make_delete_database_request : 
  database_name:Types.resource_name ->
  unit ->
  Types.delete_database_request

val make_create_table_response : 
  ?table:Types.table ->
  unit ->
  Types.create_table_response

val make_create_table_request : 
  ?schema:Types.schema ->
  ?magnetic_store_write_properties:Types.magnetic_store_write_properties ->
  ?tags:Types.tag_list ->
  ?retention_properties:Types.retention_properties ->
  table_name:Types.resource_create_api_name ->
  database_name:Types.resource_create_api_name ->
  unit ->
  Types.create_table_request

val make_create_database_response : 
  ?database:Types.database ->
  unit ->
  Types.create_database_response

val make_create_database_request : 
  ?tags:Types.tag_list ->
  ?kms_key_id:Types.string_value2048 ->
  database_name:Types.resource_create_api_name ->
  unit ->
  Types.create_database_request

val make_create_batch_load_task_response : 
  task_id:Types.batch_load_task_id ->
  unit ->
  Types.create_batch_load_task_response

val make_create_batch_load_task_request : 
  ?record_version:Types.record_version ->
  ?data_model_configuration:Types.data_model_configuration ->
  ?client_token:Types.client_request_token ->
  target_table_name:Types.resource_create_api_name ->
  target_database_name:Types.resource_create_api_name ->
  report_configuration:Types.report_configuration ->
  data_source_configuration:Types.data_source_configuration ->
  unit ->
  Types.create_batch_load_task_request

Operations

module CreateBatchLoadTask : sig ... end

Creates a new Timestream batch load task. A batch load task processes data from a CSV source in an S3 location and writes to a Timestream table. A mapping from source to target is defined in a batch load task. Errors and events are written to a report at an S3 location. For the report, if the KMS key is not specified, the report will be encrypted with an S3 managed key when SSE_S3 is the option. Otherwise an error is thrown. For more information, see Amazon Web Services managed keys. Service quotas apply. For details, see code sample.

module CreateDatabase : sig ... end

Creates a new Timestream database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account. For more information, see Amazon Web Services managed keys. Service quotas apply. For details, see code sample.

module CreateTable : sig ... end

Adds a new table to an existing database in your account. In an Amazon Web Services account, table names must be at least unique within each Region if they are in the same database. You might have identical table names in the same Region if the tables are in separate databases. While creating the table, you must specify the table name, database name, and the retention properties. Service quotas apply. See code sample for details.

module DeleteDatabase : sig ... end

Deletes a given Timestream database. This is an irreversible operation. After a database is deleted, the time-series data from its tables cannot be recovered.

module DeleteTable : sig ... end

Deletes a given Timestream table. This is an irreversible operation. After a Timestream database table is deleted, the time-series data stored in the table cannot be recovered.

module DescribeBatchLoadTask : sig ... end

Returns information about the batch load task, including configurations, mappings, progress, and other details. Service quotas apply. See code sample for details.

module DescribeDatabase : sig ... end

Returns information about the database, including the database name, time that the database was created, and the total number of tables found within the database. Service quotas apply. See code sample for details.

module DescribeEndpoints : sig ... end

Returns a list of available endpoints to make Timestream API calls against. This API operation is available through both the Write and Query APIs.

module DescribeTable : sig ... end

Returns information about the table, including the table name, database name, retention duration of the memory store and the magnetic store. Service quotas apply. See code sample for details.

module ListBatchLoadTasks : sig ... end

Provides a list of batch load tasks, along with the name, status, when the task is resumable until, and other details. See code sample for details.

module ListDatabases : sig ... end

Returns a list of your Timestream databases. Service quotas apply. See code sample for details.

module ListTables : sig ... end

Provides a list of tables, along with the name, status, and retention properties of each table. See code sample for details.

module ListTagsForResource : sig ... end

Lists all tags on a Timestream resource.

module ResumeBatchLoadTask : sig ... end

module TagResource : sig ... end

Associates a set of tags with a Timestream resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking.

module UntagResource : sig ... end

Removes the association of tags from a Timestream resource.

module UpdateDatabase : sig ... end

Modifies the KMS key for an existing database. While updating the database, you must specify the database name and the identifier of the new KMS key to be used (KmsKeyId). If there are any concurrent UpdateDatabase requests, first writer wins.

module UpdateTable : sig ... end

Modifies the retention duration of the memory store and magnetic store for your Timestream table. Note that the change in retention duration takes effect immediately. For example, if the retention period of the memory store was initially set to 2 hours and then changed to 24 hours, the memory store will be capable of holding 24 hours of data, but will be populated with 24 hours of data 22 hours after this change was made. Timestream does not retrieve data from the magnetic store to populate the memory store.

module WriteRecords : sig ... end

module Json_serializers : sig ... end

module Json_deserializers : sig ... end