Package software.amazon.awssdk.services.dsql

Interface DsqlClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface DsqlClient
extends AwsClient

Service client for accessing Amazon Aurora DSQL. This can be created using the static builder() method.

This is an interface reference for Amazon Aurora DSQL. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Aurora DSQL.

Amazon Aurora DSQL is a serverless, distributed SQL database suitable for workloads of any size. Aurora DSQL is available in both single-Region and multi-Region configurations, so your clusters and databases are always available even if an Availability Zone or an Amazon Web Services Region are unavailable. Aurora DSQL lets you focus on using your data to acquire new insights for your business and customers.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static DsqlClientBuilder	builder()	Create a builder that can be used to configure and create a DsqlClient.
static DsqlClient	create()	Create a DsqlClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateClusterResponse	createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)	Creates a cluster in Amazon Aurora DSQL.
default CreateClusterResponse	createCluster(CreateClusterRequest createClusterRequest)	Creates a cluster in Amazon Aurora DSQL.
default CreateMultiRegionClustersResponse	createMultiRegionClusters(Consumer<CreateMultiRegionClustersRequest.Builder> createMultiRegionClustersRequest)	Creates multi-Region clusters in Amazon Aurora DSQL.
default CreateMultiRegionClustersResponse	createMultiRegionClusters(CreateMultiRegionClustersRequest createMultiRegionClustersRequest)	Creates multi-Region clusters in Amazon Aurora DSQL.
default DeleteClusterResponse	deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)	Deletes a cluster in Amazon Aurora DSQL.
default DeleteClusterResponse	deleteCluster(DeleteClusterRequest deleteClusterRequest)	Deletes a cluster in Amazon Aurora DSQL.
default DeleteMultiRegionClustersResponse	deleteMultiRegionClusters(Consumer<DeleteMultiRegionClustersRequest.Builder> deleteMultiRegionClustersRequest)	Deletes a multi-Region cluster in Amazon Aurora DSQL.
default DeleteMultiRegionClustersResponse	deleteMultiRegionClusters(DeleteMultiRegionClustersRequest deleteMultiRegionClustersRequest)	Deletes a multi-Region cluster in Amazon Aurora DSQL.
default GetClusterResponse	getCluster(Consumer<GetClusterRequest.Builder> getClusterRequest)	Retrieves information about a cluster.
default GetClusterResponse	getCluster(GetClusterRequest getClusterRequest)	Retrieves information about a cluster.
default ListClustersResponse	listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)	Retrieves information about a list of clusters.
default ListClustersResponse	listClusters(ListClustersRequest listClustersRequest)	Retrieves information about a list of clusters.
default ListClustersIterable	listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest)	This is a variant of listClusters(software.amazon.awssdk.services.dsql.model.ListClustersRequest) operation.
default ListClustersIterable	listClustersPaginator(ListClustersRequest listClustersRequest)	This is a variant of listClusters(software.amazon.awssdk.services.dsql.model.ListClustersRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists all of the tags for a resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists all of the tags for a resource.
default DsqlServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Tags a resource with a map of key and value pairs.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Tags a resource with a map of key and value pairs.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes a tag from a resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes a tag from a resource.
default UpdateClusterResponse	updateCluster(Consumer<UpdateClusterRequest.Builder> updateClusterRequest)	Updates a cluster.
default UpdateClusterResponse	updateCluster(UpdateClusterRequest updateClusterRequest)	Updates a cluster.
default DsqlUtilities	utilities()	Creates an instance of DsqlUtilities object with the configuration set on this client.
default DsqlWaiter	waiter()	Create an instance of DsqlWaiter using this client.

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

close

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

serviceName

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

createCluster

default CreateClusterResponse createCluster(CreateClusterRequest createClusterRequest)
                                     throws ServiceQuotaExceededException,
                                            ThrottlingException,
                                            AccessDeniedException,
                                            ValidationException,
                                            InternalServerException,
                                            ConflictException,
                                            AwsServiceException,
                                            SdkClientException,
                                            DsqlException

Creates a cluster in Amazon Aurora DSQL.

Parameters:

createClusterRequest -

Returns:

Result of the CreateCluster operation returned by the service.

Throws:

ServiceQuotaExceededException - The service limit was exceeded.

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You do not have sufficient access to perform this action.

ValidationException - The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ConflictException - The submitted action has conflicts.

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.

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

AwsServiceException

See Also:

AWS API Documentation

createCluster

default CreateClusterResponse createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)
                                     throws ServiceQuotaExceededException,
                                            ThrottlingException,
                                            AccessDeniedException,
                                            ValidationException,
                                            InternalServerException,
                                            ConflictException,
                                            AwsServiceException,
                                            SdkClientException,
                                            DsqlException

Creates a cluster in Amazon Aurora DSQL.

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

Parameters:

createClusterRequest - A Consumer that will call methods on CreateClusterRequest.Builder to create a request.

Returns:

Result of the CreateCluster operation returned by the service.

Throws:

ServiceQuotaExceededException - The service limit was exceeded.

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You do not have sufficient access to perform this action.

ValidationException - The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ConflictException - The submitted action has conflicts.

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.

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

AwsServiceException

See Also:

AWS API Documentation

createMultiRegionClusters

default CreateMultiRegionClustersResponse createMultiRegionClusters(CreateMultiRegionClustersRequest createMultiRegionClustersRequest)
                                                             throws ServiceQuotaExceededException,
                                                                    ThrottlingException,
                                                                    AccessDeniedException,
                                                                    ValidationException,
                                                                    InternalServerException,
                                                                    ConflictException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    DsqlException

Creates multi-Region clusters in Amazon Aurora DSQL. Multi-Region clusters require a linked Region list, which is an array of the Regions in which you want to create linked clusters. Multi-Region clusters require a witness Region, which participates in quorum in failure scenarios.

Parameters:

createMultiRegionClustersRequest -

Returns:

Result of the CreateMultiRegionClusters operation returned by the service.

Throws:

ServiceQuotaExceededException - The service limit was exceeded.

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You do not have sufficient access to perform this action.

ValidationException - The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ConflictException - The submitted action has conflicts.

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.

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

AwsServiceException

See Also:

AWS API Documentation

createMultiRegionClusters

default CreateMultiRegionClustersResponse createMultiRegionClusters(Consumer<CreateMultiRegionClustersRequest.Builder> createMultiRegionClustersRequest)
                                                             throws ServiceQuotaExceededException,
                                                                    ThrottlingException,
                                                                    AccessDeniedException,
                                                                    ValidationException,
                                                                    InternalServerException,
                                                                    ConflictException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    DsqlException

Creates multi-Region clusters in Amazon Aurora DSQL. Multi-Region clusters require a linked Region list, which is an array of the Regions in which you want to create linked clusters. Multi-Region clusters require a witness Region, which participates in quorum in failure scenarios.

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

Parameters:

createMultiRegionClustersRequest - A Consumer that will call methods on CreateMultiRegionClustersRequest.Builder to create a request.

Returns:

Result of the CreateMultiRegionClusters operation returned by the service.

Throws:

ServiceQuotaExceededException - The service limit was exceeded.

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You do not have sufficient access to perform this action.

ValidationException - The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ConflictException - The submitted action has conflicts.

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.

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

AwsServiceException

See Also:

AWS API Documentation

deleteCluster

default DeleteClusterResponse deleteCluster(DeleteClusterRequest deleteClusterRequest)
                                     throws ThrottlingException,
                                            AccessDeniedException,
                                            ValidationException,
                                            InternalServerException,
                                            ResourceNotFoundException,
                                            ConflictException,
                                            AwsServiceException,
                                            SdkClientException,
                                            DsqlException

Deletes a cluster in Amazon Aurora DSQL.

Parameters:

deleteClusterRequest -

Returns:

Result of the DeleteCluster operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You do not have sufficient access to perform this action.

ValidationException - The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The resource could not be found.

ConflictException - The submitted action has conflicts.

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.

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

AwsServiceException

See Also:

AWS API Documentation

deleteCluster

default DeleteClusterResponse deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)
                                     throws ThrottlingException,
                                            AccessDeniedException,
                                            ValidationException,
                                            InternalServerException,
                                            ResourceNotFoundException,
                                            ConflictException,
                                            AwsServiceException,
                                            SdkClientException,
                                            DsqlException

Deletes a cluster in Amazon Aurora DSQL.

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

Parameters:

deleteClusterRequest - A Consumer that will call methods on DeleteClusterRequest.Builder to create a request.

Returns:

Result of the DeleteCluster operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You do not have sufficient access to perform this action.

ValidationException - The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The resource could not be found.

ConflictException - The submitted action has conflicts.

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.

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

AwsServiceException

See Also:

AWS API Documentation

deleteMultiRegionClusters

default DeleteMultiRegionClustersResponse deleteMultiRegionClusters(DeleteMultiRegionClustersRequest deleteMultiRegionClustersRequest)
                                                             throws ThrottlingException,
                                                                    AccessDeniedException,
                                                                    ValidationException,
                                                                    InternalServerException,
                                                                    ResourceNotFoundException,
                                                                    ConflictException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    DsqlException

Deletes a multi-Region cluster in Amazon Aurora DSQL.

Parameters:

deleteMultiRegionClustersRequest -

Returns:

Result of the DeleteMultiRegionClusters operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You do not have sufficient access to perform this action.

ValidationException - The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The resource could not be found.

ConflictException - The submitted action has conflicts.

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.

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

AwsServiceException

See Also:

AWS API Documentation

deleteMultiRegionClusters

default DeleteMultiRegionClustersResponse deleteMultiRegionClusters(Consumer<DeleteMultiRegionClustersRequest.Builder> deleteMultiRegionClustersRequest)
                                                             throws ThrottlingException,
                                                                    AccessDeniedException,
                                                                    ValidationException,
                                                                    InternalServerException,
                                                                    ResourceNotFoundException,
                                                                    ConflictException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    DsqlException

Deletes a multi-Region cluster in Amazon Aurora DSQL.

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

Parameters:

deleteMultiRegionClustersRequest - A Consumer that will call methods on DeleteMultiRegionClustersRequest.Builder to create a request.

Returns:

Result of the DeleteMultiRegionClusters operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You do not have sufficient access to perform this action.

ValidationException - The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The resource could not be found.

ConflictException - The submitted action has conflicts.

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.

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

AwsServiceException

See Also:

AWS API Documentation

getCluster

default GetClusterResponse getCluster(GetClusterRequest getClusterRequest)
                               throws ThrottlingException,
                                      AccessDeniedException,
                                      ValidationException,
                                      InternalServerException,
                                      ResourceNotFoundException,
                                      AwsServiceException,
                                      SdkClientException,
                                      DsqlException

Retrieves information about a cluster.

Parameters:

getClusterRequest -

Returns:

Result of the GetCluster operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You do not have sufficient access to perform this action.

ValidationException - The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The resource could not be found.

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.

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

AwsServiceException

See Also:

AWS API Documentation

getCluster

default GetClusterResponse getCluster(Consumer<GetClusterRequest.Builder> getClusterRequest)
                               throws ThrottlingException,
                                      AccessDeniedException,
                                      ValidationException,
                                      InternalServerException,
                                      ResourceNotFoundException,
                                      AwsServiceException,
                                      SdkClientException,
                                      DsqlException

Retrieves information about a cluster.

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

Parameters:

getClusterRequest - A Consumer that will call methods on GetClusterRequest.Builder to create a request.

Returns:

Result of the GetCluster operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You do not have sufficient access to perform this action.

ValidationException - The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The resource could not be found.

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.

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

AwsServiceException

See Also:

AWS API Documentation

listClusters

default ListClustersResponse listClusters(ListClustersRequest listClustersRequest)
                                   throws ThrottlingException,
                                          AccessDeniedException,
                                          ValidationException,
                                          InternalServerException,
                                          ResourceNotFoundException,
                                          AwsServiceException,
                                          SdkClientException,
                                          DsqlException

Retrieves information about a list of clusters.

Parameters:

listClustersRequest -

Returns:

Result of the ListClusters operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You do not have sufficient access to perform this action.

ValidationException - The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The resource could not be found.

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.

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

AwsServiceException

See Also:

AWS API Documentation

listClusters

default ListClustersResponse listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)
                                   throws ThrottlingException,
                                          AccessDeniedException,
                                          ValidationException,
                                          InternalServerException,
                                          ResourceNotFoundException,
                                          AwsServiceException,
                                          SdkClientException,
                                          DsqlException

Retrieves information about a list of clusters.

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

Parameters:

listClustersRequest - A Consumer that will call methods on ListClustersRequest.Builder to create a request.

Returns:

Result of the ListClusters operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You do not have sufficient access to perform this action.

ValidationException - The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The resource could not be found.

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.

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

AwsServiceException

See Also:

AWS API Documentation

listClustersPaginator

default ListClustersIterable listClustersPaginator(ListClustersRequest listClustersRequest)
                                            throws ThrottlingException,
                                                   AccessDeniedException,
                                                   ValidationException,
                                                   InternalServerException,
                                                   ResourceNotFoundException,
                                                   AwsServiceException,
                                                   SdkClientException,
                                                   DsqlException

This is a variant of listClusters(software.amazon.awssdk.services.dsql.model.ListClustersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.dsql.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.dsql.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
     for (software.amazon.awssdk.services.dsql.model.ListClustersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.dsql.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listClusters(software.amazon.awssdk.services.dsql.model.ListClustersRequest) operation.

Parameters:

listClustersRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You do not have sufficient access to perform this action.

ValidationException - The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The resource could not be found.

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.

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

AwsServiceException

See Also:

AWS API Documentation

listClustersPaginator

default ListClustersIterable listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest)
                                            throws ThrottlingException,
                                                   AccessDeniedException,
                                                   ValidationException,
                                                   InternalServerException,
                                                   ResourceNotFoundException,
                                                   AwsServiceException,
                                                   SdkClientException,
                                                   DsqlException

This is a variant of listClusters(software.amazon.awssdk.services.dsql.model.ListClustersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.dsql.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.dsql.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
     for (software.amazon.awssdk.services.dsql.model.ListClustersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.dsql.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listClusters(software.amazon.awssdk.services.dsql.model.ListClustersRequest) operation.

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

Parameters:

listClustersRequest - A Consumer that will call methods on ListClustersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You do not have sufficient access to perform this action.

ValidationException - The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The resource could not be found.

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.

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

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ThrottlingException,
                                                        AccessDeniedException,
                                                        ValidationException,
                                                        InternalServerException,
                                                        ResourceNotFoundException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        DsqlException

Lists all of the tags for a resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You do not have sufficient access to perform this action.

ValidationException - The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The resource could not be found.

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.

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

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ThrottlingException,
                                                        AccessDeniedException,
                                                        ValidationException,
                                                        InternalServerException,
                                                        ResourceNotFoundException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        DsqlException

Lists all of the tags for a resource.

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

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You do not have sufficient access to perform this action.

ValidationException - The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The resource could not be found.

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.

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

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ServiceQuotaExceededException,
                                        ThrottlingException,
                                        AccessDeniedException,
                                        ValidationException,
                                        InternalServerException,
                                        ResourceNotFoundException,
                                        AwsServiceException,
                                        SdkClientException,
                                        DsqlException

Tags a resource with a map of key and value pairs.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ServiceQuotaExceededException - The service limit was exceeded.

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You do not have sufficient access to perform this action.

ValidationException - The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The resource could not be found.

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.

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

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ServiceQuotaExceededException,
                                        ThrottlingException,
                                        AccessDeniedException,
                                        ValidationException,
                                        InternalServerException,
                                        ResourceNotFoundException,
                                        AwsServiceException,
                                        SdkClientException,
                                        DsqlException

Tags a resource with a map of key and value pairs.

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

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

Throws:

ServiceQuotaExceededException - The service limit was exceeded.

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You do not have sufficient access to perform this action.

ValidationException - The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The resource could not be found.

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.

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

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ThrottlingException,
                                            AccessDeniedException,
                                            ValidationException,
                                            InternalServerException,
                                            ResourceNotFoundException,
                                            AwsServiceException,
                                            SdkClientException,
                                            DsqlException

Removes a tag from a resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You do not have sufficient access to perform this action.

ValidationException - The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The resource could not be found.

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.

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

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ThrottlingException,
                                            AccessDeniedException,
                                            ValidationException,
                                            InternalServerException,
                                            ResourceNotFoundException,
                                            AwsServiceException,
                                            SdkClientException,
                                            DsqlException

Removes a tag from a resource.

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

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You do not have sufficient access to perform this action.

ValidationException - The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The resource could not be found.

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.

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

AwsServiceException

See Also:

AWS API Documentation

updateCluster

default UpdateClusterResponse updateCluster(UpdateClusterRequest updateClusterRequest)
                                     throws ThrottlingException,
                                            AccessDeniedException,
                                            ValidationException,
                                            InternalServerException,
                                            ResourceNotFoundException,
                                            ConflictException,
                                            AwsServiceException,
                                            SdkClientException,
                                            DsqlException

Updates a cluster.

Parameters:

updateClusterRequest -

Returns:

Result of the UpdateCluster operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You do not have sufficient access to perform this action.

ValidationException - The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The resource could not be found.

ConflictException - The submitted action has conflicts.

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.

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

AwsServiceException

See Also:

AWS API Documentation

updateCluster

default UpdateClusterResponse updateCluster(Consumer<UpdateClusterRequest.Builder> updateClusterRequest)
                                     throws ThrottlingException,
                                            AccessDeniedException,
                                            ValidationException,
                                            InternalServerException,
                                            ResourceNotFoundException,
                                            ConflictException,
                                            AwsServiceException,
                                            SdkClientException,
                                            DsqlException

Updates a cluster.

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

Parameters:

updateClusterRequest - A Consumer that will call methods on UpdateClusterRequest.Builder to create a request.

Returns:

Result of the UpdateCluster operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You do not have sufficient access to perform this action.

ValidationException - The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The resource could not be found.

ConflictException - The submitted action has conflicts.

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.

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

AwsServiceException

See Also:

AWS API Documentation

utilities

default DsqlUtilities utilities()

Creates an instance of DsqlUtilities object with the configuration set on this client.

waiter

default DsqlWaiter waiter()

Create an instance of DsqlWaiter using this client.

Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

Returns:

an instance of DsqlWaiter

create

static DsqlClient create()

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

builder

static DsqlClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default DsqlServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient