2024/10/22 - Amazon Timestream Query - 3 updated api methods
Changes This release adds support for Query Insights, a feature that provides details of query execution, enabling users to identify areas for improvement to optimize their queries, resulting in improved query performance and lower query costs.
{'ScheduledQuery': {'LastRunSummary': {'QueryInsightsResponse': {'OutputBytes': 'long',
'OutputRows': 'long',
'QuerySpatialCoverage': {'Max': {'PartitionKey': ['string'],
'TableArn': 'string',
'Value': 'double'}},
'QueryTableCount': 'long',
'QueryTemporalRange': {'Max': {'TableArn': 'string',
'Value': 'long'}}}},
'RecentlyFailedRuns': {'QueryInsightsResponse': {'OutputBytes': 'long',
'OutputRows': 'long',
'QuerySpatialCoverage': {'Max': {'PartitionKey': ['string'],
'TableArn': 'string',
'Value': 'double'}},
'QueryTableCount': 'long',
'QueryTemporalRange': {'Max': {'TableArn': 'string',
'Value': 'long'}}}}}}
Provides detailed information about a scheduled query.
See also: AWS API Documentation
Request Syntax
client.describe_scheduled_query(
ScheduledQueryArn='string'
)
string
[REQUIRED]
The ARN of the scheduled query.
dict
Response Syntax
{
'ScheduledQuery': {
'Arn': 'string',
'Name': 'string',
'QueryString': 'string',
'CreationTime': datetime(2015, 1, 1),
'State': 'ENABLED'|'DISABLED',
'PreviousInvocationTime': datetime(2015, 1, 1),
'NextInvocationTime': datetime(2015, 1, 1),
'ScheduleConfiguration': {
'ScheduleExpression': 'string'
},
'NotificationConfiguration': {
'SnsConfiguration': {
'TopicArn': 'string'
}
},
'TargetConfiguration': {
'TimestreamConfiguration': {
'DatabaseName': 'string',
'TableName': 'string',
'TimeColumn': 'string',
'DimensionMappings': [
{
'Name': 'string',
'DimensionValueType': 'VARCHAR'
},
],
'MultiMeasureMappings': {
'TargetMultiMeasureName': 'string',
'MultiMeasureAttributeMappings': [
{
'SourceColumn': 'string',
'TargetMultiMeasureAttributeName': 'string',
'MeasureValueType': 'BIGINT'|'BOOLEAN'|'DOUBLE'|'VARCHAR'|'TIMESTAMP'
},
]
},
'MixedMeasureMappings': [
{
'MeasureName': 'string',
'SourceColumn': 'string',
'TargetMeasureName': 'string',
'MeasureValueType': 'BIGINT'|'BOOLEAN'|'DOUBLE'|'VARCHAR'|'MULTI',
'MultiMeasureAttributeMappings': [
{
'SourceColumn': 'string',
'TargetMultiMeasureAttributeName': 'string',
'MeasureValueType': 'BIGINT'|'BOOLEAN'|'DOUBLE'|'VARCHAR'|'TIMESTAMP'
},
]
},
],
'MeasureNameColumn': 'string'
}
},
'ScheduledQueryExecutionRoleArn': 'string',
'KmsKeyId': 'string',
'ErrorReportConfiguration': {
'S3Configuration': {
'BucketName': 'string',
'ObjectKeyPrefix': 'string',
'EncryptionOption': 'SSE_S3'|'SSE_KMS'
}
},
'LastRunSummary': {
'InvocationTime': datetime(2015, 1, 1),
'TriggerTime': datetime(2015, 1, 1),
'RunStatus': 'AUTO_TRIGGER_SUCCESS'|'AUTO_TRIGGER_FAILURE'|'MANUAL_TRIGGER_SUCCESS'|'MANUAL_TRIGGER_FAILURE',
'ExecutionStats': {
'ExecutionTimeInMillis': 123,
'DataWrites': 123,
'BytesMetered': 123,
'CumulativeBytesScanned': 123,
'RecordsIngested': 123,
'QueryResultRows': 123
},
'QueryInsightsResponse': {
'QuerySpatialCoverage': {
'Max': {
'Value': 123.0,
'TableArn': 'string',
'PartitionKey': [
'string',
]
}
},
'QueryTemporalRange': {
'Max': {
'Value': 123,
'TableArn': 'string'
}
},
'QueryTableCount': 123,
'OutputRows': 123,
'OutputBytes': 123
},
'ErrorReportLocation': {
'S3ReportLocation': {
'BucketName': 'string',
'ObjectKey': 'string'
}
},
'FailureReason': 'string'
},
'RecentlyFailedRuns': [
{
'InvocationTime': datetime(2015, 1, 1),
'TriggerTime': datetime(2015, 1, 1),
'RunStatus': 'AUTO_TRIGGER_SUCCESS'|'AUTO_TRIGGER_FAILURE'|'MANUAL_TRIGGER_SUCCESS'|'MANUAL_TRIGGER_FAILURE',
'ExecutionStats': {
'ExecutionTimeInMillis': 123,
'DataWrites': 123,
'BytesMetered': 123,
'CumulativeBytesScanned': 123,
'RecordsIngested': 123,
'QueryResultRows': 123
},
'QueryInsightsResponse': {
'QuerySpatialCoverage': {
'Max': {
'Value': 123.0,
'TableArn': 'string',
'PartitionKey': [
'string',
]
}
},
'QueryTemporalRange': {
'Max': {
'Value': 123,
'TableArn': 'string'
}
},
'QueryTableCount': 123,
'OutputRows': 123,
'OutputBytes': 123
},
'ErrorReportLocation': {
'S3ReportLocation': {
'BucketName': 'string',
'ObjectKey': 'string'
}
},
'FailureReason': 'string'
},
]
}
}
Response Structure
(dict) --
ScheduledQuery (dict) --
The scheduled query.
Arn (string) --
Scheduled query ARN.
Name (string) --
Name of the scheduled query.
QueryString (string) --
The query to be run.
CreationTime (datetime) --
Creation time of the scheduled query.
State (string) --
State of the scheduled query.
PreviousInvocationTime (datetime) --
Last time the query was run.
NextInvocationTime (datetime) --
The next time the scheduled query is scheduled to run.
ScheduleConfiguration (dict) --
Schedule configuration.
ScheduleExpression (string) --
An expression that denotes when to trigger the scheduled query run. This can be a cron expression or a rate expression.
NotificationConfiguration (dict) --
Notification configuration.
SnsConfiguration (dict) --
Details on SNS configuration.
TopicArn (string) --
SNS topic ARN that the scheduled query status notifications will be sent to.
TargetConfiguration (dict) --
Scheduled query target store configuration.
TimestreamConfiguration (dict) --
Configuration needed to write data into the Timestream database and table.
DatabaseName (string) --
Name of Timestream database to which the query result will be written.
TableName (string) --
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.
TimeColumn (string) --
Column from query result that should be used as the time column in destination table. Column type for this should be TIMESTAMP.
DimensionMappings (list) --
This is to allow mapping column(s) from the query result to the dimension in the destination table.
(dict) --
This type is used to map column(s) from the query result to a dimension in the destination table.
Name (string) --
Column name from query result.
DimensionValueType (string) --
Type for the dimension.
MultiMeasureMappings (dict) --
Multi-measure mappings.
TargetMultiMeasureName (string) --
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.
MultiMeasureAttributeMappings (list) --
Required. Attribute mappings to be used for mapping query results to ingest data for multi-measure attributes.
(dict) --
Attribute mapping for MULTI value measures.
SourceColumn (string) --
Source column from where the attribute value is to be read.
TargetMultiMeasureAttributeName (string) --
Custom name to be used for attribute name in derived table. If not provided, source column name would be used.
MeasureValueType (string) --
Type of the attribute to be read from the source column.
MixedMeasureMappings (list) --
Specifies how to map measures to multi-measure records.
(dict) --
MixedMeasureMappings are mappings that can be used to ingest data into a mixture of narrow and multi measures in the derived table.
MeasureName (string) --
Refers to the value of measure_name in a result row. This field is required if MeasureNameColumn is provided.
SourceColumn (string) --
This field refers to the source column from which measure-value is to be read for result materialization.
TargetMeasureName (string) --
Target measure name to be used. If not provided, the target measure name by default would be measure-name if provided, or sourceColumn otherwise.
MeasureValueType (string) --
Type of the value that is to be read from sourceColumn. If the mapping is for MULTI, use MeasureValueType.MULTI.
MultiMeasureAttributeMappings (list) --
Required when measureValueType is MULTI. Attribute mappings for MULTI value measures.
(dict) --
Attribute mapping for MULTI value measures.
SourceColumn (string) --
Source column from where the attribute value is to be read.
TargetMultiMeasureAttributeName (string) --
Custom name to be used for attribute name in derived table. If not provided, source column name would be used.
MeasureValueType (string) --
Type of the attribute to be read from the source column.
MeasureNameColumn (string) --
Name of the measure column.
ScheduledQueryExecutionRoleArn (string) --
IAM role that Timestream uses to run the schedule query.
KmsKeyId (string) --
A customer provided KMS key used to encrypt the scheduled query resource.
ErrorReportConfiguration (dict) --
Error-reporting configuration for the scheduled query.
S3Configuration (dict) --
The S3 configuration for the error reports.
BucketName (string) --
Name of the S3 bucket under which error reports will be created.
ObjectKeyPrefix (string) --
Prefix for the error report key. Timestream by default adds the following prefix to the error report path.
EncryptionOption (string) --
Encryption at rest options for the error reports. If no encryption option is specified, Timestream will choose SSE_S3 as default.
LastRunSummary (dict) --
Runtime summary for the last scheduled query run.
InvocationTime (datetime) --
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.
TriggerTime (datetime) --
The actual time when the query was run.
RunStatus (string) --
The status of a scheduled query run.
ExecutionStats (dict) --
Runtime statistics for a scheduled run.
ExecutionTimeInMillis (integer) --
Total time, measured in milliseconds, that was needed for the scheduled query run to complete.
DataWrites (integer) --
Data writes metered for records ingested in a single scheduled query run.
BytesMetered (integer) --
Bytes metered for a single scheduled query run.
CumulativeBytesScanned (integer) --
Bytes scanned for a single scheduled query run.
RecordsIngested (integer) --
The number of records ingested for a single scheduled query run.
QueryResultRows (integer) --
Number of rows present in the output from running a query before ingestion to destination data source.
QueryInsightsResponse (dict) --
Provides various insights and metrics related to the run summary of the scheduled query.
QuerySpatialCoverage (dict) --
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.
Max (dict) --
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.
Value (float) --
The maximum ratio of spatial coverage.
TableArn (string) --
The Amazon Resource Name (ARN) of the table with the most sub-optimal spatial pruning.
PartitionKey (list) --
The partition key used for partitioning, which can be a default measure_name or a customer defined partition key.
(string) --
QueryTemporalRange (dict) --
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.
Max (dict) --
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.
Value (integer) --
The maximum duration in nanoseconds between the start and end of the query.
TableArn (string) --
The Amazon Resource Name (ARN) of the table which is queried with the largest time range.
QueryTableCount (integer) --
Indicates the number of tables in the query.
OutputRows (integer) --
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.
OutputBytes (integer) --
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.
ErrorReportLocation (dict) --
S3 location for error report.
S3ReportLocation (dict) --
The S3 location where error reports are written.
BucketName (string) --
S3 bucket name.
ObjectKey (string) --
S3 key.
FailureReason (string) --
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.
RecentlyFailedRuns (list) --
Runtime summary for the last five failed scheduled query runs.
(dict) --
Run summary for the scheduled query
InvocationTime (datetime) --
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.
TriggerTime (datetime) --
The actual time when the query was run.
RunStatus (string) --
The status of a scheduled query run.
ExecutionStats (dict) --
Runtime statistics for a scheduled run.
ExecutionTimeInMillis (integer) --
Total time, measured in milliseconds, that was needed for the scheduled query run to complete.
DataWrites (integer) --
Data writes metered for records ingested in a single scheduled query run.
BytesMetered (integer) --
Bytes metered for a single scheduled query run.
CumulativeBytesScanned (integer) --
Bytes scanned for a single scheduled query run.
RecordsIngested (integer) --
The number of records ingested for a single scheduled query run.
QueryResultRows (integer) --
Number of rows present in the output from running a query before ingestion to destination data source.
QueryInsightsResponse (dict) --
Provides various insights and metrics related to the run summary of the scheduled query.
QuerySpatialCoverage (dict) --
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.
Max (dict) --
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.
Value (float) --
The maximum ratio of spatial coverage.
TableArn (string) --
The Amazon Resource Name (ARN) of the table with the most sub-optimal spatial pruning.
PartitionKey (list) --
The partition key used for partitioning, which can be a default measure_name or a customer defined partition key.
(string) --
QueryTemporalRange (dict) --
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.
Max (dict) --
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.
Value (integer) --
The maximum duration in nanoseconds between the start and end of the query.
TableArn (string) --
The Amazon Resource Name (ARN) of the table which is queried with the largest time range.
QueryTableCount (integer) --
Indicates the number of tables in the query.
OutputRows (integer) --
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.
OutputBytes (integer) --
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.
ErrorReportLocation (dict) --
S3 location for error report.
S3ReportLocation (dict) --
The S3 location where error reports are written.
BucketName (string) --
S3 bucket name.
ObjectKey (string) --
S3 key.
FailureReason (string) --
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.
{'QueryInsights': {'Mode': 'ENABLED_WITH_RATE_CONTROL | DISABLED'}}
You can use this API to run a scheduled query manually.
If you enabled QueryInsights, this API also returns insights and metrics related to the query that you executed as part of an Amazon SNS notification. QueryInsights helps with performance tuning of your query.
See also: AWS API Documentation
Request Syntax
client.execute_scheduled_query(
ScheduledQueryArn='string',
InvocationTime=datetime(2015, 1, 1),
ClientToken='string',
QueryInsights={
'Mode': 'ENABLED_WITH_RATE_CONTROL'|'DISABLED'
}
)
string
[REQUIRED]
ARN of the scheduled query.
datetime
[REQUIRED]
The timestamp in UTC. Query will be run as if it was invoked at this timestamp.
string
Not used.
This field is autopopulated if not provided.
dict
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.
Mode (string) -- [REQUIRED]
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.
None
{'QueryInsights': {'Mode': 'ENABLED_WITH_RATE_CONTROL | DISABLED'}}
Response {'QueryInsightsResponse': {'OutputBytes': 'long',
'OutputRows': 'long',
'QuerySpatialCoverage': {'Max': {'PartitionKey': ['string'],
'TableArn': 'string',
'Value': 'double'}},
'QueryTableCount': 'long',
'QueryTemporalRange': {'Max': {'TableArn': 'string',
'Value': 'long'}},
'UnloadPartitionCount': 'long',
'UnloadWrittenBytes': 'long',
'UnloadWrittenRows': 'long'}}
Query is a synchronous operation that enables you to run a query against your Amazon Timestream data.
If you enabled QueryInsights, this API also returns insights and metrics related to the query that you executed. QueryInsights helps with performance tuning of your query.
Your query request will fail in the following cases:
If you submit a Query request with the same client token outside of the 5-minute idempotency window.
If you submit a Query request with the same client token, but change other parameters, within the 5-minute idempotency window.
If the size of the row (including the query metadata) exceeds 1 MB, then the query will fail with the following error message: Query aborted as max page response size has been exceeded by the output result row
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.
See also: AWS API Documentation
Request Syntax
client.query(
QueryString='string',
ClientToken='string',
NextToken='string',
MaxRows=123,
QueryInsights={
'Mode': 'ENABLED_WITH_RATE_CONTROL'|'DISABLED'
}
)
string
[REQUIRED]
The query to be run by Timestream.
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.
This field is autopopulated if not provided.
string
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
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.
dict
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.
Mode (string) -- [REQUIRED]
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.
dict
Response Syntax
{
'QueryId': 'string',
'NextToken': 'string',
'Rows': [
{
'Data': [
{
'ScalarValue': 'string',
'TimeSeriesValue': [
{
'Time': 'string',
'Value': {'... recursive ...'}
},
],
'ArrayValue': {'... recursive ...'},
'RowValue': {'... recursive ...'},
'NullValue': True|False
},
]
},
],
'ColumnInfo': [
{
'Name': 'string',
'Type': {
'ScalarType': 'VARCHAR'|'BOOLEAN'|'BIGINT'|'DOUBLE'|'TIMESTAMP'|'DATE'|'TIME'|'INTERVAL_DAY_TO_SECOND'|'INTERVAL_YEAR_TO_MONTH'|'UNKNOWN'|'INTEGER',
'ArrayColumnInfo': {'... recursive ...'},
'TimeSeriesMeasureValueColumnInfo': {'... recursive ...'},
'RowColumnInfo': {'... recursive ...'}
}
},
],
'QueryStatus': {
'ProgressPercentage': 123.0,
'CumulativeBytesScanned': 123,
'CumulativeBytesMetered': 123
},
'QueryInsightsResponse': {
'QuerySpatialCoverage': {
'Max': {
'Value': 123.0,
'TableArn': 'string',
'PartitionKey': [
'string',
]
}
},
'QueryTemporalRange': {
'Max': {
'Value': 123,
'TableArn': 'string'
}
},
'QueryTableCount': 123,
'OutputRows': 123,
'OutputBytes': 123,
'UnloadPartitionCount': 123,
'UnloadWrittenRows': 123,
'UnloadWrittenBytes': 123
}
}
Response Structure
(dict) --
QueryId (string) --
A unique ID for the given query.
NextToken (string) --
A pagination token that can be used again on a Query call to get the next set of results.
Rows (list) --
The result set rows returned by the query.
(dict) --
Represents a single row in the query results.
Data (list) --
List of data points in a single row of the result set.
(dict) --
Datum represents a single data point in a query result.
ScalarValue (string) --
Indicates if the data point is a scalar value such as integer, string, double, or Boolean.
TimeSeriesValue (list) --
Indicates if the data point is a timeseries data type.
(dict) --
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.
Time (string) --
The timestamp when the measure value was collected.
Value (dict) --
The measure value for the data point.
ArrayValue (list) --
Indicates if the data point is an array.
RowValue (dict) --
Indicates if the data point is a row.
NullValue (boolean) --
Indicates if the data point is null.
ColumnInfo (list) --
The column data types of the returned result set.
(dict) --
Contains the metadata for query results such as the column names, data types, and other attributes.
Name (string) --
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 (dict) --
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.
ScalarType (string) --
Indicates if the column is of type string, integer, Boolean, double, timestamp, date, time. For more information, see Supported data types.
ArrayColumnInfo (dict) --
Indicates if the column is an array.
TimeSeriesMeasureValueColumnInfo (dict) --
Indicates if the column is a timeseries data type.
RowColumnInfo (list) --
Indicates if the column is a row.
QueryStatus (dict) --
Information about the status of the query, including progress and bytes scanned.
ProgressPercentage (float) --
The progress of the query, expressed as a percentage.
CumulativeBytesScanned (integer) --
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.
CumulativeBytesMetered (integer) --
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.
QueryInsightsResponse (dict) --
Encapsulates QueryInsights containing insights and metrics related to the query that you executed.
QuerySpatialCoverage (dict) --
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.
Max (dict) --
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.
Value (float) --
The maximum ratio of spatial coverage.
TableArn (string) --
The Amazon Resource Name (ARN) of the table with the most sub-optimal spatial pruning.
PartitionKey (list) --
The partition key used for partitioning, which can be a default measure_name or a customer defined partition key.
(string) --
QueryTemporalRange (dict) --
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.
Max (dict) --
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.
Value (integer) --
The maximum duration in nanoseconds between the start and end of the query.
TableArn (string) --
The Amazon Resource Name (ARN) of the table which is queried with the largest time range.
QueryTableCount (integer) --
Indicates the number of tables in the query.
OutputRows (integer) --
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.
OutputBytes (integer) --
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.
UnloadPartitionCount (integer) --
Indicates the partitions created by the Unload operation.
UnloadWrittenRows (integer) --
Indicates the rows written by the Unload query.
UnloadWrittenBytes (integer) --
Indicates the size, in bytes, written by the Unload operation.