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.
See https://www.paws-r-sdk.com/docs/timestreamquery_query/ for full documentation.
timestreamquery_query(
QueryString,
ClientToken = NULL,
NextToken = NULL,
MaxRows = NULL
)[required] The query to be run by Timestream.
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.
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 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.