com.amazonaws.services.ebs

Class AmazonEBSClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.ebs.AmazonEBSClient

All Implemented Interfaces:

AmazonEBS

Direct Known Subclasses:

AmazonEBSAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonEBSClient
extends AmazonWebServiceClient
implements AmazonEBS

Client for accessing Amazon EBS. All service calls made using this client are blocking, and will not return until the service call 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.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.ebs.AmazonEBS

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonEBSClientBuilder	builder()
CompleteSnapshotResult	completeSnapshot(CompleteSnapshotRequest request) Seals and completes the snapshot after all of the required blocks of data have been written to it.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetSnapshotBlockResult	getSnapshotBlock(GetSnapshotBlockRequest request) Returns the data in a block in an Amazon Elastic Block Store snapshot.
ListChangedBlocksResult	listChangedBlocks(ListChangedBlocksRequest request) Returns information about the blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.
ListSnapshotBlocksResult	listSnapshotBlocks(ListSnapshotBlocksRequest request) Returns information about the blocks in an Amazon Elastic Block Store snapshot.
PutSnapshotBlockResult	putSnapshotBlock(PutSnapshotBlockRequest request) Writes a block of data to a snapshot.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartSnapshotResult	startSnapshot(StartSnapshotRequest request) Creates a new Amazon EBS snapshot.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonEBSClientBuilder builder()

completeSnapshot

public CompleteSnapshotResult completeSnapshot(CompleteSnapshotRequest request)

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.

Specified by:

completeSnapshot in interface AmazonEBS

Parameters:

completeSnapshotRequest -

Returns:

Result of the CompleteSnapshot operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints of the EBS direct APIs.

ResourceNotFoundException - The specified resource does not exist.

RequestThrottledException - The number of API requests has exceeded the maximum allowed API request throttling limit for the snapshot. For more information see Error retries.

ServiceQuotaExceededException - Your current service quotas do not allow you to perform this action.

InternalServerException - An internal error has occurred. For more information see Error retries.

See Also:

AWS API Documentation

getSnapshotBlock

public GetSnapshotBlockResult getSnapshotBlock(GetSnapshotBlockRequest request)

Returns 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.

Specified by:

getSnapshotBlock in interface AmazonEBS

Parameters:

getSnapshotBlockRequest -

Returns:

Result of the GetSnapshotBlock operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints of the EBS direct APIs.

ResourceNotFoundException - The specified resource does not exist.

RequestThrottledException - The number of API requests has exceeded the maximum allowed API request throttling limit for the snapshot. For more information see Error retries.

ServiceQuotaExceededException - Your current service quotas do not allow you to perform this action.

InternalServerException - An internal error has occurred. For more information see Error retries.

See Also:

AWS API Documentation

listChangedBlocks

public ListChangedBlocksResult listChangedBlocks(ListChangedBlocksRequest request)

Returns 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.

Specified by:

listChangedBlocks in interface AmazonEBS

Parameters:

listChangedBlocksRequest -

Returns:

Result of the ListChangedBlocks operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints of the EBS direct APIs.

ResourceNotFoundException - The specified resource does not exist.

RequestThrottledException - The number of API requests has exceeded the maximum allowed API request throttling limit for the snapshot. For more information see Error retries.

ServiceQuotaExceededException - Your current service quotas do not allow you to perform this action.

InternalServerException - An internal error has occurred. For more information see Error retries.

See Also:

AWS API Documentation

listSnapshotBlocks

public ListSnapshotBlocksResult listSnapshotBlocks(ListSnapshotBlocksRequest request)

Returns 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.

Specified by:

listSnapshotBlocks in interface AmazonEBS

Parameters:

listSnapshotBlocksRequest -

Returns:

Result of the ListSnapshotBlocks operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints of the EBS direct APIs.

ResourceNotFoundException - The specified resource does not exist.

RequestThrottledException - The number of API requests has exceeded the maximum allowed API request throttling limit for the snapshot. For more information see Error retries.

ServiceQuotaExceededException - Your current service quotas do not allow you to perform this action.

InternalServerException - An internal error has occurred. For more information see Error retries.

See Also:

AWS API Documentation

putSnapshotBlock

public PutSnapshotBlockResult putSnapshotBlock(PutSnapshotBlockRequest request)

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.

Specified by:

putSnapshotBlock in interface AmazonEBS

Parameters:

putSnapshotBlockRequest -

Returns:

Result of the PutSnapshotBlock operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints of the EBS direct APIs.

ResourceNotFoundException - The specified resource does not exist.

RequestThrottledException - The number of API requests has exceeded the maximum allowed API request throttling limit for the snapshot. For more information see Error retries.

ServiceQuotaExceededException - Your current service quotas do not allow you to perform this action.

InternalServerException - An internal error has occurred. For more information see Error retries.

See Also:

AWS API Documentation

startSnapshot

public StartSnapshotResult startSnapshot(StartSnapshotRequest request)

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.

Specified by:

startSnapshot in interface AmazonEBS

Parameters:

startSnapshotRequest -

Returns:

Result of the StartSnapshot operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints of the EBS direct APIs.

RequestThrottledException - The number of API requests has exceeded the maximum allowed API request throttling limit for the snapshot. For more information see Error retries.

ResourceNotFoundException - The specified resource does not exist.

ServiceQuotaExceededException - Your current service quotas do not allow you to perform this action.

InternalServerException - An internal error has occurred. For more information see Error retries.

ConcurrentLimitExceededException - You have reached the limit for concurrent API requests. For more information, see Optimizing performance of the EBS direct APIs in the Amazon Elastic Compute Cloud User Guide.

ConflictException - The request uses the same client token as a previous, but non-identical request.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonEBS

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonEBS

Overrides:

shutdown in class AmazonWebServiceClient