software.amazon.awssdk.services.rdsdata

Interface RdsDataClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface RdsDataClient
extends SdkClient

Service client for accessing AWS RDS DataService. This can be created using the static builder() method. AWS RDS DataService provides Http Endpoint to query RDS databases.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static RdsDataClientBuilder	builder() Create a builder that can be used to configure and create a RdsDataClient.
static RdsDataClient	create() Create a RdsDataClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default ExecuteSqlResponse	executeSql(Consumer<ExecuteSqlRequest.Builder> executeSqlRequest) Executes any SQL statement on the target database synchronously
default ExecuteSqlResponse	executeSql(ExecuteSqlRequest executeSqlRequest) Executes any SQL statement on the target database synchronously
static ServiceMetadata	serviceMetadata()

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static RdsDataClient create()

Create a RdsDataClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static RdsDataClientBuilder builder()

Create a builder that can be used to configure and create a RdsDataClient.

executeSql

default ExecuteSqlResponse executeSql(ExecuteSqlRequest executeSqlRequest)
                               throws BadRequestException,
                                      ForbiddenException,
                                      InternalServerErrorException,
                                      ServiceUnavailableErrorException,
                                      AwsServiceException,
                                      SdkClientException,
                                      RdsDataException

Executes any SQL statement on the target database synchronously

Parameters:

executeSqlRequest - Execute SQL Request

Returns:

Result of the ExecuteSql operation returned by the service.

Throws:

BadRequestException - Invalid Request exception

ForbiddenException - Access denied exception

InternalServerErrorException - Internal service error

ServiceUnavailableErrorException - Internal service unavailable error

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

RdsDataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

executeSql

default ExecuteSqlResponse executeSql(Consumer<ExecuteSqlRequest.Builder> executeSqlRequest)
                               throws BadRequestException,
                                      ForbiddenException,
                                      InternalServerErrorException,
                                      ServiceUnavailableErrorException,
                                      AwsServiceException,
                                      SdkClientException,
                                      RdsDataException

Executes any SQL statement on the target database synchronously

This is a convenience which creates an instance of the ExecuteSqlRequest.Builder avoiding the need to create one manually via ExecuteSqlRequest.builder()

Parameters:

executeSqlRequest - A Consumer that will call methods on ExecuteSqlRequest.Builder to create a request. Execute SQL Request

Returns:

Result of the ExecuteSql operation returned by the service.

Throws:

BadRequestException - Invalid Request exception

ForbiddenException - Access denied exception

InternalServerErrorException - Internal service error

ServiceUnavailableErrorException - Internal service unavailable error

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

RdsDataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()