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

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

The response's http status code.

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.

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.

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

Configuration used for writing the result of a query.

Name of the scheduled query.

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.

The schedule configuration for the query.

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.

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

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

The response's http status code.

ARN for the created scheduled query.

The ARN of the scheduled query.

The response's http status code.

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

The ARN of the scheduled query.

The response's http status code.

The scheduled query.

Not used.

ARN of the scheduled query.

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

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.

A pagination token to resume pagination.

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

The response's http status code.

A list of scheduled queries.

The maximum number of tags to return.

A pagination token to resume pagination.

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

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

The response's http status code.

The tags currently associated with the Timestream resource.

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.

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.

The response's http status code.

The query string that you want prepare.

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

A list of parameters used in the submitted query string.

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.

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.

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.

The query to be run by Timestream.

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

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

The response's http status code.

A unique ID for the given query.

The result set rows returned by the query.

The column data types of the returned result set.

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

The tags to be assigned to the Timestream resource.

The response's http status code.

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

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

The response's http status code.

ARN of the scheuled query.

State of the scheduled query.

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

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.

Indicates if the data point is an array.

Indicates if the data point is null.

Indicates if the data point is a row.

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

Indicates if the data point is a timeseries data type.

Column name from query result.

Type for the dimension.

An endpoint address.

The TTL for the endpoint, in minutes.

The S3 configuration for the error reports.

The S3 location where error reports are written.

Bytes metered for a single scheduled query run.

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

Details on SNS configuration.

Parameter name.

Undocumented member.

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.

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.

The progress of the query, expressed as a percentage.

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

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

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

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

S3 bucket name.

S3 key.

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

The creation time of the scheduled query.

Configuration for scheduled query error reporting.

Status of the last scheduled query run.

The next time the scheduled query is to be run.

The last time the scheduled query was run.

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

The Amazon Resource Name.

The name of the scheduled query.

State of scheduled query.

Creation time of the scheduled query.

Error-reporting configuration for the scheduled query.

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

Runtime summary for the last scheduled query run.

The next time the scheduled query is scheduled to run.

Last time the query was run.

Runtime summary for the last five failed scheduled query runs.

IAM role that Timestream uses to run the schedule query.

Scheduled query target store configuration.

Scheduled query ARN.

Name of the scheduled query.

The query to be run.

State of the scheduled query.

Schedule configuration.

Notification configuration.

S3 location for error report.

Runtime statistics for a scheduled run.

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.

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.

The status of a scheduled query run.

The actual time when the query was run.

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

Database that has this column.

Name of the column.

Table within the database that has this column.

Undocumented member.

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

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

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

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

Query result destination details for Timestream data source.

The timestamp when the measure value was collected.

The measure value for the data point.

Name of the measure column.

Specifies how to map measures to multi-measure records.

Multi-measure mappings.

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

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.

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

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

Timestream database name.

Timestream table name.

Indicates if the column is an array.

Indicates if the column is a row.

Indicates if the column is of type string, integer, Boolean, double, timestamp, date, time.

Indicates if the column is a timeseries data type.