Module Smaws_Client_TimestreamQuery

Timestream Query client library built on EIO.

Types

module Types : sig ... end

Builders

val make_update_scheduled_query_request : state:Types.scheduled_query_state -> scheduled_query_arn:Types.amazon_resource_name -> unit -> Types.update_scheduled_query_request
val make_sns_configuration : topic_arn:Types.amazon_resource_name -> unit -> Types.sns_configuration
val make_account_settings_notification_configuration : ?sns_configuration:Types.sns_configuration -> role_arn:Types.amazon_resource_name -> unit -> Types.account_settings_notification_configuration
val make_last_update : ?status_message:Types.string_ -> ?status:Types.last_update_status -> ?target_query_tc_u:Types.query_tc_u -> unit -> Types.last_update
val make_provisioned_capacity_response : ?last_update:Types.last_update -> ?notification_configuration:Types.account_settings_notification_configuration -> ?active_query_tc_u:Types.query_tc_u -> unit -> Types.provisioned_capacity_response
val make_query_compute_response : ?provisioned_capacity:Types.provisioned_capacity_response -> ?compute_mode:Types.compute_mode -> unit -> Types.query_compute_response
val make_update_account_settings_response : ?query_compute:Types.query_compute_response -> ?query_pricing_model:Types.query_pricing_model -> ?max_query_tc_u:Types.max_query_capacity -> unit -> Types.update_account_settings_response
val make_provisioned_capacity_request : ?notification_configuration:Types.account_settings_notification_configuration -> target_query_tc_u:Types.query_tc_u -> unit -> Types.provisioned_capacity_request
val make_query_compute_request : ?provisioned_capacity:Types.provisioned_capacity_request -> ?compute_mode:Types.compute_mode -> unit -> Types.query_compute_request
val make_update_account_settings_request : ?query_compute:Types.query_compute_request -> ?query_pricing_model:Types.query_pricing_model -> ?max_query_tc_u:Types.max_query_capacity -> unit -> Types.update_account_settings_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_column_info : ?name:Types.string_ -> type_:Types.type_ -> unit -> Types.column_info
val make_type_ : ?row_column_info:Types.column_info_list -> ?time_series_measure_value_column_info:Types.column_info -> ?array_column_info:Types.column_info -> ?scalar_type:Types.scalar_type -> unit -> Types.type_
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_datum : ?null_value:Types.nullable_boolean -> ?row_value:Types.row -> ?array_value:Types.datum_list -> ?time_series_value:Types.time_series_data_point_list -> ?scalar_value:Types.scalar_value -> unit -> Types.datum
val make_row : data:Types.datum_list -> unit -> Types.row
val make_time_series_data_point : value:Types.datum -> time:Types.timestamp -> unit -> Types.time_series_data_point
val make_query_status : ?cumulative_bytes_metered:Types.long -> ?cumulative_bytes_scanned:Types.long -> ?progress_percentage:Types.double -> unit -> Types.query_status
val make_query_spatial_coverage_max : ?partition_key:Types.partition_key_list -> ?table_arn:Types.amazon_resource_name -> ?value:Types.double -> unit -> Types.query_spatial_coverage_max
val make_query_spatial_coverage : ?max:Types.query_spatial_coverage_max -> unit -> Types.query_spatial_coverage
val make_query_temporal_range_max : ?table_arn:Types.amazon_resource_name -> ?value:Types.long -> unit -> Types.query_temporal_range_max
val make_query_temporal_range : ?max:Types.query_temporal_range_max -> unit -> Types.query_temporal_range
val make_query_insights_response : ?unload_written_bytes:Types.long -> ?unload_written_rows:Types.long -> ?unload_partition_count:Types.long -> ?output_bytes:Types.long -> ?output_rows:Types.long -> ?query_table_count:Types.long -> ?query_temporal_range:Types.query_temporal_range -> ?query_spatial_coverage:Types.query_spatial_coverage -> unit -> Types.query_insights_response
val make_query_response : ?query_insights_response:Types.query_insights_response -> ?query_status:Types.query_status -> ?next_token:Types.pagination_token -> column_info:Types.column_info_list -> rows:Types.row_list -> query_id:Types.query_id -> unit -> Types.query_response
val make_query_insights : mode:Types.query_insights_mode -> unit -> Types.query_insights
val make_query_request : ?query_insights:Types.query_insights -> ?max_rows:Types.max_query_results -> ?next_token:Types.pagination_token -> ?client_token:Types.client_request_token -> query_string:Types.query_string -> unit -> Types.query_request
val make_select_column : ?aliased:Types.nullable_boolean -> ?table_name:Types.resource_name -> ?database_name:Types.resource_name -> ?type_:Types.type_ -> ?name:Types.string_ -> unit -> Types.select_column
val make_parameter_mapping : type_:Types.type_ -> name:Types.string_ -> unit -> Types.parameter_mapping
val make_prepare_query_response : parameters:Types.parameter_mapping_list -> columns:Types.select_column_list -> query_string:Types.query_string -> unit -> Types.prepare_query_response
val make_prepare_query_request : ?validate_only:Types.nullable_boolean -> query_string:Types.query_string -> unit -> Types.prepare_query_request
val make_list_tags_for_resource_response : ?next_token:Types.next_tags_for_resource_results_token -> tags:Types.tag_list -> unit -> Types.list_tags_for_resource_response
val make_list_tags_for_resource_request : ?next_token:Types.next_tags_for_resource_results_token -> ?max_results:Types.max_tags_for_resource_result -> resource_ar_n:Types.amazon_resource_name -> unit -> Types.list_tags_for_resource_request
val make_s3_configuration : ?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_error_report_configuration : s3_configuration:Types.s3_configuration -> unit -> Types.error_report_configuration
val make_timestream_destination : ?table_name:Types.resource_name -> ?database_name:Types.resource_name -> unit -> Types.timestream_destination
val make_target_destination : ?timestream_destination:Types.timestream_destination -> unit -> Types.target_destination
val make_scheduled_query : ?last_run_status:Types.scheduled_query_run_status -> ?target_destination:Types.target_destination -> ?error_report_configuration:Types.error_report_configuration -> ?next_invocation_time:Types.time -> ?previous_invocation_time:Types.time -> ?creation_time:Types.time -> state:Types.scheduled_query_state -> name:Types.scheduled_query_name -> arn:Types.amazon_resource_name -> unit -> Types.scheduled_query
val make_list_scheduled_queries_response : ?next_token:Types.next_scheduled_queries_results_token -> scheduled_queries:Types.scheduled_query_list -> unit -> Types.list_scheduled_queries_response
val make_list_scheduled_queries_request : ?next_token:Types.next_scheduled_queries_results_token -> ?max_results:Types.max_scheduled_queries_results -> unit -> Types.list_scheduled_queries_request
val make_scheduled_query_insights : mode:Types.scheduled_query_insights_mode -> unit -> Types.scheduled_query_insights
val make_execute_scheduled_query_request : ?query_insights:Types.scheduled_query_insights -> ?client_token:Types.client_token -> invocation_time:Types.time -> scheduled_query_arn:Types.amazon_resource_name -> unit -> Types.execute_scheduled_query_request
val make_schedule_configuration : schedule_expression:Types.schedule_expression -> unit -> Types.schedule_configuration
val make_notification_configuration : sns_configuration:Types.sns_configuration -> unit -> Types.notification_configuration
val make_dimension_mapping : dimension_value_type:Types.dimension_value_type -> name:Types.schema_name -> unit -> Types.dimension_mapping
val make_multi_measure_attribute_mapping : ?target_multi_measure_attribute_name:Types.schema_name -> measure_value_type:Types.scalar_measure_value_type -> 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_timestream_configuration : ?measure_name_column:Types.schema_name -> ?mixed_measure_mappings:Types.mixed_measure_mapping_list -> ?multi_measure_mappings:Types.multi_measure_mappings -> dimension_mappings:Types.dimension_mapping_list -> time_column:Types.schema_name -> table_name:Types.resource_name -> database_name:Types.resource_name -> unit -> Types.timestream_configuration
val make_target_configuration : timestream_configuration:Types.timestream_configuration -> unit -> Types.target_configuration
val make_execution_stats : ?query_result_rows:Types.long -> ?records_ingested:Types.long -> ?cumulative_bytes_scanned:Types.long -> ?bytes_metered:Types.long -> ?data_writes:Types.long -> ?execution_time_in_millis:Types.long -> unit -> Types.execution_stats
val make_scheduled_query_insights_response : ?output_bytes:Types.long -> ?output_rows:Types.long -> ?query_table_count:Types.long -> ?query_temporal_range:Types.query_temporal_range -> ?query_spatial_coverage:Types.query_spatial_coverage -> unit -> Types.scheduled_query_insights_response
val make_s3_report_location : ?object_key:Types.s3_object_key -> ?bucket_name:Types.s3_bucket_name -> unit -> Types.s3_report_location
val make_error_report_location : ?s3_report_location:Types.s3_report_location -> unit -> Types.error_report_location
val make_scheduled_query_run_summary : ?failure_reason:Types.error_message -> ?error_report_location:Types.error_report_location -> ?query_insights_response:Types.scheduled_query_insights_response -> ?execution_stats:Types.execution_stats -> ?run_status:Types.scheduled_query_run_status -> ?trigger_time:Types.time -> ?invocation_time:Types.time -> unit -> Types.scheduled_query_run_summary
val make_scheduled_query_description : ?recently_failed_runs:Types.scheduled_query_run_summary_list -> ?last_run_summary:Types.scheduled_query_run_summary -> ?error_report_configuration:Types.error_report_configuration -> ?kms_key_id:Types.string_value2048 -> ?scheduled_query_execution_role_arn:Types.amazon_resource_name -> ?target_configuration:Types.target_configuration -> ?next_invocation_time:Types.time -> ?previous_invocation_time:Types.time -> ?creation_time:Types.time -> notification_configuration:Types.notification_configuration -> schedule_configuration:Types.schedule_configuration -> state:Types.scheduled_query_state -> query_string:Types.query_string -> name:Types.scheduled_query_name -> arn:Types.amazon_resource_name -> unit -> Types.scheduled_query_description
val make_describe_scheduled_query_response : scheduled_query:Types.scheduled_query_description -> unit -> Types.describe_scheduled_query_response
val make_describe_scheduled_query_request : scheduled_query_arn:Types.amazon_resource_name -> unit -> Types.describe_scheduled_query_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_account_settings_response : ?query_compute:Types.query_compute_response -> ?query_pricing_model:Types.query_pricing_model -> ?max_query_tc_u:Types.max_query_capacity -> unit -> Types.describe_account_settings_response
val make_describe_account_settings_request : unit -> unit
val make_delete_scheduled_query_request : scheduled_query_arn:Types.amazon_resource_name -> unit -> Types.delete_scheduled_query_request
val make_create_scheduled_query_response : arn:Types.amazon_resource_name -> unit -> Types.create_scheduled_query_response
val make_create_scheduled_query_request : ?kms_key_id:Types.string_value2048 -> ?tags:Types.tag_list -> ?client_token:Types.client_token -> ?target_configuration:Types.target_configuration -> error_report_configuration:Types.error_report_configuration -> scheduled_query_execution_role_arn:Types.amazon_resource_name -> notification_configuration:Types.notification_configuration -> schedule_configuration:Types.schedule_configuration -> query_string:Types.query_string -> name:Types.scheduled_query_name -> unit -> Types.create_scheduled_query_request
val make_cancel_query_response : ?cancellation_message:Types.string_ -> unit -> Types.cancel_query_response
val make_cancel_query_request : query_id:Types.query_id -> unit -> Types.cancel_query_request

Operations

module CancelQuery : sig ... end

Cancels a query that has been issued. Cancellation is provided only if the query has not completed running before the cancellation request was issued. Because cancellation is an idempotent operation, subsequent cancellation requests will return a CancellationMessage, indicating that the query has already been canceled. See code sample for details.

module CreateScheduledQuery : sig ... end

Create a scheduled query that will be run on your behalf at the configured schedule. Timestream assumes the execution role provided as part of the ScheduledQueryExecutionRoleArn parameter to run the query. You can use the NotificationConfiguration parameter to configure notification for your scheduled query operations.

module DeleteScheduledQuery : sig ... end

Deletes a given scheduled query. This is an irreversible operation.

module DescribeAccountSettings : sig ... end

Describes the settings for your account that include the query pricing model and the configured maximum TCUs the service can use for your query workload.

module DescribeEndpoints : sig ... end

DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.

module DescribeScheduledQuery : sig ... end

Provides detailed information about a scheduled query.

module ExecuteScheduledQuery : sig ... end

You can use this API to run a scheduled query manually.

module ListScheduledQueries : sig ... end

Gets a list of all scheduled queries in the caller's Amazon account and Region. ListScheduledQueries is eventually consistent.

module ListTagsForResource : sig ... end

List all tags on a Timestream query resource.

module PrepareQuery : sig ... end

A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later running. Timestream only supports using this operation with ValidateOnly set to true.

module Query : sig ... end

Query is a synchronous operation that enables you to run a query against your Amazon Timestream data.

module TagResource : sig ... end

Associate 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 query resource.

module UpdateAccountSettings : sig ... end

Transitions your account to use TCUs for query pricing and modifies the maximum query compute units that you've configured. If you reduce the value of MaxQueryTCU to a desired configuration, the new value can take up to 24 hours to be effective.

module UpdateScheduledQuery : sig ... end
module Json_serializers : sig ... end
module Json_deserializers : sig ... end