Interface DocDbElasticClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface DocDbElasticClient extends AwsClient
Service client for accessing DocDB Elastic. This can be created using the staticbuilder()method.Amazon DocumentDB elastic clusters Amazon DocumentDB elastic-clusters support workloads with millions of reads/writes per second and petabytes of storage capacity. Amazon DocumentDB elastic clusters also simplify how developers interact with Amazon DocumentDB elastic-clusters by eliminating the need to choose, manage or upgrade instances.
Amazon DocumentDB elastic-clusters were created to:
-
provide a solution for customers looking for a database that provides virtually limitless scale with rich query capabilities and MongoDB API compatibility.
-
give customers higher connection limits, and to reduce downtime from patching.
-
continue investing in a cloud-native, elastic, and class leading architecture for JSON workloads.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
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 theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
applyPendingMaintenanceAction
default ApplyPendingMaintenanceActionResponse applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest) throws ThrottlingException, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
The type of pending maintenance action to be applied to the resource.
- Parameters:
applyPendingMaintenanceActionRequest-- Returns:
- Result of the ApplyPendingMaintenanceAction operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.ConflictException- There was an access conflict.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
applyPendingMaintenanceAction
default ApplyPendingMaintenanceActionResponse applyPendingMaintenanceAction(Consumer<ApplyPendingMaintenanceActionRequest.Builder> applyPendingMaintenanceActionRequest) throws ThrottlingException, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
The type of pending maintenance action to be applied to the resource.
This is a convenience which creates an instance of the
ApplyPendingMaintenanceActionRequest.Builderavoiding the need to create one manually viaApplyPendingMaintenanceActionRequest.builder()- Parameters:
applyPendingMaintenanceActionRequest- AConsumerthat will call methods onApplyPendingMaintenanceActionRequest.Builderto create a request.- Returns:
- Result of the ApplyPendingMaintenanceAction operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.ConflictException- There was an access conflict.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
copyClusterSnapshot
default CopyClusterSnapshotResponse copyClusterSnapshot(CopyClusterSnapshotRequest copyClusterSnapshotRequest) throws ThrottlingException, ValidationException, ServiceQuotaExceededException, ConflictException, InternalServerException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Copies a snapshot of an elastic cluster.
- Parameters:
copyClusterSnapshotRequest-- Returns:
- Result of the CopyClusterSnapshot operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.ServiceQuotaExceededException- The service quota for the action was exceeded.ConflictException- There was an access conflict.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
copyClusterSnapshot
default CopyClusterSnapshotResponse copyClusterSnapshot(Consumer<CopyClusterSnapshotRequest.Builder> copyClusterSnapshotRequest) throws ThrottlingException, ValidationException, ServiceQuotaExceededException, ConflictException, InternalServerException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Copies a snapshot of an elastic cluster.
This is a convenience which creates an instance of the
CopyClusterSnapshotRequest.Builderavoiding the need to create one manually viaCopyClusterSnapshotRequest.builder()- Parameters:
copyClusterSnapshotRequest- AConsumerthat will call methods onCopyClusterSnapshotRequest.Builderto create a request.- Returns:
- Result of the CopyClusterSnapshot operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.ServiceQuotaExceededException- The service quota for the action was exceeded.ConflictException- There was an access conflict.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- 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(CreateClusterRequest createClusterRequest) throws ThrottlingException, ValidationException, ServiceQuotaExceededException, ConflictException, InternalServerException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.
- Parameters:
createClusterRequest-- Returns:
- Result of the CreateCluster operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.ServiceQuotaExceededException- The service quota for the action was exceeded.ConflictException- There was an access conflict.InternalServerException- There was an internal server error.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- 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 ThrottlingException, ValidationException, ServiceQuotaExceededException, ConflictException, InternalServerException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.
This is a convenience which creates an instance of the
CreateClusterRequest.Builderavoiding the need to create one manually viaCreateClusterRequest.builder()- Parameters:
createClusterRequest- AConsumerthat will call methods onCreateClusterRequest.Builderto create a request.- Returns:
- Result of the CreateCluster operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.ServiceQuotaExceededException- The service quota for the action was exceeded.ConflictException- There was an access conflict.InternalServerException- There was an internal server error.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createClusterSnapshot
default CreateClusterSnapshotResponse createClusterSnapshot(CreateClusterSnapshotRequest createClusterSnapshotRequest) throws ThrottlingException, ValidationException, ServiceQuotaExceededException, ConflictException, InternalServerException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Creates a snapshot of an elastic cluster.
- Parameters:
createClusterSnapshotRequest-- Returns:
- Result of the CreateClusterSnapshot operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.ServiceQuotaExceededException- The service quota for the action was exceeded.ConflictException- There was an access conflict.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createClusterSnapshot
default CreateClusterSnapshotResponse createClusterSnapshot(Consumer<CreateClusterSnapshotRequest.Builder> createClusterSnapshotRequest) throws ThrottlingException, ValidationException, ServiceQuotaExceededException, ConflictException, InternalServerException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Creates a snapshot of an elastic cluster.
This is a convenience which creates an instance of the
CreateClusterSnapshotRequest.Builderavoiding the need to create one manually viaCreateClusterSnapshotRequest.builder()- Parameters:
createClusterSnapshotRequest- AConsumerthat will call methods onCreateClusterSnapshotRequest.Builderto create a request.- Returns:
- Result of the CreateClusterSnapshot operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.ServiceQuotaExceededException- The service quota for the action was exceeded.ConflictException- There was an access conflict.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- 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, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Delete an elastic cluster.
- Parameters:
deleteClusterRequest-- Returns:
- Result of the DeleteCluster operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.ConflictException- There was an access conflict.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- 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, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Delete an elastic cluster.
This is a convenience which creates an instance of the
DeleteClusterRequest.Builderavoiding the need to create one manually viaDeleteClusterRequest.builder()- Parameters:
deleteClusterRequest- AConsumerthat will call methods onDeleteClusterRequest.Builderto create a request.- Returns:
- Result of the DeleteCluster operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.ConflictException- There was an access conflict.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteClusterSnapshot
default DeleteClusterSnapshotResponse deleteClusterSnapshot(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest) throws ThrottlingException, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Delete an elastic cluster snapshot.
- Parameters:
deleteClusterSnapshotRequest-- Returns:
- Result of the DeleteClusterSnapshot operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.ConflictException- There was an access conflict.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteClusterSnapshot
default DeleteClusterSnapshotResponse deleteClusterSnapshot(Consumer<DeleteClusterSnapshotRequest.Builder> deleteClusterSnapshotRequest) throws ThrottlingException, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Delete an elastic cluster snapshot.
This is a convenience which creates an instance of the
DeleteClusterSnapshotRequest.Builderavoiding the need to create one manually viaDeleteClusterSnapshotRequest.builder()- Parameters:
deleteClusterSnapshotRequest- AConsumerthat will call methods onDeleteClusterSnapshotRequest.Builderto create a request.- Returns:
- Result of the DeleteClusterSnapshot operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.ConflictException- There was an access conflict.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- 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, ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Returns information about a specific elastic cluster.
- Parameters:
getClusterRequest-- Returns:
- Result of the GetCluster operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- 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, ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Returns information about a specific elastic cluster.
This is a convenience which creates an instance of the
GetClusterRequest.Builderavoiding the need to create one manually viaGetClusterRequest.builder()- Parameters:
getClusterRequest- AConsumerthat will call methods onGetClusterRequest.Builderto create a request.- Returns:
- Result of the GetCluster operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getClusterSnapshot
default GetClusterSnapshotResponse getClusterSnapshot(GetClusterSnapshotRequest getClusterSnapshotRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Returns information about a specific elastic cluster snapshot
- Parameters:
getClusterSnapshotRequest-- Returns:
- Result of the GetClusterSnapshot operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getClusterSnapshot
default GetClusterSnapshotResponse getClusterSnapshot(Consumer<GetClusterSnapshotRequest.Builder> getClusterSnapshotRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Returns information about a specific elastic cluster snapshot
This is a convenience which creates an instance of the
GetClusterSnapshotRequest.Builderavoiding the need to create one manually viaGetClusterSnapshotRequest.builder()- Parameters:
getClusterSnapshotRequest- AConsumerthat will call methods onGetClusterSnapshotRequest.Builderto create a request.- Returns:
- Result of the GetClusterSnapshot operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getPendingMaintenanceAction
default GetPendingMaintenanceActionResponse getPendingMaintenanceAction(GetPendingMaintenanceActionRequest getPendingMaintenanceActionRequest) throws ThrottlingException, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Retrieves all maintenance actions that are pending.
- Parameters:
getPendingMaintenanceActionRequest-- Returns:
- Result of the GetPendingMaintenanceAction operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.ConflictException- There was an access conflict.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getPendingMaintenanceAction
default GetPendingMaintenanceActionResponse getPendingMaintenanceAction(Consumer<GetPendingMaintenanceActionRequest.Builder> getPendingMaintenanceActionRequest) throws ThrottlingException, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Retrieves all maintenance actions that are pending.
This is a convenience which creates an instance of the
GetPendingMaintenanceActionRequest.Builderavoiding the need to create one manually viaGetPendingMaintenanceActionRequest.builder()- Parameters:
getPendingMaintenanceActionRequest- AConsumerthat will call methods onGetPendingMaintenanceActionRequest.Builderto create a request.- Returns:
- Result of the GetPendingMaintenanceAction operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.ConflictException- There was an access conflict.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listClusterSnapshots
default ListClusterSnapshotsResponse listClusterSnapshots(ListClusterSnapshotsRequest listClusterSnapshotsRequest) throws ThrottlingException, ValidationException, InternalServerException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Returns information about snapshots for a specified elastic cluster.
- Parameters:
listClusterSnapshotsRequest-- Returns:
- Result of the ListClusterSnapshots operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.InternalServerException- There was an internal server error.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listClusterSnapshots
default ListClusterSnapshotsResponse listClusterSnapshots(Consumer<ListClusterSnapshotsRequest.Builder> listClusterSnapshotsRequest) throws ThrottlingException, ValidationException, InternalServerException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Returns information about snapshots for a specified elastic cluster.
This is a convenience which creates an instance of the
ListClusterSnapshotsRequest.Builderavoiding the need to create one manually viaListClusterSnapshotsRequest.builder()- Parameters:
listClusterSnapshotsRequest- AConsumerthat will call methods onListClusterSnapshotsRequest.Builderto create a request.- Returns:
- Result of the ListClusterSnapshots operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.InternalServerException- There was an internal server error.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listClusterSnapshotsPaginator
default ListClusterSnapshotsIterable listClusterSnapshotsPaginator(ListClusterSnapshotsRequest listClusterSnapshotsRequest) throws ThrottlingException, ValidationException, InternalServerException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
This is a variant of
listClusterSnapshots(software.amazon.awssdk.services.docdbelastic.model.ListClusterSnapshotsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.docdbelastic.paginators.ListClusterSnapshotsIterable responses = client.listClusterSnapshotsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.docdbelastic.paginators.ListClusterSnapshotsIterable responses = client .listClusterSnapshotsPaginator(request); for (software.amazon.awssdk.services.docdbelastic.model.ListClusterSnapshotsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.docdbelastic.paginators.ListClusterSnapshotsIterable responses = client.listClusterSnapshotsPaginator(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
listClusterSnapshots(software.amazon.awssdk.services.docdbelastic.model.ListClusterSnapshotsRequest)operation.- Parameters:
listClusterSnapshotsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.InternalServerException- There was an internal server error.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listClusterSnapshotsPaginator
default ListClusterSnapshotsIterable listClusterSnapshotsPaginator(Consumer<ListClusterSnapshotsRequest.Builder> listClusterSnapshotsRequest) throws ThrottlingException, ValidationException, InternalServerException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
This is a variant of
listClusterSnapshots(software.amazon.awssdk.services.docdbelastic.model.ListClusterSnapshotsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.docdbelastic.paginators.ListClusterSnapshotsIterable responses = client.listClusterSnapshotsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.docdbelastic.paginators.ListClusterSnapshotsIterable responses = client .listClusterSnapshotsPaginator(request); for (software.amazon.awssdk.services.docdbelastic.model.ListClusterSnapshotsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.docdbelastic.paginators.ListClusterSnapshotsIterable responses = client.listClusterSnapshotsPaginator(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
listClusterSnapshots(software.amazon.awssdk.services.docdbelastic.model.ListClusterSnapshotsRequest)operation.
This is a convenience which creates an instance of the
ListClusterSnapshotsRequest.Builderavoiding the need to create one manually viaListClusterSnapshotsRequest.builder()- Parameters:
listClusterSnapshotsRequest- AConsumerthat will call methods onListClusterSnapshotsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.InternalServerException- There was an internal server error.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- 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, ValidationException, InternalServerException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Returns information about provisioned Amazon DocumentDB elastic clusters.
- Parameters:
listClustersRequest-- Returns:
- Result of the ListClusters operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.InternalServerException- There was an internal server error.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- 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, ValidationException, InternalServerException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Returns information about provisioned Amazon DocumentDB elastic clusters.
This is a convenience which creates an instance of the
ListClustersRequest.Builderavoiding the need to create one manually viaListClustersRequest.builder()- Parameters:
listClustersRequest- AConsumerthat will call methods onListClustersRequest.Builderto create a request.- Returns:
- Result of the ListClusters operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.InternalServerException- There was an internal server error.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- 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, ValidationException, InternalServerException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
This is a variant of
listClusters(software.amazon.awssdk.services.docdbelastic.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
2) Using For loopsoftware.amazon.awssdk.services.docdbelastic.paginators.ListClustersIterable responses = client.listClustersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.docdbelastic.paginators.ListClustersIterable responses = client .listClustersPaginator(request); for (software.amazon.awssdk.services.docdbelastic.model.ListClustersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.docdbelastic.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.docdbelastic.model.ListClustersRequest)operation.- Parameters:
listClustersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.InternalServerException- There was an internal server error.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- 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, ValidationException, InternalServerException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
This is a variant of
listClusters(software.amazon.awssdk.services.docdbelastic.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
2) Using For loopsoftware.amazon.awssdk.services.docdbelastic.paginators.ListClustersIterable responses = client.listClustersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.docdbelastic.paginators.ListClustersIterable responses = client .listClustersPaginator(request); for (software.amazon.awssdk.services.docdbelastic.model.ListClustersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.docdbelastic.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.docdbelastic.model.ListClustersRequest)operation.
This is a convenience which creates an instance of the
ListClustersRequest.Builderavoiding the need to create one manually viaListClustersRequest.builder()- Parameters:
listClustersRequest- AConsumerthat will call methods onListClustersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.InternalServerException- There was an internal server error.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPendingMaintenanceActions
default ListPendingMaintenanceActionsResponse listPendingMaintenanceActions(ListPendingMaintenanceActionsRequest listPendingMaintenanceActionsRequest) throws ThrottlingException, ValidationException, InternalServerException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Retrieves a list of all maintenance actions that are pending.
- Parameters:
listPendingMaintenanceActionsRequest-- Returns:
- Result of the ListPendingMaintenanceActions operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.InternalServerException- There was an internal server error.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPendingMaintenanceActions
default ListPendingMaintenanceActionsResponse listPendingMaintenanceActions(Consumer<ListPendingMaintenanceActionsRequest.Builder> listPendingMaintenanceActionsRequest) throws ThrottlingException, ValidationException, InternalServerException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Retrieves a list of all maintenance actions that are pending.
This is a convenience which creates an instance of the
ListPendingMaintenanceActionsRequest.Builderavoiding the need to create one manually viaListPendingMaintenanceActionsRequest.builder()- Parameters:
listPendingMaintenanceActionsRequest- AConsumerthat will call methods onListPendingMaintenanceActionsRequest.Builderto create a request.- Returns:
- Result of the ListPendingMaintenanceActions operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.InternalServerException- There was an internal server error.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPendingMaintenanceActionsPaginator
default ListPendingMaintenanceActionsIterable listPendingMaintenanceActionsPaginator(ListPendingMaintenanceActionsRequest listPendingMaintenanceActionsRequest) throws ThrottlingException, ValidationException, InternalServerException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
This is a variant of
listPendingMaintenanceActions(software.amazon.awssdk.services.docdbelastic.model.ListPendingMaintenanceActionsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.docdbelastic.paginators.ListPendingMaintenanceActionsIterable responses = client.listPendingMaintenanceActionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.docdbelastic.paginators.ListPendingMaintenanceActionsIterable responses = client .listPendingMaintenanceActionsPaginator(request); for (software.amazon.awssdk.services.docdbelastic.model.ListPendingMaintenanceActionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.docdbelastic.paginators.ListPendingMaintenanceActionsIterable responses = client.listPendingMaintenanceActionsPaginator(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
listPendingMaintenanceActions(software.amazon.awssdk.services.docdbelastic.model.ListPendingMaintenanceActionsRequest)operation.- Parameters:
listPendingMaintenanceActionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.InternalServerException- There was an internal server error.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPendingMaintenanceActionsPaginator
default ListPendingMaintenanceActionsIterable listPendingMaintenanceActionsPaginator(Consumer<ListPendingMaintenanceActionsRequest.Builder> listPendingMaintenanceActionsRequest) throws ThrottlingException, ValidationException, InternalServerException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
This is a variant of
listPendingMaintenanceActions(software.amazon.awssdk.services.docdbelastic.model.ListPendingMaintenanceActionsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.docdbelastic.paginators.ListPendingMaintenanceActionsIterable responses = client.listPendingMaintenanceActionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.docdbelastic.paginators.ListPendingMaintenanceActionsIterable responses = client .listPendingMaintenanceActionsPaginator(request); for (software.amazon.awssdk.services.docdbelastic.model.ListPendingMaintenanceActionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.docdbelastic.paginators.ListPendingMaintenanceActionsIterable responses = client.listPendingMaintenanceActionsPaginator(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
listPendingMaintenanceActions(software.amazon.awssdk.services.docdbelastic.model.ListPendingMaintenanceActionsRequest)operation.
This is a convenience which creates an instance of the
ListPendingMaintenanceActionsRequest.Builderavoiding the need to create one manually viaListPendingMaintenanceActionsRequest.builder()- Parameters:
listPendingMaintenanceActionsRequest- AConsumerthat will call methods onListPendingMaintenanceActionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.InternalServerException- There was an internal server error.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- 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, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, DocDbElasticException
Lists all tags on a elastic cluster resource
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.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.DocDbElasticException- 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, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, DocDbElasticException
Lists all tags on a elastic cluster resource
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.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.DocDbElasticException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
restoreClusterFromSnapshot
default RestoreClusterFromSnapshotResponse restoreClusterFromSnapshot(RestoreClusterFromSnapshotRequest restoreClusterFromSnapshotRequest) throws ThrottlingException, ValidationException, ServiceQuotaExceededException, ConflictException, InternalServerException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Restores an elastic cluster from a snapshot.
- Parameters:
restoreClusterFromSnapshotRequest-- Returns:
- Result of the RestoreClusterFromSnapshot operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.ServiceQuotaExceededException- The service quota for the action was exceeded.ConflictException- There was an access conflict.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
restoreClusterFromSnapshot
default RestoreClusterFromSnapshotResponse restoreClusterFromSnapshot(Consumer<RestoreClusterFromSnapshotRequest.Builder> restoreClusterFromSnapshotRequest) throws ThrottlingException, ValidationException, ServiceQuotaExceededException, ConflictException, InternalServerException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Restores an elastic cluster from a snapshot.
This is a convenience which creates an instance of the
RestoreClusterFromSnapshotRequest.Builderavoiding the need to create one manually viaRestoreClusterFromSnapshotRequest.builder()- Parameters:
restoreClusterFromSnapshotRequest- AConsumerthat will call methods onRestoreClusterFromSnapshotRequest.Builderto create a request.- Returns:
- Result of the RestoreClusterFromSnapshot operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.ServiceQuotaExceededException- The service quota for the action was exceeded.ConflictException- There was an access conflict.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startCluster
default StartClusterResponse startCluster(StartClusterRequest startClusterRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Restarts the stopped elastic cluster that is specified by
clusterARN.- Parameters:
startClusterRequest-- Returns:
- Result of the StartCluster operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startCluster
default StartClusterResponse startCluster(Consumer<StartClusterRequest.Builder> startClusterRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Restarts the stopped elastic cluster that is specified by
clusterARN.
This is a convenience which creates an instance of the
StartClusterRequest.Builderavoiding the need to create one manually viaStartClusterRequest.builder()- Parameters:
startClusterRequest- AConsumerthat will call methods onStartClusterRequest.Builderto create a request.- Returns:
- Result of the StartCluster operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
stopCluster
default StopClusterResponse stopCluster(StopClusterRequest stopClusterRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Stops the running elastic cluster that is specified by
clusterArn. The elastic cluster must be in the available state.- Parameters:
stopClusterRequest-- Returns:
- Result of the StopCluster operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
stopCluster
default StopClusterResponse stopCluster(Consumer<StopClusterRequest.Builder> stopClusterRequest) throws ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Stops the running elastic cluster that is specified by
clusterArn. The elastic cluster must be in the available state.
This is a convenience which creates an instance of the
StopClusterRequest.Builderavoiding the need to create one manually viaStopClusterRequest.builder()- Parameters:
stopClusterRequest- AConsumerthat will call methods onStopClusterRequest.Builderto create a request.- Returns:
- Result of the StopCluster operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- 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 ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, DocDbElasticException
Adds metadata tags to an elastic cluster resource
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.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.DocDbElasticException- 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 ThrottlingException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, DocDbElasticException
Adds metadata tags to an elastic cluster resource
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.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.DocDbElasticException- 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, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, DocDbElasticException
Removes metadata tags from an elastic cluster resource
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.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.DocDbElasticException- 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, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, DocDbElasticException
Removes metadata tags from an elastic cluster resource
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.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.DocDbElasticException- 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, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Modifies an elastic cluster. This includes updating admin-username/password, upgrading the API version, and setting up a backup window and maintenance window
- Parameters:
updateClusterRequest-- Returns:
- Result of the UpdateCluster operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.ConflictException- There was an access conflict.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- 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, ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, DocDbElasticException
Modifies an elastic cluster. This includes updating admin-username/password, upgrading the API version, and setting up a backup window and maintenance window
This is a convenience which creates an instance of the
UpdateClusterRequest.Builderavoiding the need to create one manually viaUpdateClusterRequest.builder()- Parameters:
updateClusterRequest- AConsumerthat will call methods onUpdateClusterRequest.Builderto create a request.- Returns:
- Result of the UpdateCluster operation returned by the service.
- Throws:
ThrottlingException- ThrottlingException will be thrown when request was denied due to request throttling.ValidationException- A structure defining a validation exception.ConflictException- There was an access conflict.InternalServerException- There was an internal server error.ResourceNotFoundException- The specified resource could not be located.AccessDeniedException- An exception that occurs when there are not sufficient permissions to perform an action.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.DocDbElasticException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
create
static DocDbElasticClient create()
Create aDocDbElasticClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static DocDbElasticClientBuilder builder()
Create a builder that can be used to configure and create aDocDbElasticClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default DocDbElasticServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-