com.amazonaws.services.docdbelastic.AmazonDocDBElastic Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-docdbelastic Show documentation
Show all versions of aws-java-sdk-docdbelastic Show documentation
The AWS Java SDK for Amazon DocumentDB Elastic Clusters module holds the client classes that are used for communicating with Amazon DocumentDB Elastic Clusters Service
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.docdbelastic;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.docdbelastic.model.*;
/**
* Interface for accessing DocDB Elastic.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.docdbelastic.AbstractAmazonDocDBElastic} instead.
*
*
*
* 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.
*
*
*
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonDocDBElastic {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "docdb-elastic";
/**
*
* Copies a snapshot of an elastic cluster.
*
*
* @param copyClusterSnapshotRequest
* @return Result of the CopyClusterSnapshot operation returned by the service.
* @throws ThrottlingException
* ThrottlingException will be thrown when request was denied due to request throttling.
* @throws ValidationException
* A structure defining a validation exception.
* @throws ServiceQuotaExceededException
* The service quota for the action was exceeded.
* @throws ConflictException
* There was an access conflict.
* @throws InternalServerException
* There was an internal server error.
* @throws ResourceNotFoundException
* The specified resource could not be located.
* @throws AccessDeniedException
* An exception that occurs when there are not sufficient permissions to perform an action.
* @sample AmazonDocDBElastic.CopyClusterSnapshot
* @see AWS API Documentation
*/
CopyClusterSnapshotResult copyClusterSnapshot(CopyClusterSnapshotRequest copyClusterSnapshotRequest);
/**
*
* Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.
*
*
* @param createClusterRequest
* @return Result of the CreateCluster operation returned by the service.
* @throws ThrottlingException
* ThrottlingException will be thrown when request was denied due to request throttling.
* @throws ValidationException
* A structure defining a validation exception.
* @throws ServiceQuotaExceededException
* The service quota for the action was exceeded.
* @throws ConflictException
* There was an access conflict.
* @throws InternalServerException
* There was an internal server error.
* @throws AccessDeniedException
* An exception that occurs when there are not sufficient permissions to perform an action.
* @sample AmazonDocDBElastic.CreateCluster
* @see AWS
* API Documentation
*/
CreateClusterResult createCluster(CreateClusterRequest createClusterRequest);
/**
*
* Creates a snapshot of an elastic cluster.
*
*
* @param createClusterSnapshotRequest
* @return Result of the CreateClusterSnapshot operation returned by the service.
* @throws ThrottlingException
* ThrottlingException will be thrown when request was denied due to request throttling.
* @throws ValidationException
* A structure defining a validation exception.
* @throws ServiceQuotaExceededException
* The service quota for the action was exceeded.
* @throws ConflictException
* There was an access conflict.
* @throws InternalServerException
* There was an internal server error.
* @throws ResourceNotFoundException
* The specified resource could not be located.
* @throws AccessDeniedException
* An exception that occurs when there are not sufficient permissions to perform an action.
* @sample AmazonDocDBElastic.CreateClusterSnapshot
* @see AWS API Documentation
*/
CreateClusterSnapshotResult createClusterSnapshot(CreateClusterSnapshotRequest createClusterSnapshotRequest);
/**
*
* Delete an elastic cluster.
*
*
* @param deleteClusterRequest
* @return Result of the DeleteCluster operation returned by the service.
* @throws ThrottlingException
* ThrottlingException will be thrown when request was denied due to request throttling.
* @throws ValidationException
* A structure defining a validation exception.
* @throws ConflictException
* There was an access conflict.
* @throws InternalServerException
* There was an internal server error.
* @throws ResourceNotFoundException
* The specified resource could not be located.
* @throws AccessDeniedException
* An exception that occurs when there are not sufficient permissions to perform an action.
* @sample AmazonDocDBElastic.DeleteCluster
* @see AWS
* API Documentation
*/
DeleteClusterResult deleteCluster(DeleteClusterRequest deleteClusterRequest);
/**
*
* Delete an elastic cluster snapshot.
*
*
* @param deleteClusterSnapshotRequest
* @return Result of the DeleteClusterSnapshot operation returned by the service.
* @throws ThrottlingException
* ThrottlingException will be thrown when request was denied due to request throttling.
* @throws ValidationException
* A structure defining a validation exception.
* @throws ConflictException
* There was an access conflict.
* @throws InternalServerException
* There was an internal server error.
* @throws ResourceNotFoundException
* The specified resource could not be located.
* @throws AccessDeniedException
* An exception that occurs when there are not sufficient permissions to perform an action.
* @sample AmazonDocDBElastic.DeleteClusterSnapshot
* @see AWS API Documentation
*/
DeleteClusterSnapshotResult deleteClusterSnapshot(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest);
/**
*
* Returns information about a specific elastic cluster.
*
*
* @param getClusterRequest
* @return Result of the GetCluster operation returned by the service.
* @throws ThrottlingException
* ThrottlingException will be thrown when request was denied due to request throttling.
* @throws ValidationException
* A structure defining a validation exception.
* @throws InternalServerException
* There was an internal server error.
* @throws ResourceNotFoundException
* The specified resource could not be located.
* @throws AccessDeniedException
* An exception that occurs when there are not sufficient permissions to perform an action.
* @sample AmazonDocDBElastic.GetCluster
* @see AWS API
* Documentation
*/
GetClusterResult getCluster(GetClusterRequest getClusterRequest);
/**
*
* Returns information about a specific elastic cluster snapshot
*
*
* @param getClusterSnapshotRequest
* @return Result of the GetClusterSnapshot operation returned by the service.
* @throws ThrottlingException
* ThrottlingException will be thrown when request was denied due to request throttling.
* @throws ValidationException
* A structure defining a validation exception.
* @throws InternalServerException
* There was an internal server error.
* @throws ResourceNotFoundException
* The specified resource could not be located.
* @throws AccessDeniedException
* An exception that occurs when there are not sufficient permissions to perform an action.
* @sample AmazonDocDBElastic.GetClusterSnapshot
* @see AWS API Documentation
*/
GetClusterSnapshotResult getClusterSnapshot(GetClusterSnapshotRequest getClusterSnapshotRequest);
/**
*
* Returns information about snapshots for a specified elastic cluster.
*
*
* @param listClusterSnapshotsRequest
* @return Result of the ListClusterSnapshots operation returned by the service.
* @throws ThrottlingException
* ThrottlingException will be thrown when request was denied due to request throttling.
* @throws ValidationException
* A structure defining a validation exception.
* @throws InternalServerException
* There was an internal server error.
* @throws AccessDeniedException
* An exception that occurs when there are not sufficient permissions to perform an action.
* @sample AmazonDocDBElastic.ListClusterSnapshots
* @see AWS API Documentation
*/
ListClusterSnapshotsResult listClusterSnapshots(ListClusterSnapshotsRequest listClusterSnapshotsRequest);
/**
*
* Returns information about provisioned Amazon DocumentDB elastic clusters.
*
*
* @param listClustersRequest
* @return Result of the ListClusters operation returned by the service.
* @throws ThrottlingException
* ThrottlingException will be thrown when request was denied due to request throttling.
* @throws ValidationException
* A structure defining a validation exception.
* @throws InternalServerException
* There was an internal server error.
* @throws AccessDeniedException
* An exception that occurs when there are not sufficient permissions to perform an action.
* @sample AmazonDocDBElastic.ListClusters
* @see AWS API
* Documentation
*/
ListClustersResult listClusters(ListClustersRequest listClustersRequest);
/**
*
* Lists all tags on a elastic cluster resource
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ThrottlingException
* ThrottlingException will be thrown when request was denied due to request throttling.
* @throws ValidationException
* A structure defining a validation exception.
* @throws InternalServerException
* There was an internal server error.
* @throws ResourceNotFoundException
* The specified resource could not be located.
* @sample AmazonDocDBElastic.ListTagsForResource
* @see AWS API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Restores an elastic cluster from a snapshot.
*
*
* @param restoreClusterFromSnapshotRequest
* @return Result of the RestoreClusterFromSnapshot operation returned by the service.
* @throws ThrottlingException
* ThrottlingException will be thrown when request was denied due to request throttling.
* @throws ValidationException
* A structure defining a validation exception.
* @throws ServiceQuotaExceededException
* The service quota for the action was exceeded.
* @throws ConflictException
* There was an access conflict.
* @throws InternalServerException
* There was an internal server error.
* @throws ResourceNotFoundException
* The specified resource could not be located.
* @throws AccessDeniedException
* An exception that occurs when there are not sufficient permissions to perform an action.
* @sample AmazonDocDBElastic.RestoreClusterFromSnapshot
* @see AWS API Documentation
*/
RestoreClusterFromSnapshotResult restoreClusterFromSnapshot(RestoreClusterFromSnapshotRequest restoreClusterFromSnapshotRequest);
/**
*
* Restarts the stopped elastic cluster that is specified by clusterARN.
*
*
* @param startClusterRequest
* @return Result of the StartCluster operation returned by the service.
* @throws ThrottlingException
* ThrottlingException will be thrown when request was denied due to request throttling.
* @throws ValidationException
* A structure defining a validation exception.
* @throws InternalServerException
* There was an internal server error.
* @throws ResourceNotFoundException
* The specified resource could not be located.
* @throws AccessDeniedException
* An exception that occurs when there are not sufficient permissions to perform an action.
* @sample AmazonDocDBElastic.StartCluster
* @see AWS API
* Documentation
*/
StartClusterResult startCluster(StartClusterRequest startClusterRequest);
/**
*
* Stops the running elastic cluster that is specified by clusterArn. The elastic cluster must be in
* the available state.
*
*
* @param stopClusterRequest
* @return Result of the StopCluster operation returned by the service.
* @throws ThrottlingException
* ThrottlingException will be thrown when request was denied due to request throttling.
* @throws ValidationException
* A structure defining a validation exception.
* @throws InternalServerException
* There was an internal server error.
* @throws ResourceNotFoundException
* The specified resource could not be located.
* @throws AccessDeniedException
* An exception that occurs when there are not sufficient permissions to perform an action.
* @sample AmazonDocDBElastic.StopCluster
* @see AWS API
* Documentation
*/
StopClusterResult stopCluster(StopClusterRequest stopClusterRequest);
/**
*
* Adds metadata tags to an elastic cluster resource
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws ThrottlingException
* ThrottlingException will be thrown when request was denied due to request throttling.
* @throws ValidationException
* A structure defining a validation exception.
* @throws InternalServerException
* There was an internal server error.
* @throws ResourceNotFoundException
* The specified resource could not be located.
* @sample AmazonDocDBElastic.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes metadata tags from an elastic cluster resource
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ThrottlingException
* ThrottlingException will be thrown when request was denied due to request throttling.
* @throws ValidationException
* A structure defining a validation exception.
* @throws InternalServerException
* There was an internal server error.
* @throws ResourceNotFoundException
* The specified resource could not be located.
* @sample AmazonDocDBElastic.UntagResource
* @see AWS
* API Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Modifies an elastic cluster. This includes updating admin-username/password, upgrading the API version, and
* setting up a backup window and maintenance window
*
*
* @param updateClusterRequest
* @return Result of the UpdateCluster operation returned by the service.
* @throws ThrottlingException
* ThrottlingException will be thrown when request was denied due to request throttling.
* @throws ValidationException
* A structure defining a validation exception.
* @throws ConflictException
* There was an access conflict.
* @throws InternalServerException
* There was an internal server error.
* @throws ResourceNotFoundException
* The specified resource could not be located.
* @throws AccessDeniedException
* An exception that occurs when there are not sufficient permissions to perform an action.
* @sample AmazonDocDBElastic.UpdateCluster
* @see AWS
* API Documentation
*/
UpdateClusterResult updateCluster(UpdateClusterRequest updateClusterRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}