AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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
show all
Defined in:
(unknown)

Overview

Note:

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

Instance Attribute Details

#client_tokenString

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.

Returns:

  • (String)

    Unique, case-sensitive string of up to 64 ASCII characters that you specify when you make a Query request.

#max_rowsInteger

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.

Returns:

  • (Integer)

    The total number of rows to return in the output.

#next_tokenString

A pagination token passed to get a set of results.

Returns:

  • (String)

    A pagination token passed to get a set of results.

#query_stringString

The query to be executed by Timestream.

Returns:

  • (String)

    The query to be executed by Timestream.