TimestreamQuery / Client / query
query#
- TimestreamQuery.Client.query(**kwargs)#
Query
is a synchronous operation that enables you to run a query against your Amazon Timestream data.Query
will time out after 60 seconds. You must update the default timeout in the SDK to support a timeout of 60 seconds. See the code sample for details.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
response = client.query( QueryString='string', ClientToken='string', NextToken='string', MaxRows=123 )
- Parameters:
QueryString (string) –
[REQUIRED]
The query to be run by Timestream.
ClientToken (string) –
Unique, case-sensitive string of up to 64 ASCII characters specified when a
Query
request is made. Providing aClientToken
makes the call toQuery
idempotent. This means that running the same query repeatedly will produce the same result. In other words, making multiple identicalQuery
requests has the same effect as making a single request. When usingClientToken
in a query, note the following:If the Query API is instantiated without a
ClientToken
, the Query SDK generates aClientToken
on your behalf.If the
Query
invocation only contains theClientToken
but does not include aNextToken
, that invocation ofQuery
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.
NextToken (string) –
A pagination token used to return a set of results. When the
Query
API is invoked usingNextToken
, that particular invocation is assumed to be a subsequent invocation of a prior call toQuery
, and a result set is returned. However, if theQuery
invocation only contains theClientToken
, that invocation ofQuery
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 recentnextToken
.Suppose a
Query
invocation returns twoNextToken
values,TokenA
andTokenB
. IfTokenB
is used in a subsequentQuery
invocation, thenTokenA
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 untilnull
is returned, at which point a newNextToken
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.
MaxRows (integer) –
The total number of rows to be returned in the
Query
output. The initial run ofQuery
with aMaxRows
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 aNextToken
, which can then be used in subsequent calls to fetch the result set. To resume pagination, provide theNextToken
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.
- Return type:
dict
- Returns:
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 } }
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.
Exceptions