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

#include <TimestreamQueryClient.h>

+ Inheritance diagram for Aws::TimestreamQuery::TimestreamQueryClient:

Public Types

typedef Aws::Client::AWSJsonClient BASECLASS
 
- Public Types inherited from Aws::Client::AWSJsonClient
typedef AWSClient BASECLASS
 

Public Member Functions

 TimestreamQueryClient (const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 TimestreamQueryClient (const Aws::Auth::AWSCredentials &credentials, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 TimestreamQueryClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
virtual ~TimestreamQueryClient ()
 
virtual Model::CancelQueryOutcome CancelQuery (const Model::CancelQueryRequest &request) const
 
virtual Model::CancelQueryOutcomeCallable CancelQueryCallable (const Model::CancelQueryRequest &request) const
 
virtual void CancelQueryAsync (const Model::CancelQueryRequest &request, const CancelQueryResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::CreateScheduledQueryOutcome CreateScheduledQuery (const Model::CreateScheduledQueryRequest &request) const
 
virtual Model::CreateScheduledQueryOutcomeCallable CreateScheduledQueryCallable (const Model::CreateScheduledQueryRequest &request) const
 
virtual void CreateScheduledQueryAsync (const Model::CreateScheduledQueryRequest &request, const CreateScheduledQueryResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteScheduledQueryOutcome DeleteScheduledQuery (const Model::DeleteScheduledQueryRequest &request) const
 
virtual Model::DeleteScheduledQueryOutcomeCallable DeleteScheduledQueryCallable (const Model::DeleteScheduledQueryRequest &request) const
 
virtual void DeleteScheduledQueryAsync (const Model::DeleteScheduledQueryRequest &request, const DeleteScheduledQueryResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeEndpointsOutcome DescribeEndpoints (const Model::DescribeEndpointsRequest &request) const
 
virtual Model::DescribeEndpointsOutcomeCallable DescribeEndpointsCallable (const Model::DescribeEndpointsRequest &request) const
 
virtual void DescribeEndpointsAsync (const Model::DescribeEndpointsRequest &request, const DescribeEndpointsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeScheduledQueryOutcome DescribeScheduledQuery (const Model::DescribeScheduledQueryRequest &request) const
 
virtual Model::DescribeScheduledQueryOutcomeCallable DescribeScheduledQueryCallable (const Model::DescribeScheduledQueryRequest &request) const
 
virtual void DescribeScheduledQueryAsync (const Model::DescribeScheduledQueryRequest &request, const DescribeScheduledQueryResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ExecuteScheduledQueryOutcome ExecuteScheduledQuery (const Model::ExecuteScheduledQueryRequest &request) const
 
virtual Model::ExecuteScheduledQueryOutcomeCallable ExecuteScheduledQueryCallable (const Model::ExecuteScheduledQueryRequest &request) const
 
virtual void ExecuteScheduledQueryAsync (const Model::ExecuteScheduledQueryRequest &request, const ExecuteScheduledQueryResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListScheduledQueriesOutcome ListScheduledQueries (const Model::ListScheduledQueriesRequest &request) const
 
virtual Model::ListScheduledQueriesOutcomeCallable ListScheduledQueriesCallable (const Model::ListScheduledQueriesRequest &request) const
 
virtual void ListScheduledQueriesAsync (const Model::ListScheduledQueriesRequest &request, const ListScheduledQueriesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListTagsForResourceOutcome ListTagsForResource (const Model::ListTagsForResourceRequest &request) const
 
virtual Model::ListTagsForResourceOutcomeCallable ListTagsForResourceCallable (const Model::ListTagsForResourceRequest &request) const
 
virtual void ListTagsForResourceAsync (const Model::ListTagsForResourceRequest &request, const ListTagsForResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::PrepareQueryOutcome PrepareQuery (const Model::PrepareQueryRequest &request) const
 
virtual Model::PrepareQueryOutcomeCallable PrepareQueryCallable (const Model::PrepareQueryRequest &request) const
 
virtual void PrepareQueryAsync (const Model::PrepareQueryRequest &request, const PrepareQueryResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::QueryOutcome Query (const Model::QueryRequest &request) const
 
virtual Model::QueryOutcomeCallable QueryCallable (const Model::QueryRequest &request) const
 
virtual void QueryAsync (const Model::QueryRequest &request, const QueryResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::TagResourceOutcome TagResource (const Model::TagResourceRequest &request) const
 
virtual Model::TagResourceOutcomeCallable TagResourceCallable (const Model::TagResourceRequest &request) const
 
virtual void TagResourceAsync (const Model::TagResourceRequest &request, const TagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UntagResourceOutcome UntagResource (const Model::UntagResourceRequest &request) const
 
virtual Model::UntagResourceOutcomeCallable UntagResourceCallable (const Model::UntagResourceRequest &request) const
 
virtual void UntagResourceAsync (const Model::UntagResourceRequest &request, const UntagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UpdateScheduledQueryOutcome UpdateScheduledQuery (const Model::UpdateScheduledQueryRequest &request) const
 
virtual Model::UpdateScheduledQueryOutcomeCallable UpdateScheduledQueryCallable (const Model::UpdateScheduledQueryRequest &request) const
 
virtual void UpdateScheduledQueryAsync (const Model::UpdateScheduledQueryRequest &request, const UpdateScheduledQueryResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
void OverrideEndpoint (const Aws::String &endpoint)
 
- Public Member Functions inherited from Aws::Client::AWSJsonClient
 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSJsonClient ()=default
 
- Public Member Functions inherited from Aws::Client::AWSClient
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSClient ()
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
void DisableRequestProcessing ()
 
void EnableRequestProcessing ()
 
virtual const char * GetServiceClientName () const
 
virtual void SetServiceClientName (const Aws::String &name)
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::Client::AWSJsonClient
virtual AWSError< CoreErrorsBuildAWSError (const std::shared_ptr< Aws::Http::HttpResponse > &response) const override
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeEventStreamRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 
- Protected Member Functions inherited from Aws::Client::AWSClient
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod httpMethod, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, Http::HttpMethod httpMethod, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const Aws::AmazonWebServiceRequest &request, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
virtual void BuildHttpRequest (const Aws::AmazonWebServiceRequest &request, const std::shared_ptr< Aws::Http::HttpRequest > &httpRequest) const
 
const std::shared_ptr< AWSErrorMarshaller > & GetErrorMarshaller () const
 
Aws::Client::AWSAuthSignerGetSignerByName (const char *name) const
 
std::shared_ptr< Aws::Http::HttpRequestBuildAndSignHttpRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method, const char *signerName) const
 
std::shared_ptr< Aws::Http::HttpResponseMakeHttpRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 
- Protected Attributes inherited from Aws::Client::AWSClient
Aws::String m_region
 

Detailed Description

<fullname>Amazon Timestream Query </fullname>

Definition at line 127 of file TimestreamQueryClient.h.

Member Typedef Documentation

◆ BASECLASS

Definition at line 130 of file TimestreamQueryClient.h.

Constructor & Destructor Documentation

◆ TimestreamQueryClient() [1/3]

Aws::TimestreamQuery::TimestreamQueryClient::TimestreamQueryClient ( const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration())

Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ TimestreamQueryClient() [2/3]

Aws::TimestreamQuery::TimestreamQueryClient::TimestreamQueryClient ( const Aws::Auth::AWSCredentials credentials,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration() 
)

Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ TimestreamQueryClient() [3/3]

Aws::TimestreamQuery::TimestreamQueryClient::TimestreamQueryClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration() 
)

Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used

◆ ~TimestreamQueryClient()

virtual Aws::TimestreamQuery::TimestreamQueryClient::~TimestreamQueryClient ( )
virtual

Member Function Documentation

◆ CancelQuery()

virtual Model::CancelQueryOutcome Aws::TimestreamQuery::TimestreamQueryClient::CancelQuery ( const Model::CancelQueryRequest request) const
virtual

Cancels a query that has been issued. Cancellation is provided only if the query has not completed running before the cancellation request was issued. Because cancellation is an idempotent operation, subsequent cancellation requests will return a CancellationMessage, indicating that the query has already been canceled. See code sample for details.

See Also:

AWS API Reference

◆ CancelQueryAsync()

virtual void Aws::TimestreamQuery::TimestreamQueryClient::CancelQueryAsync ( const Model::CancelQueryRequest request,
const CancelQueryResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Cancels a query that has been issued. Cancellation is provided only if the query has not completed running before the cancellation request was issued. Because cancellation is an idempotent operation, subsequent cancellation requests will return a CancellationMessage, indicating that the query has already been canceled. See code sample for details.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ CancelQueryCallable()

virtual Model::CancelQueryOutcomeCallable Aws::TimestreamQuery::TimestreamQueryClient::CancelQueryCallable ( const Model::CancelQueryRequest request) const
virtual

Cancels a query that has been issued. Cancellation is provided only if the query has not completed running before the cancellation request was issued. Because cancellation is an idempotent operation, subsequent cancellation requests will return a CancellationMessage, indicating that the query has already been canceled. See code sample for details.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ CreateScheduledQuery()

virtual Model::CreateScheduledQueryOutcome Aws::TimestreamQuery::TimestreamQueryClient::CreateScheduledQuery ( const Model::CreateScheduledQueryRequest request) const
virtual

Create a scheduled query that will be run on your behalf at the configured schedule. Timestream assumes the execution role provided as part of the ScheduledQueryExecutionRoleArn parameter to run the query. You can use the NotificationConfiguration parameter to configure notification for your scheduled query operations.

See Also:

AWS API Reference

◆ CreateScheduledQueryAsync()

virtual void Aws::TimestreamQuery::TimestreamQueryClient::CreateScheduledQueryAsync ( const Model::CreateScheduledQueryRequest request,
const CreateScheduledQueryResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Create a scheduled query that will be run on your behalf at the configured schedule. Timestream assumes the execution role provided as part of the ScheduledQueryExecutionRoleArn parameter to run the query. You can use the NotificationConfiguration parameter to configure notification for your scheduled query operations.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ CreateScheduledQueryCallable()

virtual Model::CreateScheduledQueryOutcomeCallable Aws::TimestreamQuery::TimestreamQueryClient::CreateScheduledQueryCallable ( const Model::CreateScheduledQueryRequest request) const
virtual

Create a scheduled query that will be run on your behalf at the configured schedule. Timestream assumes the execution role provided as part of the ScheduledQueryExecutionRoleArn parameter to run the query. You can use the NotificationConfiguration parameter to configure notification for your scheduled query operations.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeleteScheduledQuery()

virtual Model::DeleteScheduledQueryOutcome Aws::TimestreamQuery::TimestreamQueryClient::DeleteScheduledQuery ( const Model::DeleteScheduledQueryRequest request) const
virtual

Deletes a given scheduled query. This is an irreversible operation.

See Also:

AWS API Reference

◆ DeleteScheduledQueryAsync()

virtual void Aws::TimestreamQuery::TimestreamQueryClient::DeleteScheduledQueryAsync ( const Model::DeleteScheduledQueryRequest request,
const DeleteScheduledQueryResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deletes a given scheduled query. This is an irreversible operation.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeleteScheduledQueryCallable()

virtual Model::DeleteScheduledQueryOutcomeCallable Aws::TimestreamQuery::TimestreamQueryClient::DeleteScheduledQueryCallable ( const Model::DeleteScheduledQueryRequest request) const
virtual

Deletes a given scheduled query. This is an irreversible operation.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeEndpoints()

virtual Model::DescribeEndpointsOutcome Aws::TimestreamQuery::TimestreamQueryClient::DescribeEndpoints ( const Model::DescribeEndpointsRequest request) const
virtual

DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.

Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, it is not recommended that you use this API unless:

For detailed information on how and when to use and implement DescribeEndpoints, see The Endpoint Discovery Pattern.

See Also:

AWS API Reference

◆ DescribeEndpointsAsync()

virtual void Aws::TimestreamQuery::TimestreamQueryClient::DescribeEndpointsAsync ( const Model::DescribeEndpointsRequest request,
const DescribeEndpointsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.

Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, it is not recommended that you use this API unless:

For detailed information on how and when to use and implement DescribeEndpoints, see The Endpoint Discovery Pattern.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeEndpointsCallable()

virtual Model::DescribeEndpointsOutcomeCallable Aws::TimestreamQuery::TimestreamQueryClient::DescribeEndpointsCallable ( const Model::DescribeEndpointsRequest request) const
virtual

DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.

Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, it is not recommended that you use this API unless:

For detailed information on how and when to use and implement DescribeEndpoints, see The Endpoint Discovery Pattern.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeScheduledQuery()

virtual Model::DescribeScheduledQueryOutcome Aws::TimestreamQuery::TimestreamQueryClient::DescribeScheduledQuery ( const Model::DescribeScheduledQueryRequest request) const
virtual

Provides detailed information about a scheduled query.

See Also:

AWS API Reference

◆ DescribeScheduledQueryAsync()

virtual void Aws::TimestreamQuery::TimestreamQueryClient::DescribeScheduledQueryAsync ( const Model::DescribeScheduledQueryRequest request,
const DescribeScheduledQueryResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Provides detailed information about a scheduled query.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeScheduledQueryCallable()

virtual Model::DescribeScheduledQueryOutcomeCallable Aws::TimestreamQuery::TimestreamQueryClient::DescribeScheduledQueryCallable ( const Model::DescribeScheduledQueryRequest request) const
virtual

Provides detailed information about a scheduled query.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ExecuteScheduledQuery()

virtual Model::ExecuteScheduledQueryOutcome Aws::TimestreamQuery::TimestreamQueryClient::ExecuteScheduledQuery ( const Model::ExecuteScheduledQueryRequest request) const
virtual

You can use this API to run a scheduled query manually.

See Also:

AWS API Reference

◆ ExecuteScheduledQueryAsync()

virtual void Aws::TimestreamQuery::TimestreamQueryClient::ExecuteScheduledQueryAsync ( const Model::ExecuteScheduledQueryRequest request,
const ExecuteScheduledQueryResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

You can use this API to run a scheduled query manually.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ExecuteScheduledQueryCallable()

virtual Model::ExecuteScheduledQueryOutcomeCallable Aws::TimestreamQuery::TimestreamQueryClient::ExecuteScheduledQueryCallable ( const Model::ExecuteScheduledQueryRequest request) const
virtual

You can use this API to run a scheduled query manually.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListScheduledQueries()

virtual Model::ListScheduledQueriesOutcome Aws::TimestreamQuery::TimestreamQueryClient::ListScheduledQueries ( const Model::ListScheduledQueriesRequest request) const
virtual

Gets a list of all scheduled queries in the caller's Amazon account and Region. ListScheduledQueries is eventually consistent.

See Also:

AWS API Reference

◆ ListScheduledQueriesAsync()

virtual void Aws::TimestreamQuery::TimestreamQueryClient::ListScheduledQueriesAsync ( const Model::ListScheduledQueriesRequest request,
const ListScheduledQueriesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Gets a list of all scheduled queries in the caller's Amazon account and Region. ListScheduledQueries is eventually consistent.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListScheduledQueriesCallable()

virtual Model::ListScheduledQueriesOutcomeCallable Aws::TimestreamQuery::TimestreamQueryClient::ListScheduledQueriesCallable ( const Model::ListScheduledQueriesRequest request) const
virtual

Gets a list of all scheduled queries in the caller's Amazon account and Region. ListScheduledQueries is eventually consistent.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListTagsForResource()

virtual Model::ListTagsForResourceOutcome Aws::TimestreamQuery::TimestreamQueryClient::ListTagsForResource ( const Model::ListTagsForResourceRequest request) const
virtual

List all tags on a Timestream query resource.

See Also:

AWS API Reference

◆ ListTagsForResourceAsync()

virtual void Aws::TimestreamQuery::TimestreamQueryClient::ListTagsForResourceAsync ( const Model::ListTagsForResourceRequest request,
const ListTagsForResourceResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

List all tags on a Timestream query resource.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListTagsForResourceCallable()

virtual Model::ListTagsForResourceOutcomeCallable Aws::TimestreamQuery::TimestreamQueryClient::ListTagsForResourceCallable ( const Model::ListTagsForResourceRequest request) const
virtual

List all tags on a Timestream query resource.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ OverrideEndpoint()

void Aws::TimestreamQuery::TimestreamQueryClient::OverrideEndpoint ( const Aws::String endpoint)

◆ PrepareQuery()

virtual Model::PrepareQueryOutcome Aws::TimestreamQuery::TimestreamQueryClient::PrepareQuery ( const Model::PrepareQueryRequest request) const
virtual

A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later running. Timestream only supports using this operation with the PrepareQueryRequest$ValidateOnly set to true.

See Also:

AWS API Reference

◆ PrepareQueryAsync()

virtual void Aws::TimestreamQuery::TimestreamQueryClient::PrepareQueryAsync ( const Model::PrepareQueryRequest request,
const PrepareQueryResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later running. Timestream only supports using this operation with the PrepareQueryRequest$ValidateOnly set to true.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ PrepareQueryCallable()

virtual Model::PrepareQueryOutcomeCallable Aws::TimestreamQuery::TimestreamQueryClient::PrepareQueryCallable ( const Model::PrepareQueryRequest request) const
virtual

A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later running. Timestream only supports using this operation with the PrepareQueryRequest$ValidateOnly set to true.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ Query()

virtual Model::QueryOutcome Aws::TimestreamQuery::TimestreamQueryClient::Query ( const Model::QueryRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ QueryAsync()

virtual void Aws::TimestreamQuery::TimestreamQueryClient::QueryAsync ( const Model::QueryRequest request,
const QueryResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ QueryCallable()

virtual Model::QueryOutcomeCallable Aws::TimestreamQuery::TimestreamQueryClient::QueryCallable ( const Model::QueryRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ TagResource()

virtual Model::TagResourceOutcome Aws::TimestreamQuery::TimestreamQueryClient::TagResource ( const Model::TagResourceRequest request) const
virtual

Associate a set of tags with a Timestream resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking.

See Also:

AWS API Reference

◆ TagResourceAsync()

virtual void Aws::TimestreamQuery::TimestreamQueryClient::TagResourceAsync ( const Model::TagResourceRequest request,
const TagResourceResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Associate a set of tags with a Timestream resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ TagResourceCallable()

virtual Model::TagResourceOutcomeCallable Aws::TimestreamQuery::TimestreamQueryClient::TagResourceCallable ( const Model::TagResourceRequest request) const
virtual

Associate a set of tags with a Timestream resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UntagResource()

virtual Model::UntagResourceOutcome Aws::TimestreamQuery::TimestreamQueryClient::UntagResource ( const Model::UntagResourceRequest request) const
virtual

Removes the association of tags from a Timestream query resource.

See Also:

AWS API Reference

◆ UntagResourceAsync()

virtual void Aws::TimestreamQuery::TimestreamQueryClient::UntagResourceAsync ( const Model::UntagResourceRequest request,
const UntagResourceResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Removes the association of tags from a Timestream query resource.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UntagResourceCallable()

virtual Model::UntagResourceOutcomeCallable Aws::TimestreamQuery::TimestreamQueryClient::UntagResourceCallable ( const Model::UntagResourceRequest request) const
virtual

Removes the association of tags from a Timestream query resource.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UpdateScheduledQuery()

virtual Model::UpdateScheduledQueryOutcome Aws::TimestreamQuery::TimestreamQueryClient::UpdateScheduledQuery ( const Model::UpdateScheduledQueryRequest request) const
virtual

Update a scheduled query.

See Also:

AWS API Reference

◆ UpdateScheduledQueryAsync()

virtual void Aws::TimestreamQuery::TimestreamQueryClient::UpdateScheduledQueryAsync ( const Model::UpdateScheduledQueryRequest request,
const UpdateScheduledQueryResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Update a scheduled query.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UpdateScheduledQueryCallable()

virtual Model::UpdateScheduledQueryOutcomeCallable Aws::TimestreamQuery::TimestreamQueryClient::UpdateScheduledQueryCallable ( const Model::UpdateScheduledQueryRequest request) const
virtual

Update a scheduled query.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.


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