@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonEBSAsyncClient extends AmazonEBSClient implements AmazonEBSAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
You can use the Amazon Elastic Block Store (Amazon EBS) direct APIs to create Amazon EBS snapshots, write data directly to your snapshots, read data on your snapshots, and identify the differences or changes between two snapshots. If you’re an independent software vendor (ISV) who offers backup services for Amazon EBS, the EBS direct APIs make it more efficient and cost-effective to track incremental changes on your Amazon EBS volumes through snapshots. This can be done without having to create new volumes from snapshots, and then use Amazon Elastic Compute Cloud (Amazon EC2) instances to compare the differences.
You can create incremental snapshots directly from data on-premises into volumes and the cloud to use for quick disaster recovery. With the ability to write and read snapshots, you can write your on-premises data to an snapshot during a disaster. Then after recovery, you can restore it back to Amazon Web Services or on-premises from the snapshot. You no longer need to build and maintain complex mechanisms to copy data to and from Amazon EBS.
This API reference provides detailed information about the actions, data types, parameters, and errors of the EBS direct APIs. For more information about the elements that make up the EBS direct APIs, and examples of how to use them effectively, see Accessing the Contents of an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas for the EBS direct APIs, see Amazon Elastic Block Store Endpoints and Quotas in the Amazon Web Services General Reference.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
static AmazonEBSAsyncClientBuilder |
asyncBuilder() |
Future<CompleteSnapshotResult> |
completeSnapshotAsync(CompleteSnapshotRequest request)
Seals and completes the snapshot after all of the required blocks of data have been written to it.
|
Future<CompleteSnapshotResult> |
completeSnapshotAsync(CompleteSnapshotRequest request,
AsyncHandler<CompleteSnapshotRequest,CompleteSnapshotResult> asyncHandler)
Seals and completes the snapshot after all of the required blocks of data have been written to it.
|
ExecutorService |
getExecutorService()
Returns the executor service used by this client to execute async requests.
|
Future<GetSnapshotBlockResult> |
getSnapshotBlockAsync(GetSnapshotBlockRequest request)
Returns the data in a block in an Amazon Elastic Block Store snapshot.
|
Future<GetSnapshotBlockResult> |
getSnapshotBlockAsync(GetSnapshotBlockRequest request,
AsyncHandler<GetSnapshotBlockRequest,GetSnapshotBlockResult> asyncHandler)
Returns the data in a block in an Amazon Elastic Block Store snapshot.
|
Future<ListChangedBlocksResult> |
listChangedBlocksAsync(ListChangedBlocksRequest request)
Returns information about the blocks that are different between two Amazon Elastic Block Store snapshots of the
same volume/snapshot lineage.
|
Future<ListChangedBlocksResult> |
listChangedBlocksAsync(ListChangedBlocksRequest request,
AsyncHandler<ListChangedBlocksRequest,ListChangedBlocksResult> asyncHandler)
Returns information about the blocks that are different between two Amazon Elastic Block Store snapshots of the
same volume/snapshot lineage.
|
Future<ListSnapshotBlocksResult> |
listSnapshotBlocksAsync(ListSnapshotBlocksRequest request)
Returns information about the blocks in an Amazon Elastic Block Store snapshot.
|
Future<ListSnapshotBlocksResult> |
listSnapshotBlocksAsync(ListSnapshotBlocksRequest request,
AsyncHandler<ListSnapshotBlocksRequest,ListSnapshotBlocksResult> asyncHandler)
Returns information about the blocks in an Amazon Elastic Block Store snapshot.
|
Future<PutSnapshotBlockResult> |
putSnapshotBlockAsync(PutSnapshotBlockRequest request)
Writes a block of data to a snapshot.
|
Future<PutSnapshotBlockResult> |
putSnapshotBlockAsync(PutSnapshotBlockRequest request,
AsyncHandler<PutSnapshotBlockRequest,PutSnapshotBlockResult> asyncHandler)
Writes a block of data to a snapshot.
|
void |
shutdown()
Shuts down the client, releasing all managed resources.
|
Future<StartSnapshotResult> |
startSnapshotAsync(StartSnapshotRequest request)
Creates a new Amazon EBS snapshot.
|
Future<StartSnapshotResult> |
startSnapshotAsync(StartSnapshotRequest request,
AsyncHandler<StartSnapshotRequest,StartSnapshotResult> asyncHandler)
Creates a new Amazon EBS snapshot.
|
builder, completeSnapshot, getCachedResponseMetadata, getSnapshotBlock, listChangedBlocks, listSnapshotBlocks, putSnapshotBlock, startSnapshotaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcompleteSnapshot, getCachedResponseMetadata, getSnapshotBlock, listChangedBlocks, listSnapshotBlocks, putSnapshotBlock, startSnapshotpublic static AmazonEBSAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CompleteSnapshotResult> completeSnapshotAsync(CompleteSnapshotRequest request)
AmazonEBSAsync
Seals and completes the snapshot after all of the required blocks of data have been written to it. Completing the
snapshot changes the status to completed. You cannot write new blocks to a snapshot after it has
been completed.
You should always retry requests that receive server (5xx) error responses, and
ThrottlingException and RequestThrottledException client error responses. For more
information see Error
retries in the Amazon Elastic Compute Cloud User Guide.
completeSnapshotAsync in interface AmazonEBSAsyncpublic Future<CompleteSnapshotResult> completeSnapshotAsync(CompleteSnapshotRequest request, AsyncHandler<CompleteSnapshotRequest,CompleteSnapshotResult> asyncHandler)
AmazonEBSAsync
Seals and completes the snapshot after all of the required blocks of data have been written to it. Completing the
snapshot changes the status to completed. You cannot write new blocks to a snapshot after it has
been completed.
You should always retry requests that receive server (5xx) error responses, and
ThrottlingException and RequestThrottledException client error responses. For more
information see Error
retries in the Amazon Elastic Compute Cloud User Guide.
completeSnapshotAsync in interface AmazonEBSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetSnapshotBlockResult> getSnapshotBlockAsync(GetSnapshotBlockRequest request)
AmazonEBSAsyncReturns the data in a block in an Amazon Elastic Block Store snapshot.
You should always retry requests that receive server (5xx) error responses, and
ThrottlingException and RequestThrottledException client error responses. For more
information see Error
retries in the Amazon Elastic Compute Cloud User Guide.
getSnapshotBlockAsync in interface AmazonEBSAsyncpublic Future<GetSnapshotBlockResult> getSnapshotBlockAsync(GetSnapshotBlockRequest request, AsyncHandler<GetSnapshotBlockRequest,GetSnapshotBlockResult> asyncHandler)
AmazonEBSAsyncReturns the data in a block in an Amazon Elastic Block Store snapshot.
You should always retry requests that receive server (5xx) error responses, and
ThrottlingException and RequestThrottledException client error responses. For more
information see Error
retries in the Amazon Elastic Compute Cloud User Guide.
getSnapshotBlockAsync in interface AmazonEBSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListChangedBlocksResult> listChangedBlocksAsync(ListChangedBlocksRequest request)
AmazonEBSAsyncReturns information about the blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.
You should always retry requests that receive server (5xx) error responses, and
ThrottlingException and RequestThrottledException client error responses. For more
information see Error
retries in the Amazon Elastic Compute Cloud User Guide.
listChangedBlocksAsync in interface AmazonEBSAsyncpublic Future<ListChangedBlocksResult> listChangedBlocksAsync(ListChangedBlocksRequest request, AsyncHandler<ListChangedBlocksRequest,ListChangedBlocksResult> asyncHandler)
AmazonEBSAsyncReturns information about the blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.
You should always retry requests that receive server (5xx) error responses, and
ThrottlingException and RequestThrottledException client error responses. For more
information see Error
retries in the Amazon Elastic Compute Cloud User Guide.
listChangedBlocksAsync in interface AmazonEBSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListSnapshotBlocksResult> listSnapshotBlocksAsync(ListSnapshotBlocksRequest request)
AmazonEBSAsyncReturns information about the blocks in an Amazon Elastic Block Store snapshot.
You should always retry requests that receive server (5xx) error responses, and
ThrottlingException and RequestThrottledException client error responses. For more
information see Error
retries in the Amazon Elastic Compute Cloud User Guide.
listSnapshotBlocksAsync in interface AmazonEBSAsyncpublic Future<ListSnapshotBlocksResult> listSnapshotBlocksAsync(ListSnapshotBlocksRequest request, AsyncHandler<ListSnapshotBlocksRequest,ListSnapshotBlocksResult> asyncHandler)
AmazonEBSAsyncReturns information about the blocks in an Amazon Elastic Block Store snapshot.
You should always retry requests that receive server (5xx) error responses, and
ThrottlingException and RequestThrottledException client error responses. For more
information see Error
retries in the Amazon Elastic Compute Cloud User Guide.
listSnapshotBlocksAsync in interface AmazonEBSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutSnapshotBlockResult> putSnapshotBlockAsync(PutSnapshotBlockRequest request)
AmazonEBSAsync
Writes a block of data to a snapshot. If the specified block contains data, the existing data is overwritten. The
target snapshot must be in the pending state.
Data written to a snapshot must be aligned with 512-KiB sectors.
You should always retry requests that receive server (5xx) error responses, and
ThrottlingException and RequestThrottledException client error responses. For more
information see Error
retries in the Amazon Elastic Compute Cloud User Guide.
putSnapshotBlockAsync in interface AmazonEBSAsyncpublic Future<PutSnapshotBlockResult> putSnapshotBlockAsync(PutSnapshotBlockRequest request, AsyncHandler<PutSnapshotBlockRequest,PutSnapshotBlockResult> asyncHandler)
AmazonEBSAsync
Writes a block of data to a snapshot. If the specified block contains data, the existing data is overwritten. The
target snapshot must be in the pending state.
Data written to a snapshot must be aligned with 512-KiB sectors.
You should always retry requests that receive server (5xx) error responses, and
ThrottlingException and RequestThrottledException client error responses. For more
information see Error
retries in the Amazon Elastic Compute Cloud User Guide.
putSnapshotBlockAsync in interface AmazonEBSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartSnapshotResult> startSnapshotAsync(StartSnapshotRequest request)
AmazonEBSAsync
Creates a new Amazon EBS snapshot. The new snapshot enters the pending state after the request
completes.
After creating the snapshot, use PutSnapshotBlock to write blocks of data to the snapshot.
You should always retry requests that receive server (5xx) error responses, and
ThrottlingException and RequestThrottledException client error responses. For more
information see Error
retries in the Amazon Elastic Compute Cloud User Guide.
startSnapshotAsync in interface AmazonEBSAsyncpublic Future<StartSnapshotResult> startSnapshotAsync(StartSnapshotRequest request, AsyncHandler<StartSnapshotRequest,StartSnapshotResult> asyncHandler)
AmazonEBSAsync
Creates a new Amazon EBS snapshot. The new snapshot enters the pending state after the request
completes.
After creating the snapshot, use PutSnapshotBlock to write blocks of data to the snapshot.
You should always retry requests that receive server (5xx) error responses, and
ThrottlingException and RequestThrottledException client error responses. For more
information see Error
retries in the Amazon Elastic Compute Cloud User Guide.
startSnapshotAsync in interface AmazonEBSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonEBSshutdown in class AmazonEBSClient