AWS SDK for C++  1.8.95
AWS SDK for C++
Public Types | Public Member Functions | List of all members
Aws::RDSDataService::RDSDataServiceClient Class Reference

#include <RDSDataServiceClient.h>

+ Inheritance diagram for Aws::RDSDataService::RDSDataServiceClient:

Public Types

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

Public Member Functions

 RDSDataServiceClient (const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 RDSDataServiceClient (const Aws::Auth::AWSCredentials &credentials, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 RDSDataServiceClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
virtual ~RDSDataServiceClient ()
 
virtual Model::BatchExecuteStatementOutcome BatchExecuteStatement (const Model::BatchExecuteStatementRequest &request) const
 
virtual Model::BatchExecuteStatementOutcomeCallable BatchExecuteStatementCallable (const Model::BatchExecuteStatementRequest &request) const
 
virtual void BatchExecuteStatementAsync (const Model::BatchExecuteStatementRequest &request, const BatchExecuteStatementResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::BeginTransactionOutcome BeginTransaction (const Model::BeginTransactionRequest &request) const
 
virtual Model::BeginTransactionOutcomeCallable BeginTransactionCallable (const Model::BeginTransactionRequest &request) const
 
virtual void BeginTransactionAsync (const Model::BeginTransactionRequest &request, const BeginTransactionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::CommitTransactionOutcome CommitTransaction (const Model::CommitTransactionRequest &request) const
 
virtual Model::CommitTransactionOutcomeCallable CommitTransactionCallable (const Model::CommitTransactionRequest &request) const
 
virtual void CommitTransactionAsync (const Model::CommitTransactionRequest &request, const CommitTransactionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ExecuteStatementOutcome ExecuteStatement (const Model::ExecuteStatementRequest &request) const
 
virtual Model::ExecuteStatementOutcomeCallable ExecuteStatementCallable (const Model::ExecuteStatementRequest &request) const
 
virtual void ExecuteStatementAsync (const Model::ExecuteStatementRequest &request, const ExecuteStatementResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::RollbackTransactionOutcome RollbackTransaction (const Model::RollbackTransactionRequest &request) const
 
virtual Model::RollbackTransactionOutcomeCallable RollbackTransactionCallable (const Model::RollbackTransactionRequest &request) const
 
virtual void RollbackTransactionAsync (const Model::RollbackTransactionRequest &request, const RollbackTransactionResponseReceivedHandler &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 (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 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 RDS Data Service</fullname>

Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora Serverless DB cluster. To run these statements, you work with the Data Service API.

For more information about the Data Service API, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.

If you have questions or comments related to the Data API, send email to Rds-data-api-feedback@amazon.com.

Definition at line 97 of file RDSDataServiceClient.h.

Member Typedef Documentation

◆ BASECLASS

Definition at line 100 of file RDSDataServiceClient.h.

Constructor & Destructor Documentation

◆ RDSDataServiceClient() [1/3]

Aws::RDSDataService::RDSDataServiceClient::RDSDataServiceClient ( 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.

◆ RDSDataServiceClient() [2/3]

Aws::RDSDataService::RDSDataServiceClient::RDSDataServiceClient ( 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.

◆ RDSDataServiceClient() [3/3]

Aws::RDSDataService::RDSDataServiceClient::RDSDataServiceClient ( 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

◆ ~RDSDataServiceClient()

virtual Aws::RDSDataService::RDSDataServiceClient::~RDSDataServiceClient ( )
virtual

Member Function Documentation

◆ BatchExecuteStatement()

virtual Model::BatchExecuteStatementOutcome Aws::RDSDataService::RDSDataServiceClient::BatchExecuteStatement ( const Model::BatchExecuteStatementRequest request) const
virtual

Runs a batch SQL statement over an array of data.

You can run bulk update and insert operations for multiple records using a DML statement with different parameter sets. Bulk operations can provide a significant performance improvement over individual insert and update operations.

If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically.

See Also:

AWS API Reference

◆ BatchExecuteStatementAsync()

virtual void Aws::RDSDataService::RDSDataServiceClient::BatchExecuteStatementAsync ( const Model::BatchExecuteStatementRequest request,
const BatchExecuteStatementResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Runs a batch SQL statement over an array of data.

You can run bulk update and insert operations for multiple records using a DML statement with different parameter sets. Bulk operations can provide a significant performance improvement over individual insert and update operations.

If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically.

See Also:

AWS API Reference

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

◆ BatchExecuteStatementCallable()

virtual Model::BatchExecuteStatementOutcomeCallable Aws::RDSDataService::RDSDataServiceClient::BatchExecuteStatementCallable ( const Model::BatchExecuteStatementRequest request) const
virtual

Runs a batch SQL statement over an array of data.

You can run bulk update and insert operations for multiple records using a DML statement with different parameter sets. Bulk operations can provide a significant performance improvement over individual insert and update operations.

If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically.

See Also:

AWS API Reference

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

◆ BeginTransaction()

virtual Model::BeginTransactionOutcome Aws::RDSDataService::RDSDataServiceClient::BeginTransaction ( const Model::BeginTransactionRequest request) const
virtual

Starts a SQL transaction.

 <important> <p>A
transaction can run for a maximum of 24 hours. A transaction is terminated and
rolled back automatically after 24 hours.</p> <p>A transaction times
out if no calls use its transaction ID in three minutes. If a transaction times
out before it's committed, it's rolled back automatically.</p>
<p>DDL statements inside a transaction cause an implicit commit. We
recommend that you run each DDL statement in a separate
<code>ExecuteStatement</code> call with
<code>continueAfterTimeout</code> enabled.</p>
</important> 

See Also:

AWS API Reference

◆ BeginTransactionAsync()

virtual void Aws::RDSDataService::RDSDataServiceClient::BeginTransactionAsync ( const Model::BeginTransactionRequest request,
const BeginTransactionResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Starts a SQL transaction.

 <important> <p>A
transaction can run for a maximum of 24 hours. A transaction is terminated and
rolled back automatically after 24 hours.</p> <p>A transaction times
out if no calls use its transaction ID in three minutes. If a transaction times
out before it's committed, it's rolled back automatically.</p>
<p>DDL statements inside a transaction cause an implicit commit. We
recommend that you run each DDL statement in a separate
<code>ExecuteStatement</code> call with
<code>continueAfterTimeout</code> enabled.</p>
</important> 

See Also:

AWS API Reference

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

◆ BeginTransactionCallable()

virtual Model::BeginTransactionOutcomeCallable Aws::RDSDataService::RDSDataServiceClient::BeginTransactionCallable ( const Model::BeginTransactionRequest request) const
virtual

Starts a SQL transaction.

 <important> <p>A
transaction can run for a maximum of 24 hours. A transaction is terminated and
rolled back automatically after 24 hours.</p> <p>A transaction times
out if no calls use its transaction ID in three minutes. If a transaction times
out before it's committed, it's rolled back automatically.</p>
<p>DDL statements inside a transaction cause an implicit commit. We
recommend that you run each DDL statement in a separate
<code>ExecuteStatement</code> call with
<code>continueAfterTimeout</code> enabled.</p>
</important> 

See Also:

AWS API Reference

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

◆ CommitTransaction()

virtual Model::CommitTransactionOutcome Aws::RDSDataService::RDSDataServiceClient::CommitTransaction ( const Model::CommitTransactionRequest request) const
virtual

Ends a SQL transaction started with the BeginTransaction operation and commits the changes.

See Also:

AWS API Reference

◆ CommitTransactionAsync()

virtual void Aws::RDSDataService::RDSDataServiceClient::CommitTransactionAsync ( const Model::CommitTransactionRequest request,
const CommitTransactionResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Ends a SQL transaction started with the BeginTransaction operation and commits the changes.

See Also:

AWS API Reference

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

◆ CommitTransactionCallable()

virtual Model::CommitTransactionOutcomeCallable Aws::RDSDataService::RDSDataServiceClient::CommitTransactionCallable ( const Model::CommitTransactionRequest request) const
virtual

Ends a SQL transaction started with the BeginTransaction operation and commits the changes.

See Also:

AWS API Reference

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

◆ ExecuteStatement()

virtual Model::ExecuteStatementOutcome Aws::RDSDataService::RDSDataServiceClient::ExecuteStatement ( const Model::ExecuteStatementRequest request) const
virtual

Runs a SQL statement against a database.

If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically.

The response size limit is 1 MB. If the call returns more than 1 MB of response data, the call is terminated.

See Also:

AWS API Reference

◆ ExecuteStatementAsync()

virtual void Aws::RDSDataService::RDSDataServiceClient::ExecuteStatementAsync ( const Model::ExecuteStatementRequest request,
const ExecuteStatementResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Runs a SQL statement against a database.

If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically.

The response size limit is 1 MB. If the call returns more than 1 MB of response data, the call is terminated.

See Also:

AWS API Reference

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

◆ ExecuteStatementCallable()

virtual Model::ExecuteStatementOutcomeCallable Aws::RDSDataService::RDSDataServiceClient::ExecuteStatementCallable ( const Model::ExecuteStatementRequest request) const
virtual

Runs a SQL statement against a database.

If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically.

The response size limit is 1 MB. If the call returns more than 1 MB of response data, the call is terminated.

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::RDSDataService::RDSDataServiceClient::OverrideEndpoint ( const Aws::String endpoint)

◆ RollbackTransaction()

virtual Model::RollbackTransactionOutcome Aws::RDSDataService::RDSDataServiceClient::RollbackTransaction ( const Model::RollbackTransactionRequest request) const
virtual

Performs a rollback of a transaction. Rolling back a transaction cancels its changes.

See Also:

AWS API Reference

◆ RollbackTransactionAsync()

virtual void Aws::RDSDataService::RDSDataServiceClient::RollbackTransactionAsync ( const Model::RollbackTransactionRequest request,
const RollbackTransactionResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Performs a rollback of a transaction. Rolling back a transaction cancels its changes.

See Also:

AWS API Reference

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

◆ RollbackTransactionCallable()

virtual Model::RollbackTransactionOutcomeCallable Aws::RDSDataService::RDSDataServiceClient::RollbackTransactionCallable ( const Model::RollbackTransactionRequest request) const
virtual

Performs a rollback of a transaction. Rolling back a transaction cancels its changes.

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: