You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::TimestreamQuery::Types::QueryRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::TimestreamQuery::Types::QueryRequest
- Defined in:
- (unknown)
Overview
When passing QueryRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
query_string: "QueryString", # required
client_token: "ClientRequestToken",
next_token: "String",
max_rows: 1,
}
Instance Attribute Summary collapse
-
#client_token ⇒ String
Unique, case-sensitive string of up to 64 ASCII characters that you specify when you make a Query request.
-
#max_rows ⇒ Integer
The total number of rows to return in the output.
-
#next_token ⇒ String
A pagination token passed to get a set of results.
-
#query_string ⇒ String
The query to be executed by Timestream.
Instance Attribute Details
#client_token ⇒ String
Unique, case-sensitive string of up to 64 ASCII characters that you
specify when you make a Query request. Providing a ClientToken
makes
the call to Query
idempotent, meaning that multiple identical calls
have the same effect as one single call.
Your query request will fail in the following cases:
If you submit a request with the same client token outside the 5-minute idepotency window.
If you submit a request with the same client token but a change in other parameters within the 5-minute idempotency window.
After 4 hours, any request with the same client token is treated as a new request.
#max_rows ⇒ Integer
The total number of rows to return in the output. If the total number of rows available is more than the value specified, a NextToken is provided in the command\'s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command.
#next_token ⇒ String
A pagination token passed to get a set of results.
#query_string ⇒ String
The query to be executed by Timestream.