com.amazonaws.services.rdsdata

Interface AWSRDSData

All Known Subinterfaces:

AWSRDSDataAsync

All Known Implementing Classes:

AbstractAWSRDSData, AbstractAWSRDSDataAsync, AWSRDSDataAsyncClient, AWSRDSDataClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSRDSData

Interface for accessing AWS RDS DataService.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSRDSData instead.

RDS Data API

Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora DB cluster. To run these statements, you use the RDS Data API (Data API).

Data API is available with the following types of Aurora databases:

• Aurora PostgreSQL - Serverless v2, Serverless v1, and provisioned

• Aurora MySQL - Serverless v1 only

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
BatchExecuteStatementResult	batchExecuteStatement(BatchExecuteStatementRequest batchExecuteStatementRequest) Runs a batch SQL statement over an array of data.
BeginTransactionResult	beginTransaction(BeginTransactionRequest beginTransactionRequest) Starts a SQL transaction.
CommitTransactionResult	commitTransaction(CommitTransactionRequest commitTransactionRequest) Ends a SQL transaction started with the BeginTransaction operation and commits the changes.
ExecuteSqlResult	executeSql(ExecuteSqlRequest executeSqlRequest) Deprecated.
ExecuteStatementResult	executeStatement(ExecuteStatementRequest executeStatementRequest) Runs a SQL statement against a database.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
RollbackTransactionResult	rollbackTransaction(RollbackTransactionRequest rollbackTransactionRequest) Performs a rollback of a transaction.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

batchExecuteStatement

BatchExecuteStatementResult batchExecuteStatement(BatchExecuteStatementRequest batchExecuteStatementRequest)

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.

There isn't a fixed upper limit on the number of parameter sets. However, the maximum size of the HTTP request submitted through the Data API is 4 MiB. If the request exceeds this limit, the Data API returns an error and doesn't process the request. This 4-MiB limit includes the size of the HTTP headers and the JSON notation in the request. Thus, the number of parameter sets that you can include depends on a combination of factors, such as the size of the SQL statement and the size of each parameter set.

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

Parameters:

batchExecuteStatementRequest - The request parameters represent the input of a SQL statement over an array of data.

Returns:

Result of the BatchExecuteStatement operation returned by the service.

Throws:

SecretsErrorException - There was a problem with the Secrets Manager secret used with the request, caused by one of the following conditions:

• RDS Data API timed out retrieving the secret.

• The secret provided wasn't found.

• The secret couldn't be decrypted.

HttpEndpointNotEnabledException - The HTTP endpoint for using RDS Data API isn't enabled for the DB cluster.

DatabaseErrorException - There was an error in processing the SQL statement.

DatabaseUnavailableException - The writer instance in the DB cluster isn't available.

TransactionNotFoundException - The transaction ID wasn't found.

InvalidSecretException - The Secrets Manager secret used with the request isn't valid.

ServiceUnavailableErrorException - The service specified by the resourceArn parameter isn't available.

ForbiddenException - There are insufficient privileges to make the call.

DatabaseNotFoundException - The DB cluster doesn't have a DB instance.

AccessDeniedException - You don't have sufficient access to perform this action.

BadRequestException - There is an error in the call or in a SQL statement. (This error only appears in calls from Aurora Serverless v1 databases.)

StatementTimeoutException - The execution of the SQL statement timed out.

InternalServerErrorException - An internal error occurred.

See Also:

AWS API Documentation

beginTransaction

BeginTransactionResult beginTransaction(BeginTransactionRequest beginTransactionRequest)

Starts a SQL transaction.

A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24 hours.

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.

DDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate ExecuteStatement call with continueAfterTimeout enabled.

Parameters:

beginTransactionRequest - The request parameters represent the input of a request to start a SQL transaction.

Returns:

Result of the BeginTransaction operation returned by the service.

Throws:

SecretsErrorException - There was a problem with the Secrets Manager secret used with the request, caused by one of the following conditions:

• RDS Data API timed out retrieving the secret.

• The secret provided wasn't found.

• The secret couldn't be decrypted.

HttpEndpointNotEnabledException - The HTTP endpoint for using RDS Data API isn't enabled for the DB cluster.

DatabaseErrorException - There was an error in processing the SQL statement.

DatabaseUnavailableException - The writer instance in the DB cluster isn't available.

TransactionNotFoundException - The transaction ID wasn't found.

InvalidSecretException - The Secrets Manager secret used with the request isn't valid.

ServiceUnavailableErrorException - The service specified by the resourceArn parameter isn't available.

ForbiddenException - There are insufficient privileges to make the call.

DatabaseNotFoundException - The DB cluster doesn't have a DB instance.

AccessDeniedException - You don't have sufficient access to perform this action.

BadRequestException - There is an error in the call or in a SQL statement. (This error only appears in calls from Aurora Serverless v1 databases.)

StatementTimeoutException - The execution of the SQL statement timed out.

InternalServerErrorException - An internal error occurred.

See Also:

AWS API Documentation

commitTransaction

CommitTransactionResult commitTransaction(CommitTransactionRequest commitTransactionRequest)

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

Parameters:

commitTransactionRequest - The request parameters represent the input of a commit transaction request.

Returns:

Result of the CommitTransaction operation returned by the service.

Throws:

SecretsErrorException - There was a problem with the Secrets Manager secret used with the request, caused by one of the following conditions:

• RDS Data API timed out retrieving the secret.

• The secret provided wasn't found.

• The secret couldn't be decrypted.

HttpEndpointNotEnabledException - The HTTP endpoint for using RDS Data API isn't enabled for the DB cluster.

DatabaseErrorException - There was an error in processing the SQL statement.

DatabaseUnavailableException - The writer instance in the DB cluster isn't available.

TransactionNotFoundException - The transaction ID wasn't found.

InvalidSecretException - The Secrets Manager secret used with the request isn't valid.

ServiceUnavailableErrorException - The service specified by the resourceArn parameter isn't available.

ForbiddenException - There are insufficient privileges to make the call.

DatabaseNotFoundException - The DB cluster doesn't have a DB instance.

AccessDeniedException - You don't have sufficient access to perform this action.

BadRequestException - There is an error in the call or in a SQL statement. (This error only appears in calls from Aurora Serverless v1 databases.)

StatementTimeoutException - The execution of the SQL statement timed out.

InternalServerErrorException - An internal error occurred.

NotFoundException - The resourceArn, secretArn, or transactionId value can't be found.

See Also:

AWS API Documentation

executeSql

@Deprecated
ExecuteSqlResult executeSql(ExecuteSqlRequest executeSqlRequest)

Deprecated.

Runs one or more SQL statements.

This operation isn't supported for Aurora PostgreSQL Serverless v2 and provisioned DB clusters, and for Aurora Serverless v1 DB clusters, the operation is deprecated. Use the BatchExecuteStatement or ExecuteStatement operation.

Parameters:

executeSqlRequest - The request parameters represent the input of a request to run one or more SQL statements.

Returns:

Result of the ExecuteSql operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this action.

BadRequestException - There is an error in the call or in a SQL statement. (This error only appears in calls from Aurora Serverless v1 databases.)

InternalServerErrorException - An internal error occurred.

ForbiddenException - There are insufficient privileges to make the call.

ServiceUnavailableErrorException - The service specified by the resourceArn parameter isn't available.

See Also:

AWS API Documentation

executeStatement

ExecuteStatementResult executeStatement(ExecuteStatementRequest executeStatementRequest)

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.

If the binary response data from the database is more than 1 MB, the call is terminated.

Parameters:

executeStatementRequest - The request parameters represent the input of a request to run a SQL statement against a database.

Returns:

Result of the ExecuteStatement operation returned by the service.

Throws:

SecretsErrorException - There was a problem with the Secrets Manager secret used with the request, caused by one of the following conditions:

• RDS Data API timed out retrieving the secret.

• The secret provided wasn't found.

• The secret couldn't be decrypted.

HttpEndpointNotEnabledException - The HTTP endpoint for using RDS Data API isn't enabled for the DB cluster.

DatabaseErrorException - There was an error in processing the SQL statement.

DatabaseUnavailableException - The writer instance in the DB cluster isn't available.

TransactionNotFoundException - The transaction ID wasn't found.

InvalidSecretException - The Secrets Manager secret used with the request isn't valid.

ServiceUnavailableErrorException - The service specified by the resourceArn parameter isn't available.

ForbiddenException - There are insufficient privileges to make the call.

DatabaseNotFoundException - The DB cluster doesn't have a DB instance.

AccessDeniedException - You don't have sufficient access to perform this action.

BadRequestException - There is an error in the call or in a SQL statement. (This error only appears in calls from Aurora Serverless v1 databases.)

StatementTimeoutException - The execution of the SQL statement timed out.

InternalServerErrorException - An internal error occurred.

UnsupportedResultException - There was a problem with the result because of one of the following conditions:

• It contained an unsupported data type.

• It contained a multidimensional array.

• The size was too large.

See Also:

AWS API Documentation

rollbackTransaction

RollbackTransactionResult rollbackTransaction(RollbackTransactionRequest rollbackTransactionRequest)

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

Parameters:

rollbackTransactionRequest - The request parameters represent the input of a request to perform a rollback of a transaction.

Returns:

Result of the RollbackTransaction operation returned by the service.

Throws:

SecretsErrorException - There was a problem with the Secrets Manager secret used with the request, caused by one of the following conditions:

• RDS Data API timed out retrieving the secret.

• The secret provided wasn't found.

• The secret couldn't be decrypted.

HttpEndpointNotEnabledException - The HTTP endpoint for using RDS Data API isn't enabled for the DB cluster.

DatabaseErrorException - There was an error in processing the SQL statement.

DatabaseUnavailableException - The writer instance in the DB cluster isn't available.

TransactionNotFoundException - The transaction ID wasn't found.

InvalidSecretException - The Secrets Manager secret used with the request isn't valid.

ServiceUnavailableErrorException - The service specified by the resourceArn parameter isn't available.

ForbiddenException - There are insufficient privileges to make the call.

DatabaseNotFoundException - The DB cluster doesn't have a DB instance.

AccessDeniedException - You don't have sufficient access to perform this action.

BadRequestException - There is an error in the call or in a SQL statement. (This error only appears in calls from Aurora Serverless v1 databases.)

StatementTimeoutException - The execution of the SQL statement timed out.

InternalServerErrorException - An internal error occurred.

NotFoundException - The resourceArn, secretArn, or transactionId value can't be found.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.