Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
This operation returns paginated results.
Synopsis
- data Query = Query' {}
- newQuery :: Text -> Query
- query_clientToken :: Lens' Query (Maybe Text)
- query_maxRows :: Lens' Query (Maybe Natural)
- query_nextToken :: Lens' Query (Maybe Text)
- query_queryString :: Lens' Query Text
- data QueryResponse = QueryResponse' {
- nextToken :: Maybe Text
- queryStatus :: Maybe QueryStatus
- httpStatus :: Int
- queryId :: Text
- rows :: [Row]
- columnInfo :: [ColumnInfo]
- newQueryResponse :: Int -> Text -> QueryResponse
- queryResponse_nextToken :: Lens' QueryResponse (Maybe Text)
- queryResponse_queryStatus :: Lens' QueryResponse (Maybe QueryStatus)
- queryResponse_httpStatus :: Lens' QueryResponse Int
- queryResponse_queryId :: Lens' QueryResponse Text
- queryResponse_rows :: Lens' QueryResponse [Row]
- queryResponse_columnInfo :: Lens' QueryResponse [ColumnInfo]
Creating a Request
See: newQuery
smart constructor.
Query' | |
|
Instances
Create a value of Query
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:Query'
, query_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 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.
$sel:maxRows:Query'
, query_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.
Query
, query_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 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.
Query
, query_queryString
- The query to be run by Timestream.
Request Lenses
query_clientToken :: Lens' Query (Maybe Text) Source #
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 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.
query_maxRows :: Lens' Query (Maybe Natural) Source #
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.
query_nextToken :: Lens' Query (Maybe Text) Source #
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 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.
Destructuring the Response
data QueryResponse Source #
See: newQueryResponse
smart constructor.
QueryResponse' | |
|
Instances
Create a value of QueryResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
Query
, queryResponse_nextToken
- A pagination token that can be used again on a Query
call to get the
next set of results.
$sel:queryStatus:QueryResponse'
, queryResponse_queryStatus
- Information about the status of the query, including progress and bytes
scanned.
$sel:httpStatus:QueryResponse'
, queryResponse_httpStatus
- The response's http status code.
$sel:queryId:QueryResponse'
, queryResponse_queryId
- A unique ID for the given query.
$sel:rows:QueryResponse'
, queryResponse_rows
- The result set rows returned by the query.
$sel:columnInfo:QueryResponse'
, queryResponse_columnInfo
- The column data types of the returned result set.
Response Lenses
queryResponse_nextToken :: Lens' QueryResponse (Maybe Text) Source #
A pagination token that can be used again on a Query
call to get the
next set of results.
queryResponse_queryStatus :: Lens' QueryResponse (Maybe QueryStatus) Source #
Information about the status of the query, including progress and bytes scanned.
queryResponse_httpStatus :: Lens' QueryResponse Int Source #
The response's http status code.
queryResponse_queryId :: Lens' QueryResponse Text Source #
A unique ID for the given query.
queryResponse_rows :: Lens' QueryResponse [Row] Source #
The result set rows returned by the query.
queryResponse_columnInfo :: Lens' QueryResponse [ColumnInfo] Source #
The column data types of the returned result set.