AWS SDK for C++  1.9.161
AWS SDK for C++
Public Member Functions | List of all members
Aws::TimestreamQuery::Model::QueryRequest Class Reference

#include <QueryRequest.h>

+ Inheritance diagram for Aws::TimestreamQuery::Model::QueryRequest:

Public Member Functions

 QueryRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetQueryString () const
 
bool QueryStringHasBeenSet () const
 
void SetQueryString (const Aws::String &value)
 
void SetQueryString (Aws::String &&value)
 
void SetQueryString (const char *value)
 
QueryRequestWithQueryString (const Aws::String &value)
 
QueryRequestWithQueryString (Aws::String &&value)
 
QueryRequestWithQueryString (const char *value)
 
const Aws::StringGetClientToken () const
 
bool ClientTokenHasBeenSet () const
 
void SetClientToken (const Aws::String &value)
 
void SetClientToken (Aws::String &&value)
 
void SetClientToken (const char *value)
 
QueryRequestWithClientToken (const Aws::String &value)
 
QueryRequestWithClientToken (Aws::String &&value)
 
QueryRequestWithClientToken (const char *value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
QueryRequestWithNextToken (const Aws::String &value)
 
QueryRequestWithNextToken (Aws::String &&value)
 
QueryRequestWithNextToken (const char *value)
 
int GetMaxRows () const
 
bool MaxRowsHasBeenSet () const
 
void SetMaxRows (int value)
 
QueryRequestWithMaxRows (int value)
 
- Public Member Functions inherited from Aws::TimestreamQuery::TimestreamQueryRequest
virtual ~TimestreamQueryRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 22 of file QueryRequest.h.

Constructor & Destructor Documentation

◆ QueryRequest()

Aws::TimestreamQuery::Model::QueryRequest::QueryRequest ( )

Member Function Documentation

◆ ClientTokenHasBeenSet()

bool Aws::TimestreamQuery::Model::QueryRequest::ClientTokenHasBeenSet ( ) const
inline

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.

Definition at line 117 of file QueryRequest.h.

◆ GetClientToken()

const Aws::String& Aws::TimestreamQuery::Model::QueryRequest::GetClientToken ( ) const
inline

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.

Definition at line 97 of file QueryRequest.h.

◆ GetMaxRows()

int Aws::TimestreamQuery::Model::QueryRequest::GetMaxRows ( ) const
inline

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.

Definition at line 472 of file QueryRequest.h.

◆ GetNextToken()

const Aws::String& Aws::TimestreamQuery::Model::QueryRequest::GetNextToken ( ) const
inline

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.

Definition at line 265 of file QueryRequest.h.

◆ GetQueryString()

const Aws::String& Aws::TimestreamQuery::Model::QueryRequest::GetQueryString ( ) const
inline

The query to be run by Timestream.

Definition at line 41 of file QueryRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::TimestreamQuery::Model::QueryRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::TimestreamQuery::Model::QueryRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file QueryRequest.h.

◆ MaxRowsHasBeenSet()

bool Aws::TimestreamQuery::Model::QueryRequest::MaxRowsHasBeenSet ( ) const
inline

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.

Definition at line 489 of file QueryRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::TimestreamQuery::Model::QueryRequest::NextTokenHasBeenSet ( ) const
inline

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.

Definition at line 292 of file QueryRequest.h.

◆ QueryStringHasBeenSet()

bool Aws::TimestreamQuery::Model::QueryRequest::QueryStringHasBeenSet ( ) const
inline

The query to be run by Timestream.

Definition at line 46 of file QueryRequest.h.

◆ SerializePayload()

Aws::String Aws::TimestreamQuery::Model::QueryRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientToken() [1/3]

void Aws::TimestreamQuery::Model::QueryRequest::SetClientToken ( Aws::String &&  value)
inline

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.

Definition at line 157 of file QueryRequest.h.

◆ SetClientToken() [2/3]

void Aws::TimestreamQuery::Model::QueryRequest::SetClientToken ( const Aws::String value)
inline

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.

Definition at line 137 of file QueryRequest.h.

◆ SetClientToken() [3/3]

void Aws::TimestreamQuery::Model::QueryRequest::SetClientToken ( const char *  value)
inline

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.

Definition at line 177 of file QueryRequest.h.

◆ SetMaxRows()

void Aws::TimestreamQuery::Model::QueryRequest::SetMaxRows ( int  value)
inline

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.

Definition at line 506 of file QueryRequest.h.

◆ SetNextToken() [1/3]

void Aws::TimestreamQuery::Model::QueryRequest::SetNextToken ( Aws::String &&  value)
inline

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.

Definition at line 346 of file QueryRequest.h.

◆ SetNextToken() [2/3]

void Aws::TimestreamQuery::Model::QueryRequest::SetNextToken ( const Aws::String value)
inline

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.

Definition at line 319 of file QueryRequest.h.

◆ SetNextToken() [3/3]

void Aws::TimestreamQuery::Model::QueryRequest::SetNextToken ( const char *  value)
inline

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.

Definition at line 373 of file QueryRequest.h.

◆ SetQueryString() [1/3]

void Aws::TimestreamQuery::Model::QueryRequest::SetQueryString ( Aws::String &&  value)
inline

The query to be run by Timestream.

Definition at line 56 of file QueryRequest.h.

◆ SetQueryString() [2/3]

void Aws::TimestreamQuery::Model::QueryRequest::SetQueryString ( const Aws::String value)
inline

The query to be run by Timestream.

Definition at line 51 of file QueryRequest.h.

◆ SetQueryString() [3/3]

void Aws::TimestreamQuery::Model::QueryRequest::SetQueryString ( const char *  value)
inline

The query to be run by Timestream.

Definition at line 61 of file QueryRequest.h.

◆ WithClientToken() [1/3]

QueryRequest& Aws::TimestreamQuery::Model::QueryRequest::WithClientToken ( Aws::String &&  value)
inline

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.

Definition at line 217 of file QueryRequest.h.

◆ WithClientToken() [2/3]

QueryRequest& Aws::TimestreamQuery::Model::QueryRequest::WithClientToken ( const Aws::String value)
inline

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.

Definition at line 197 of file QueryRequest.h.

◆ WithClientToken() [3/3]

QueryRequest& Aws::TimestreamQuery::Model::QueryRequest::WithClientToken ( const char *  value)
inline

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.

Definition at line 237 of file QueryRequest.h.

◆ WithMaxRows()

QueryRequest& Aws::TimestreamQuery::Model::QueryRequest::WithMaxRows ( int  value)
inline

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.

Definition at line 523 of file QueryRequest.h.

◆ WithNextToken() [1/3]

QueryRequest& Aws::TimestreamQuery::Model::QueryRequest::WithNextToken ( Aws::String &&  value)
inline

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.

Definition at line 427 of file QueryRequest.h.

◆ WithNextToken() [2/3]

QueryRequest& Aws::TimestreamQuery::Model::QueryRequest::WithNextToken ( const Aws::String value)
inline

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.

Definition at line 400 of file QueryRequest.h.

◆ WithNextToken() [3/3]

QueryRequest& Aws::TimestreamQuery::Model::QueryRequest::WithNextToken ( const char *  value)
inline

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.

Definition at line 454 of file QueryRequest.h.

◆ WithQueryString() [1/3]

QueryRequest& Aws::TimestreamQuery::Model::QueryRequest::WithQueryString ( Aws::String &&  value)
inline

The query to be run by Timestream.

Definition at line 71 of file QueryRequest.h.

◆ WithQueryString() [2/3]

QueryRequest& Aws::TimestreamQuery::Model::QueryRequest::WithQueryString ( const Aws::String value)
inline

The query to be run by Timestream.

Definition at line 66 of file QueryRequest.h.

◆ WithQueryString() [3/3]

QueryRequest& Aws::TimestreamQuery::Model::QueryRequest::WithQueryString ( const char *  value)
inline

The query to be run by Timestream.

Definition at line 76 of file QueryRequest.h.


The documentation for this class was generated from the following file: