String queryId
The ID of the query that needs to be cancelled. QueryID is returned as part of the query result.
String cancellationMessage
A CancellationMessage is returned when a CancelQuery request for the query specified by
QueryId has already been issued.
String name
The name of the result set column. The name of the result set is available for columns of all data types except for arrays.
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.
String name
Name of the scheduled query.
String queryString
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.
ScheduleConfiguration scheduleConfiguration
The schedule configuration for the query.
NotificationConfiguration notificationConfiguration
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.
TargetConfiguration targetConfiguration
Configuration used for writing the result of a query.
String clientToken
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.
String scheduledQueryExecutionRoleArn
The ARN for the IAM role that Timestream will assume when running the scheduled query.
List<E> tags
A list of key-value pairs to label the scheduled query.
String kmsKeyId
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.
ErrorReportConfiguration errorReportConfiguration
Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
String arn
ARN for the created scheduled query.
String scalarValue
Indicates if the data point is a scalar value such as integer, string, double, or Boolean.
List<E> timeSeriesValue
Indicates if the data point is a timeseries data type.
List<E> arrayValue
Indicates if the data point is an array.
Row rowValue
Indicates if the data point is a row.
Boolean nullValue
Indicates if the data point is null.
String scheduledQueryArn
The ARN of the scheduled query.
String scheduledQueryArn
The ARN of the scheduled query.
ScheduledQueryDescription scheduledQuery
The scheduled query.
S3Configuration s3Configuration
The S3 configuration for the error reports.
S3ReportLocation s3ReportLocation
The S3 location where error reports are written.
Long executionTimeInMillis
Total time, measured in milliseconds, that was needed for the scheduled query run to complete.
Long dataWrites
Data writes metered for records ingested in a single scheduled query run.
Long bytesMetered
Bytes metered for a single scheduled query run.
Long recordsIngested
The number of records ingested for a single scheduled query run.
Long queryResultRows
Number of rows present in the output from running a query before ingestion to destination data source.
Integer maxResults
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.
String nextToken
A pagination token to resume pagination.
String measureName
Refers to the value of measure_name in a result row. This field is required if MeasureNameColumn is provided.
String sourceColumn
This field refers to the source column from which measure-value is to be read for result materialization.
String targetMeasureName
Target measure name to be used. If not provided, the target measure name by default would be measure-name if provided, or sourceColumn otherwise.
String measureValueType
Type of the value that is to be read from sourceColumn. If the mapping is for MULTI, use MeasureValueType.MULTI.
List<E> multiMeasureAttributeMappings
Required when measureValueType is MULTI. Attribute mappings for MULTI value measures.
String sourceColumn
Source column from where the attribute value is to be read.
String targetMultiMeasureAttributeName
Custom name to be used for attribute name in derived table. If not provided, source column name would be used.
String measureValueType
Type of the attribute to be read from the source column.
String targetMultiMeasureName
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.
List<E> multiMeasureAttributeMappings
Required. Attribute mappings to be used for mapping query results to ingest data for multi-measure attributes.
SnsConfiguration snsConfiguration
Details on SNS configuration.
String queryString
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.
Boolean validateOnly
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.
String queryString
The query to be run by Timestream.
String clientToken
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.
String nextToken
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.
Integer maxRows
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.
String queryId
A unique ID for the given query.
String nextToken
A pagination token that can be used again on a Query call to get the next set of results.
List<E> rows
The result set rows returned by the query.
List<E> columnInfo
The column data types of the returned result set.
QueryStatus queryStatus
Information about the status of the query, including progress and bytes scanned.
Double progressPercentage
The progress of the query, expressed as a percentage.
Long cumulativeBytesScanned
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.
Long cumulativeBytesMetered
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.
String scheduledQueryArn
The ARN of the scheduled query.
String bucketName
Name of the S3 bucket under which error reports will be created.
String objectKeyPrefix
Prefix for the error report key. Timestream by default adds the following prefix to the error report path.
String encryptionOption
Encryption at rest options for the error reports. If no encryption option is specified, Timestream will choose SSE_S3 as default.
String scheduleExpression
An expression that denotes when to trigger the scheduled query run. This can be a cron expression or a rate expression.
String arn
The Amazon Resource Name.
String name
The name of the scheduled query.
Date creationTime
The creation time of the scheduled query.
String state
State of scheduled query.
Date previousInvocationTime
The last time the scheduled query was run.
Date nextInvocationTime
The next time the scheduled query is to be run.
ErrorReportConfiguration errorReportConfiguration
Configuration for scheduled query error reporting.
TargetDestination targetDestination
Target data source where final scheduled query result will be written.
String lastRunStatus
Status of the last scheduled query run.
String arn
Scheduled query ARN.
String name
Name of the scheduled query.
String queryString
The query to be run.
Date creationTime
Creation time of the scheduled query.
String state
State of the scheduled query.
Date previousInvocationTime
Last time the query was run.
Date nextInvocationTime
The next time the scheduled query is scheduled to run.
ScheduleConfiguration scheduleConfiguration
Schedule configuration.
NotificationConfiguration notificationConfiguration
Notification configuration.
TargetConfiguration targetConfiguration
Scheduled query target store configuration.
String scheduledQueryExecutionRoleArn
IAM role that Timestream uses to run the schedule query.
String kmsKeyId
A customer provided KMS key used to encrypt the scheduled query resource.
ErrorReportConfiguration errorReportConfiguration
Error-reporting configuration for the scheduled query.
ScheduledQueryRunSummary lastRunSummary
Runtime summary for the last scheduled query run.
List<E> recentlyFailedRuns
Runtime summary for the last five failed scheduled query runs.
Date invocationTime
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.
Date triggerTime
The actual time when the query was run.
String runStatus
The status of a scheduled query run.
ExecutionStats executionStats
Runtime statistics for a scheduled run.
ErrorReportLocation errorReportLocation
S3 location for error report.
String failureReason
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.
String topicArn
SNS topic ARN that the scheduled query status notifications will be sent to.
TimestreamConfiguration timestreamConfiguration
Configuration needed to write data into the Timestream database and table.
TimestreamDestination timestreamDestination
Query result destination details for Timestream data source.
String databaseName
Name of Timestream database to which the query result will be written.
String tableName
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.
String timeColumn
Column from query result that should be used as the time column in destination table. Column type for this should be TIMESTAMP.
List<E> dimensionMappings
This is to allow mapping column(s) from the query result to the dimension in the destination table.
MultiMeasureMappings multiMeasureMappings
Multi-measure mappings.
List<E> mixedMeasureMappings
Specifies how to map measures to multi-measure records.
String measureNameColumn
Name of the measure column.
String scalarType
Indicates if the column is of type string, integer, Boolean, double, timestamp, date, time. For more information, see Supported data types.
ColumnInfo arrayColumnInfo
Indicates if the column is an array.
ColumnInfo timeSeriesMeasureValueColumnInfo
Indicates if the column is a timeseries data type.
List<E> rowColumnInfo
Indicates if the column is a row.
Copyright © 2024. All rights reserved.