Module Smaws_Client_TimestreamQuery.Types

type nonrec error_message = string
type nonrec validation_exception = {
  1. message : error_message option;
}

Invalid or malformed request.

type nonrec amazon_resource_name = string
type nonrec scheduled_query_state =
  1. | DISABLED
  2. | ENABLED
type nonrec update_scheduled_query_request = {
  1. state : scheduled_query_state;
    (*

    State of the scheduled query.

    *)
  2. scheduled_query_arn : amazon_resource_name;
    (*

    ARN of the scheuled query.

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

The request was throttled due to excessive requests.

type nonrec resource_not_found_exception = {
  1. scheduled_query_arn : amazon_resource_name option;
    (*

    The ARN of the scheduled query.

    *)
  2. message : error_message option;
}

The requested resource could not be found.

type nonrec invalid_endpoint_exception = {
  1. message : error_message option;
}

The requested endpoint is invalid.

type nonrec internal_server_exception = {
  1. message : error_message option;
}

An internal server error occurred while processing the request.

type nonrec service_error_message = string
type nonrec access_denied_exception = {
  1. message : service_error_message option;
}

You do not have the necessary permissions to access the account settings.

type nonrec max_query_capacity = int
type nonrec query_pricing_model =
  1. | COMPUTE_UNITS
  2. | BYTES_SCANNED
type nonrec compute_mode =
  1. | PROVISIONED
  2. | ON_DEMAND
type nonrec query_tc_u = int
type nonrec sns_configuration = {
  1. topic_arn : amazon_resource_name;
    (*

    SNS topic ARN that the scheduled query status notifications will be sent to.

    *)
}

Details on SNS that are required to send the notification.

type nonrec account_settings_notification_configuration = {
  1. role_arn : amazon_resource_name;
    (*

    An Amazon Resource Name (ARN) that grants Timestream permission to publish notifications. This field is only visible if SNS Topic is provided when updating the account settings.

    *)
  2. sns_configuration : sns_configuration option;
}

Configuration settings for notifications related to account settings.

type nonrec last_update_status =
  1. | SUCCEEDED
  2. | FAILED
  3. | PENDING
type nonrec string_ = string
type nonrec last_update = {
  1. status_message : string_ option;
    (*

    Error message describing the last account settings update status, visible only if an error occurred.

    *)
  2. status : last_update_status option;
    (*

    The status of the last update. Can be either PENDING, FAILED, or SUCCEEDED.

    *)
  3. target_query_tc_u : query_tc_u option;
    (*

    The number of TimeStream Compute Units (TCUs) requested in the last account settings update.

    *)
}

Configuration object that contains the most recent account settings update, visible only if settings have been updated previously.

type nonrec provisioned_capacity_response = {
  1. last_update : last_update option;
    (*

    Information about the last update to the provisioned capacity settings.

    *)
  2. notification_configuration : account_settings_notification_configuration option;
    (*

    An object that contains settings for notifications that are sent whenever the provisioned capacity settings are modified. This field is only visible when the compute mode is PROVISIONED.

    *)
  3. active_query_tc_u : query_tc_u option;
    (*

    The number of Timestream Compute Units (TCUs) provisioned in the account. This field is only visible when the compute mode is PROVISIONED.

    *)
}

The response to a request to update the provisioned capacity settings for querying data.

type nonrec query_compute_response = {
  1. provisioned_capacity : provisioned_capacity_response option;
    (*

    Configuration object that contains settings for provisioned Timestream Compute Units (TCUs) in your account.

    *)
  2. compute_mode : compute_mode option;
    (*

    The mode in which Timestream Compute Units (TCUs) are allocated and utilized within an account. Note that in the Asia Pacific (Mumbai) region, the API operation only recognizes the value PROVISIONED.

    *)
}

The response to a request to retrieve or update the compute capacity settings for querying data.

type nonrec update_account_settings_response = {
  1. query_compute : query_compute_response option;
    (*

    Confirms the updated account settings for querying data in your account.

    *)
  2. query_pricing_model : query_pricing_model option;
    (*

    The pricing model for an account.

    *)
  3. max_query_tc_u : max_query_capacity option;
    (*

    The configured maximum number of compute units the service will use at any point in time to serve your queries.

    *)
}
type nonrec provisioned_capacity_request = {
  1. notification_configuration : account_settings_notification_configuration option;
    (*

    Configuration settings for notifications related to the provisioned capacity update.

    *)
  2. target_query_tc_u : query_tc_u;
    (*

    The target compute capacity for querying data, specified in Timestream Compute Units (TCUs).

    *)
}

A request to update the provisioned capacity settings for querying data.

type nonrec query_compute_request = {
  1. provisioned_capacity : provisioned_capacity_request option;
    (*

    Configuration object that contains settings for provisioned Timestream Compute Units (TCUs) in your account.

    *)
  2. compute_mode : compute_mode option;
    (*

    The mode in which Timestream Compute Units (TCUs) are allocated and utilized within an account. Note that in the Asia Pacific (Mumbai) region, the API operation only recognizes the value PROVISIONED.

    *)
}

A request to retrieve or update the compute capacity settings for querying data.

type nonrec update_account_settings_request = {
  1. query_compute : query_compute_request option;
    (*

    Modifies the query compute settings configured in your account, including the query pricing model and provisioned Timestream Compute Units (TCUs) in your account.

    This API is idempotent, meaning that making the same request multiple times will have the same effect as making the request once.

    *)
  2. query_pricing_model : query_pricing_model option;
    (*

    The pricing model for queries in an account.

    The QueryPricingModel parameter is used by several Timestream operations; however, the UpdateAccountSettings API operation doesn't recognize any values other than COMPUTE_UNITS.

    *)
  3. max_query_tc_u : max_query_capacity option;
    (*

    The maximum number of compute units the service will use at any point in time to serve your queries. To run queries, you must set a minimum capacity of 4 TCU. You can set the maximum number of TCU in multiples of 4, for example, 4, 8, 16, 32, and so on. The maximum value supported for MaxQueryTCU is 1000. To request an increase to this soft limit, contact Amazon Web Services Support. For information about the default quota for maxQueryTCU, see Default quotas. This configuration is applicable only for on-demand usage of Timestream Compute Units (TCUs).

    The maximum value supported for MaxQueryTCU is 1000. To request an increase to this soft limit, contact Amazon Web Services Support. For information about the default quota for maxQueryTCU, see Default quotas.

    *)
}
type nonrec untag_resource_response = unit
type nonrec tag_key = string
type nonrec tag_key_list = tag_key list
type nonrec untag_resource_request = {
  1. tag_keys : tag_key_list;
    (*

    A list of tags keys. Existing tags of the resource whose keys are members of this list will be removed from the Timestream resource.

    *)
  2. resource_ar_n : amazon_resource_name;
    (*

    The Timestream resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).

    *)
}
type nonrec scalar_type =
  1. | INTEGER
  2. | UNKNOWN
  3. | INTERVAL_YEAR_TO_MONTH
  4. | INTERVAL_DAY_TO_SECOND
  5. | TIME
  6. | DATE
  7. | TIMESTAMP
  8. | DOUBLE
  9. | BIGINT
  10. | BOOLEAN
  11. | VARCHAR
type column_info = {
  1. type_ : type_;
    (*

    The data type of the result set column. The data type can be a scalar or complex. Scalar data types are integers, strings, doubles, Booleans, and others. Complex data types are types such as arrays, rows, and others.

    *)
  2. name : string_ option;
    (*

    The name of the result set column. The name of the result set is available for columns of all data types except for arrays.

    *)
}

Contains the metadata for query results such as the column names, data types, and other attributes.

and column_info_list = column_info list
and type_ = {
  1. row_column_info : column_info_list option;
    (*

    Indicates if the column is a row.

    *)
  2. time_series_measure_value_column_info : column_info option;
    (*

    Indicates if the column is a timeseries data type.

    *)
  3. array_column_info : column_info option;
    (*

    Indicates if the column is an array.

    *)
  4. scalar_type : scalar_type option;
    (*

    Indicates if the column is of type string, integer, Boolean, double, timestamp, date, time. For more information, see Supported data types.

    *)
}

Contains the data type of a column in a query result set. The data type can be scalar or complex. The supported scalar data types are integers, Boolean, string, double, timestamp, date, time, and intervals. The supported complex data types are arrays, rows, and timeseries.

type nonrec service_quota_exceeded_exception = {
  1. message : error_message option;
}

You have exceeded the service quota.

type nonrec tag_resource_response = unit
type nonrec tag_value = string
type nonrec tag = {
  1. value : tag_value;
    (*

    The value of the tag. Tag values are case sensitive and can be null.

    *)
  2. key : tag_key;
    (*

    The key of the tag. Tag keys are case sensitive.

    *)
}

A tag is a label that you assign to a Timestream database and/or table. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize databases and/or tables, for example, by purpose, owner, or environment.

type nonrec tag_list = tag list
type nonrec tag_resource_request = {
  1. tags : tag_list;
    (*

    The tags to be assigned to the Timestream resource.

    *)
  2. resource_ar_n : amazon_resource_name;
    (*

    Identifies the Timestream resource to which tags should be added. This value is an Amazon Resource Name (ARN).

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

Timestream was unable to run the query successfully.

type nonrec conflict_exception = {
  1. message : error_message option;
}

Unable to poll results for a cancelled query.

type nonrec query_id = string
type nonrec pagination_token = string
type nonrec scalar_value = string
type nonrec timestamp = string
type nonrec nullable_boolean = bool
type datum = {
  1. null_value : nullable_boolean option;
    (*

    Indicates if the data point is null.

    *)
  2. row_value : row option;
    (*

    Indicates if the data point is a row.

    *)
  3. array_value : datum_list option;
    (*

    Indicates if the data point is an array.

    *)
  4. time_series_value : time_series_data_point_list option;
    (*

    Indicates if the data point is a timeseries data type.

    *)
  5. scalar_value : scalar_value option;
    (*

    Indicates if the data point is a scalar value such as integer, string, double, or Boolean.

    *)
}

Datum represents a single data point in a query result.

and datum_list = datum list
and row = {
  1. data : datum_list;
    (*

    List of data points in a single row of the result set.

    *)
}

Represents a single row in the query results.

and time_series_data_point = {
  1. value : datum;
    (*

    The measure value for the data point.

    *)
  2. time : timestamp;
    (*

    The timestamp when the measure value was collected.

    *)
}

The timeseries data type represents the values of a measure over time. A time series is an array of rows of timestamps and measure values, with rows sorted in ascending order of time. A TimeSeriesDataPoint is a single data point in the time series. It represents a tuple of (time, measure value) in a time series.

and time_series_data_point_list = time_series_data_point list
type nonrec row_list = row list
type nonrec double = float
type nonrec long = Smaws_Lib.CoreTypes.Int64.t
type nonrec query_status = {
  1. cumulative_bytes_metered : long option;
    (*

    The amount of data scanned by the query in bytes that you will be charged for. This is a cumulative sum and represents the total amount of data that you will be charged for since the query was started. The charge is applied only once and is either applied when the query completes running or when the query is cancelled.

    *)
  2. cumulative_bytes_scanned : long option;
    (*

    The amount of data scanned by the query in bytes. This is a cumulative sum and represents the total amount of bytes scanned since the query was started.

    *)
  3. progress_percentage : double option;
    (*

    The progress of the query, expressed as a percentage.

    *)
}

Information about the status of the query, including progress and bytes scanned.

type nonrec partition_key = string
type nonrec partition_key_list = partition_key list
type nonrec query_spatial_coverage_max = {
  1. partition_key : partition_key_list option;
    (*

    The partition key used for partitioning, which can be a default measure_name or a customer defined partition key.

    *)
  2. table_arn : amazon_resource_name option;
    (*

    The Amazon Resource Name (ARN) of the table with the most sub-optimal spatial pruning.

    *)
  3. value : double option;
    (*

    The maximum ratio of spatial coverage.

    *)
}

Provides insights into the table with the most sub-optimal spatial range scanned by your query.

type nonrec query_spatial_coverage = {
  1. max : query_spatial_coverage_max option;
    (*

    Provides insights into the spatial coverage of the executed query and the table with the most inefficient spatial pruning.

    • Value – The maximum ratio of spatial coverage.
    • TableArn – The Amazon Resource Name (ARN) of the table with sub-optimal spatial pruning.
    • PartitionKey – The partition key used for partitioning, which can be a default measure_name or a CDPK.
    *)
}

Provides insights into the spatial coverage of the query, including the table with sub-optimal (max) spatial pruning. This information can help you identify areas for improvement in your partitioning strategy to enhance spatial pruning

For example, you can do the following with the QuerySpatialCoverage information:

  • Add measure_name or use customer-defined partition key (CDPK) predicates.
  • If you've already done the preceding action, remove functions around them or clauses, such as LIKE.
type nonrec query_temporal_range_max = {
  1. table_arn : amazon_resource_name option;
    (*

    The Amazon Resource Name (ARN) of the table which is queried with the largest time range.

    *)
  2. value : long option;
    (*

    The maximum duration in nanoseconds between the start and end of the query.

    *)
}

Provides insights into the table with the most sub-optimal temporal pruning scanned by your query.

type nonrec query_temporal_range = {
  1. max : query_temporal_range_max option;
    (*

    Encapsulates the following properties that provide insights into the most sub-optimal performing table on the temporal axis:

    • Value – The maximum duration in nanoseconds between the start and end of the query.
    • TableArn – The Amazon Resource Name (ARN) of the table which is queried with the largest time range.
    *)
}

Provides insights into the temporal range of the query, including the table with the largest (max) time range.

type nonrec query_insights_response = {
  1. unload_written_bytes : long option;
    (*

    Indicates the size, in bytes, written by the Unload operation.

    *)
  2. unload_written_rows : long option;
    (*

    Indicates the rows written by the Unload query.

    *)
  3. unload_partition_count : long option;
    (*

    Indicates the partitions created by the Unload operation.

    *)
  4. output_bytes : long option;
    (*

    Indicates the size of query result set in bytes. You can use this data to validate if the result set has changed as part of the query tuning exercise.

    *)
  5. output_rows : long option;
    (*

    Indicates the total number of rows returned as part of the query result set. You can use this data to validate if the number of rows in the result set have changed as part of the query tuning exercise.

    *)
  6. query_table_count : long option;
    (*

    Indicates the number of tables in the query.

    *)
  7. query_temporal_range : query_temporal_range option;
    (*

    Provides insights into the temporal range of the query, including the table with the largest (max) time range. Following are some of the potential options for optimizing time-based pruning:

    • Add missing time-predicates.
    • Remove functions around the time predicates.
    • Add time predicates to all the sub-queries.
    *)
  8. query_spatial_coverage : query_spatial_coverage option;
    (*

    Provides insights into the spatial coverage of the query, including the table with sub-optimal (max) spatial pruning. This information can help you identify areas for improvement in your partitioning strategy to enhance spatial pruning.

    *)
}

Provides various insights and metrics related to the query that you executed.

type nonrec query_response = {
  1. query_insights_response : query_insights_response option;
    (*

    Encapsulates QueryInsights containing insights and metrics related to the query that you executed.

    *)
  2. query_status : query_status option;
    (*

    Information about the status of the query, including progress and bytes scanned.

    *)
  3. column_info : column_info_list;
    (*

    The column data types of the returned result set.

    *)
  4. rows : row_list;
    (*

    The result set rows returned by the query.

    *)
  5. next_token : pagination_token option;
    (*

    A pagination token that can be used again on a Query call to get the next set of results.

    *)
  6. query_id : query_id;
    (*

    A unique ID for the given query.

    *)
}
type nonrec query_string = string
type nonrec client_request_token = string
type nonrec max_query_results = int
type nonrec query_insights_mode =
  1. | DISABLED
  2. | ENABLED_WITH_RATE_CONTROL
type nonrec query_insights = {
  1. mode : query_insights_mode;
    (*

    Provides the following modes to enable QueryInsights:

    • ENABLED_WITH_RATE_CONTROL – Enables QueryInsights for the queries being processed. This mode also includes a rate control mechanism, which limits the QueryInsights feature to 1 query per second (QPS).
    • DISABLED – Disables QueryInsights.
    *)
}

QueryInsights is a performance tuning feature that helps you optimize your queries, reducing costs and improving performance. With QueryInsights, you can assess the pruning efficiency of your queries and identify areas for improvement to enhance query performance. With QueryInsights, you can also analyze the effectiveness of your queries in terms of temporal and spatial pruning, and identify opportunities to improve performance. Specifically, you can evaluate how well your queries use time-based and partition key-based indexing strategies to optimize data retrieval. To optimize query performance, it's essential that you fine-tune both the temporal and spatial parameters that govern query execution.

The key metrics provided by QueryInsights are QuerySpatialCoverage and QueryTemporalRange. QuerySpatialCoverage indicates how much of the spatial axis the query scans, with lower values being more efficient. QueryTemporalRange shows the time range scanned, with narrower ranges being more performant.

Benefits of QueryInsights

The following are the key benefits of using QueryInsights:

  • Identifying inefficient queries – QueryInsights provides information on the time-based and attribute-based pruning of the tables accessed by the query. This information helps you identify the tables that are sub-optimally accessed.
  • Optimizing your data model and partitioning – You can use the QueryInsights information to access and fine-tune your data model and partitioning strategy.
  • Tuning queries – QueryInsights highlights opportunities to use indexes more effectively.

The maximum number of Query API requests you're allowed to make with QueryInsights enabled is 1 query per second (QPS). If you exceed this query rate, it might result in throttling.

type nonrec query_request = {
  1. query_insights : query_insights option;
    (*

    Encapsulates settings for enabling QueryInsights.

    Enabling QueryInsights returns insights and metrics in addition to query results for the query that you executed. You can use QueryInsights to tune your query performance.

    *)
  2. max_rows : max_query_results option;
    (*

    The total number of rows to be returned in the Query output. The initial run of Query with a MaxRows value specified will return the result set of the query in two cases:

    • The size of the result is less than 1MB.
    • The number of rows in the result set is less than the value of maxRows.

    Otherwise, the initial invocation of Query only returns a NextToken, which can then be used in subsequent calls to fetch the result set. To resume pagination, provide the NextToken value in the subsequent command.

    If the row size is large (e.g. a row has many columns), Timestream may return fewer rows to keep the response size from exceeding the 1 MB limit. If MaxRows is not provided, Timestream will send the necessary number of rows to meet the 1 MB limit.

    *)
  3. next_token : pagination_token option;
    (*

    A pagination token used to return a set of results. When the Query API is invoked using NextToken, that particular invocation is assumed to be a subsequent invocation of a prior call to Query, and a result set is returned. However, if the Query invocation only contains the ClientToken, that invocation of Query is assumed to be a new query run.

    Note the following when using NextToken in a query:

    • A pagination token can be used for up to five Query invocations, OR for a duration of up to 1 hour – whichever comes first.
    • Using the same NextToken will return the same set of records. To keep paginating through the result set, you must to use the most recent nextToken.
    • Suppose a Query invocation returns two NextToken values, TokenA and TokenB. If TokenB is used in a subsequent Query invocation, then TokenA is invalidated and cannot be reused.
    • To request a previous result set from a query after pagination has begun, you must re-invoke the Query API.
    • The latest NextToken should be used to paginate until null is returned, at which point a new NextToken should be used.
    • If the IAM principal of the query initiator and the result reader are not the same and/or the query initiator and the result reader do not have the same query string in the query requests, the query will fail with an Invalid pagination token error.
    *)
  4. client_token : client_request_token option;
    (*

    Unique, case-sensitive string of up to 64 ASCII characters specified when a Query request is made. Providing a ClientToken makes the call to Query idempotent. This means that running the same query repeatedly will produce the same result. In other words, making multiple identical Query requests has the same effect as making a single request. When using ClientToken in a query, note the following:

    • If the Query API is instantiated without a ClientToken, the Query SDK generates a ClientToken on your behalf.
    • If the Query invocation only contains the ClientToken but does not include a NextToken, that invocation of Query is assumed to be a new query run.
    • If the invocation contains NextToken, that particular invocation is assumed to be a subsequent invocation of a prior call to the Query API, and a result set is returned.
    • After 4 hours, any request with the same ClientToken is treated as a new request.
    *)
  5. query_string : query_string;
    (*

    The query to be run by Timestream.

    *)
}
type nonrec resource_name = string
type nonrec select_column = {
  1. aliased : nullable_boolean option;
    (*

    True, if the column name was aliased by the query. False otherwise.

    *)
  2. table_name : resource_name option;
    (*

    Table within the database that has this column.

    *)
  3. database_name : resource_name option;
    (*

    Database that has this column.

    *)
  4. type_ : type_ option;
  5. name : string_ option;
    (*

    Name of the column.

    *)
}

Details of the column that is returned by the query.

type nonrec select_column_list = select_column list
type nonrec parameter_mapping = {
  1. type_ : type_;
  2. name : string_;
    (*

    Parameter name.

    *)
}

Mapping for named parameters.

type nonrec parameter_mapping_list = parameter_mapping list
type nonrec prepare_query_response = {
  1. parameters : parameter_mapping_list;
    (*

    A list of parameters used in the submitted query string.

    *)
  2. columns : select_column_list;
    (*

    A list of SELECT clause columns of the submitted query string.

    *)
  3. query_string : query_string;
    (*

    The query string that you want prepare.

    *)
}
type nonrec prepare_query_request = {
  1. validate_only : nullable_boolean option;
    (*

    By setting this value to true, Timestream will only validate that the query string is a valid Timestream query, and not store the prepared query for later use.

    *)
  2. query_string : query_string;
    (*

    The Timestream query string that you want to use as a prepared statement. Parameter names can be specified in the query string @ character followed by an identifier.

    *)
}
type nonrec next_tags_for_resource_results_token = string
type nonrec list_tags_for_resource_response = {
  1. next_token : next_tags_for_resource_results_token option;
    (*

    A pagination token to resume pagination with a subsequent call to ListTagsForResourceResponse.

    *)
  2. tags : tag_list;
    (*

    The tags currently associated with the Timestream resource.

    *)
}
type nonrec max_tags_for_resource_result = int
type nonrec list_tags_for_resource_request = {
  1. next_token : next_tags_for_resource_results_token option;
    (*

    A pagination token to resume pagination.

    *)
  2. max_results : max_tags_for_resource_result option;
    (*

    The maximum number of tags to return.

    *)
  3. resource_ar_n : amazon_resource_name;
    (*

    The Timestream resource with tags to be listed. This value is an Amazon Resource Name (ARN).

    *)
}
type nonrec scheduled_query_name = string
type nonrec time = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec s3_bucket_name = string
type nonrec s3_object_key_prefix = string
type nonrec s3_encryption_option =
  1. | SSE_KMS
  2. | SSE_S3
type nonrec s3_configuration = {
  1. encryption_option : s3_encryption_option option;
    (*

    Encryption at rest options for the error reports. If no encryption option is specified, Timestream will choose SSE_S3 as default.

    *)
  2. object_key_prefix : s3_object_key_prefix option;
    (*

    Prefix for the error report key. Timestream by default adds the following prefix to the error report path.

    *)
  3. bucket_name : s3_bucket_name;
    (*

    Name of the S3 bucket under which error reports will be created.

    *)
}

Details on S3 location for error reports that result from running a query.

type nonrec error_report_configuration = {
  1. s3_configuration : s3_configuration;
    (*

    The S3 configuration for the error reports.

    *)
}

Configuration required for error reporting.

type nonrec timestream_destination = {
  1. table_name : resource_name option;
    (*

    Timestream table name.

    *)
  2. database_name : resource_name option;
    (*

    Timestream database name.

    *)
}

Destination for scheduled query.

type nonrec target_destination = {
  1. timestream_destination : timestream_destination option;
    (*

    Query result destination details for Timestream data source.

    *)
}

Destination details to write data for a target data source. Current supported data source is Timestream.

type nonrec scheduled_query_run_status =
  1. | MANUAL_TRIGGER_FAILURE
  2. | MANUAL_TRIGGER_SUCCESS
  3. | AUTO_TRIGGER_FAILURE
  4. | AUTO_TRIGGER_SUCCESS
type nonrec scheduled_query = {
  1. last_run_status : scheduled_query_run_status option;
    (*

    Status of the last scheduled query run.

    *)
  2. target_destination : target_destination option;
    (*

    Target data source where final scheduled query result will be written.

    *)
  3. error_report_configuration : error_report_configuration option;
    (*

    Configuration for scheduled query error reporting.

    *)
  4. next_invocation_time : time option;
    (*

    The next time the scheduled query is to be run.

    *)
  5. previous_invocation_time : time option;
    (*

    The last time the scheduled query was run.

    *)
  6. state : scheduled_query_state;
    (*

    State of scheduled query.

    *)
  7. creation_time : time option;
    (*

    The creation time of the scheduled query.

    *)
  8. name : scheduled_query_name;
    (*

    The name of the scheduled query.

    *)
  9. arn : amazon_resource_name;
    (*

    The Amazon Resource Name.

    *)
}

Scheduled Query

type nonrec scheduled_query_list = scheduled_query list
type nonrec next_scheduled_queries_results_token = string
type nonrec list_scheduled_queries_response = {
  1. next_token : next_scheduled_queries_results_token option;
    (*

    A token to specify where to start paginating. This is the NextToken from a previously truncated response.

    *)
  2. scheduled_queries : scheduled_query_list;
    (*

    A list of scheduled queries.

    *)
}
type nonrec max_scheduled_queries_results = int
type nonrec list_scheduled_queries_request = {
  1. next_token : next_scheduled_queries_results_token option;
    (*

    A pagination token to resume pagination.

    *)
  2. max_results : max_scheduled_queries_results option;
    (*

    The maximum number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as the argument to the subsequent call to ListScheduledQueriesRequest.

    *)
}
type nonrec client_token = string
type nonrec scheduled_query_insights_mode =
  1. | DISABLED
  2. | ENABLED_WITH_RATE_CONTROL
type nonrec scheduled_query_insights = {
  1. mode : scheduled_query_insights_mode;
    (*

    Provides the following modes to enable ScheduledQueryInsights:

    • ENABLED_WITH_RATE_CONTROL – Enables ScheduledQueryInsights for the queries being processed. This mode also includes a rate control mechanism, which limits the QueryInsights feature to 1 query per second (QPS).
    • DISABLED – Disables ScheduledQueryInsights.
    *)
}

Encapsulates settings for enabling QueryInsights on an ExecuteScheduledQueryRequest.

type nonrec execute_scheduled_query_request = {
  1. query_insights : scheduled_query_insights option;
    (*

    Encapsulates settings for enabling QueryInsights.

    Enabling QueryInsights returns insights and metrics as a part of the Amazon SNS notification for the query that you executed. You can use QueryInsights to tune your query performance and cost.

    *)
  2. client_token : client_token option;
    (*

    Not used.

    *)
  3. invocation_time : time;
    (*

    The timestamp in UTC. Query will be run as if it was invoked at this timestamp.

    *)
  4. scheduled_query_arn : amazon_resource_name;
    (*

    ARN of the scheduled query.

    *)
}
type nonrec schedule_expression = string
type nonrec schedule_configuration = {
  1. schedule_expression : schedule_expression;
    (*

    An expression that denotes when to trigger the scheduled query run. This can be a cron expression or a rate expression.

    *)
}

Configuration of the schedule of the query.

type nonrec notification_configuration = {
  1. sns_configuration : sns_configuration;
    (*

    Details about the Amazon Simple Notification Service (SNS) configuration. This field is visible only when SNS Topic is provided when updating the account settings.

    *)
}

Notification configuration for a scheduled query. A notification is sent by Timestream when a scheduled query is created, its state is updated or when it is deleted.

type nonrec schema_name = string
type nonrec dimension_value_type =
  1. | VARCHAR
type nonrec dimension_mapping = {
  1. dimension_value_type : dimension_value_type;
    (*

    Type for the dimension.

    *)
  2. name : schema_name;
    (*

    Column name from query result.

    *)
}

This type is used to map column(s) from the query result to a dimension in the destination table.

type nonrec dimension_mapping_list = dimension_mapping list
type nonrec scalar_measure_value_type =
  1. | TIMESTAMP
  2. | VARCHAR
  3. | DOUBLE
  4. | BOOLEAN
  5. | BIGINT
type nonrec multi_measure_attribute_mapping = {
  1. measure_value_type : scalar_measure_value_type;
    (*

    Type of the attribute to be read from the source column.

    *)
  2. target_multi_measure_attribute_name : schema_name option;
    (*

    Custom name to be used for attribute name in derived table. If not provided, source column name would be used.

    *)
  3. source_column : schema_name;
    (*

    Source column from where the attribute value is to be read.

    *)
}

Attribute mapping for MULTI value measures.

type nonrec multi_measure_attribute_mapping_list = multi_measure_attribute_mapping list
type nonrec multi_measure_mappings = {
  1. multi_measure_attribute_mappings : multi_measure_attribute_mapping_list;
    (*

    Required. Attribute mappings to be used for mapping query results to ingest data for multi-measure attributes.

    *)
  2. target_multi_measure_name : schema_name option;
    (*

    The name of the target multi-measure name in the derived table. This input is required when measureNameColumn is not provided. If MeasureNameColumn is provided, then value from that column will be used as multi-measure name.

    *)
}

Only one of MixedMeasureMappings or MultiMeasureMappings is to be provided. MultiMeasureMappings can be used to ingest data as multi measures in the derived table.

type nonrec measure_value_type =
  1. | MULTI
  2. | VARCHAR
  3. | DOUBLE
  4. | BOOLEAN
  5. | BIGINT
type nonrec mixed_measure_mapping = {
  1. multi_measure_attribute_mappings : multi_measure_attribute_mapping_list option;
    (*

    Required when measureValueType is MULTI. Attribute mappings for MULTI value measures.

    *)
  2. measure_value_type : measure_value_type;
    (*

    Type of the value that is to be read from sourceColumn. If the mapping is for MULTI, use MeasureValueType.MULTI.

    *)
  3. target_measure_name : schema_name option;
    (*

    Target measure name to be used. If not provided, the target measure name by default would be measure-name if provided, or sourceColumn otherwise.

    *)
  4. source_column : schema_name option;
    (*

    This field refers to the source column from which measure-value is to be read for result materialization.

    *)
  5. measure_name : schema_name option;
    (*

    Refers to the value of measure_name in a result row. This field is required if MeasureNameColumn is provided.

    *)
}

MixedMeasureMappings are mappings that can be used to ingest data into a mixture of narrow and multi measures in the derived table.

type nonrec mixed_measure_mapping_list = mixed_measure_mapping list
type nonrec timestream_configuration = {
  1. measure_name_column : schema_name option;
    (*

    Name of the measure column.

    *)
  2. mixed_measure_mappings : mixed_measure_mapping_list option;
    (*

    Specifies how to map measures to multi-measure records.

    *)
  3. multi_measure_mappings : multi_measure_mappings option;
    (*

    Multi-measure mappings.

    *)
  4. dimension_mappings : dimension_mapping_list;
    (*

    This is to allow mapping column(s) from the query result to the dimension in the destination table.

    *)
  5. time_column : schema_name;
    (*

    Column from query result that should be used as the time column in destination table. Column type for this should be TIMESTAMP.

    *)
  6. table_name : resource_name;
    (*

    Name of Timestream table that the query result will be written to. The table should be within the same database that is provided in Timestream configuration.

    *)
  7. database_name : resource_name;
    (*

    Name of Timestream database to which the query result will be written.

    *)
}

Configuration to write data into Timestream database and table. This configuration allows the user to map the query result select columns into the destination table columns.

type nonrec target_configuration = {
  1. timestream_configuration : timestream_configuration;
    (*

    Configuration needed to write data into the Timestream database and table.

    *)
}

Configuration used for writing the output of a query.

type nonrec string_value2048 = string
type nonrec execution_stats = {
  1. query_result_rows : long option;
    (*

    Number of rows present in the output from running a query before ingestion to destination data source.

    *)
  2. records_ingested : long option;
    (*

    The number of records ingested for a single scheduled query run.

    *)
  3. cumulative_bytes_scanned : long option;
    (*

    Bytes scanned for a single scheduled query run.

    *)
  4. bytes_metered : long option;
    (*

    Bytes metered for a single scheduled query run.

    *)
  5. data_writes : long option;
    (*

    Data writes metered for records ingested in a single scheduled query run.

    *)
  6. execution_time_in_millis : long option;
    (*

    Total time, measured in milliseconds, that was needed for the scheduled query run to complete.

    *)
}

Statistics for a single scheduled query run.

type nonrec scheduled_query_insights_response = {
  1. output_bytes : long option;
    (*

    Indicates the size of query result set in bytes. You can use this data to validate if the result set has changed as part of the query tuning exercise.

    *)
  2. output_rows : long option;
    (*

    Indicates the total number of rows returned as part of the query result set. You can use this data to validate if the number of rows in the result set have changed as part of the query tuning exercise.

    *)
  3. query_table_count : long option;
    (*

    Indicates the number of tables in the query.

    *)
  4. query_temporal_range : query_temporal_range option;
    (*

    Provides insights into the temporal range of the query, including the table with the largest (max) time range. Following are some of the potential options for optimizing time-based pruning:

    • Add missing time-predicates.
    • Remove functions around the time predicates.
    • Add time predicates to all the sub-queries.
    *)
  5. query_spatial_coverage : query_spatial_coverage option;
    (*

    Provides insights into the spatial coverage of the query, including the table with sub-optimal (max) spatial pruning. This information can help you identify areas for improvement in your partitioning strategy to enhance spatial pruning.

    *)
}

Provides various insights and metrics related to the ExecuteScheduledQueryRequest that was executed.

type nonrec s3_object_key = string
type nonrec s3_report_location = {
  1. object_key : s3_object_key option;
    (*

    S3 key.

    *)
  2. bucket_name : s3_bucket_name option;
    (*

    S3 bucket name.

    *)
}

S3 report location for the scheduled query run.

type nonrec error_report_location = {
  1. s3_report_location : s3_report_location option;
    (*

    The S3 location where error reports are written.

    *)
}

This contains the location of the error report for a single scheduled query call.

type nonrec scheduled_query_run_summary = {
  1. failure_reason : error_message option;
    (*

    Error message for the scheduled query in case of failure. You might have to look at the error report to get more detailed error reasons.

    *)
  2. error_report_location : error_report_location option;
    (*

    S3 location for error report.

    *)
  3. query_insights_response : scheduled_query_insights_response option;
    (*

    Provides various insights and metrics related to the run summary of the scheduled query.

    *)
  4. execution_stats : execution_stats option;
    (*

    Runtime statistics for a scheduled run.

    *)
  5. run_status : scheduled_query_run_status option;
    (*

    The status of a scheduled query run.

    *)
  6. trigger_time : time option;
    (*

    The actual time when the query was run.

    *)
  7. invocation_time : time option;
    (*

    InvocationTime for this run. This is the time at which the query is scheduled to run. Parameter @scheduled_runtime can be used in the query to get the value.

    *)
}

Run summary for the scheduled query

type nonrec scheduled_query_run_summary_list = scheduled_query_run_summary list
type nonrec scheduled_query_description = {
  1. recently_failed_runs : scheduled_query_run_summary_list option;
    (*

    Runtime summary for the last five failed scheduled query runs.

    *)
  2. last_run_summary : scheduled_query_run_summary option;
    (*

    Runtime summary for the last scheduled query run.

    *)
  3. error_report_configuration : error_report_configuration option;
    (*

    Error-reporting configuration for the scheduled query.

    *)
  4. kms_key_id : string_value2048 option;
    (*

    A customer provided KMS key used to encrypt the scheduled query resource.

    *)
  5. scheduled_query_execution_role_arn : amazon_resource_name option;
    (*

    IAM role that Timestream uses to run the schedule query.

    *)
  6. target_configuration : target_configuration option;
    (*

    Scheduled query target store configuration.

    *)
  7. notification_configuration : notification_configuration;
    (*

    Notification configuration.

    *)
  8. schedule_configuration : schedule_configuration;
    (*

    Schedule configuration.

    *)
  9. next_invocation_time : time option;
    (*

    The next time the scheduled query is scheduled to run.

    *)
  10. previous_invocation_time : time option;
    (*

    Last time the query was run.

    *)
  11. state : scheduled_query_state;
    (*

    State of the scheduled query.

    *)
  12. creation_time : time option;
    (*

    Creation time of the scheduled query.

    *)
  13. query_string : query_string;
    (*

    The query to be run.

    *)
  14. name : scheduled_query_name;
    (*

    Name of the scheduled query.

    *)
  15. arn : amazon_resource_name;
    (*

    Scheduled query ARN.

    *)
}

Structure that describes scheduled query.

type nonrec describe_scheduled_query_response = {
  1. scheduled_query : scheduled_query_description;
    (*

    The scheduled query.

    *)
}
type nonrec describe_scheduled_query_request = {
  1. scheduled_query_arn : amazon_resource_name;
    (*

    The ARN of the scheduled query.

    *)
}
type nonrec endpoint = {
  1. cache_period_in_minutes : long;
    (*

    The TTL for the endpoint, in minutes.

    *)
  2. address : string_;
    (*

    An endpoint address.

    *)
}

Represents an available endpoint against which to make API calls against, as well as the TTL for that endpoint.

type nonrec endpoints = endpoint list
type nonrec describe_endpoints_response = {
  1. endpoints : endpoints;
    (*

    An Endpoints object is returned when a DescribeEndpoints request is made.

    *)
}
type nonrec describe_endpoints_request = unit
type nonrec describe_account_settings_response = {
  1. query_compute : query_compute_response option;
    (*

    An object that contains the usage settings for Timestream Compute Units (TCUs) in your account for the query workload.

    *)
  2. query_pricing_model : query_pricing_model option;
    (*

    The pricing model for queries in your account.

    The QueryPricingModel parameter is used by several Timestream operations; however, the UpdateAccountSettings API operation doesn't recognize any values other than COMPUTE_UNITS.

    *)
  3. max_query_tc_u : max_query_capacity option;
    (*

    The maximum number of Timestream compute units (TCUs) the service will use at any point in time to serve your queries. To run queries, you must set a minimum capacity of 4 TCU. You can set the maximum number of TCU in multiples of 4, for example, 4, 8, 16, 32, and so on. This configuration is applicable only for on-demand usage of (TCUs).

    *)
}
type nonrec describe_account_settings_request = unit
type nonrec delete_scheduled_query_request = {
  1. scheduled_query_arn : amazon_resource_name;
    (*

    The ARN of the scheduled query.

    *)
}
type nonrec create_scheduled_query_response = {
  1. arn : amazon_resource_name;
    (*

    ARN for the created scheduled query.

    *)
}
type nonrec create_scheduled_query_request = {
  1. error_report_configuration : error_report_configuration;
    (*

    Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.

    *)
  2. kms_key_id : string_value2048 option;
    (*

    The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/

    If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.

    *)
  3. tags : tag_list option;
    (*

    A list of key-value pairs to label the scheduled query.

    *)
  4. scheduled_query_execution_role_arn : amazon_resource_name;
    (*

    The ARN for the IAM role that Timestream will assume when running the scheduled query.

    *)
  5. client_token : client_token option;
    (*

    Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.

    • If CreateScheduledQuery is called without a ClientToken, the Query SDK generates a ClientToken on your behalf.
    • After 8 hours, any request with the same ClientToken is treated as a new request.
    *)
  6. target_configuration : target_configuration option;
    (*

    Configuration used for writing the result of a query.

    *)
  7. notification_configuration : notification_configuration;
    (*

    Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.

    *)
  8. schedule_configuration : schedule_configuration;
    (*

    The schedule configuration for the query.

    *)
  9. query_string : query_string;
    (*

    The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run.

    The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.

    *)
  10. name : scheduled_query_name;
    (*

    Name of the scheduled query.

    *)
}
type nonrec cancel_query_response = {
  1. cancellation_message : string_ option;
    (*

    A CancellationMessage is returned when a CancelQuery request for the query specified by QueryId has already been issued.

    *)
}
type nonrec cancel_query_request = {
  1. query_id : query_id;
    (*

    The ID of the query that needs to be cancelled. QueryID is returned as part of the query result.

    *)
}