com.amazonaws.services.ebs

Interface AmazonEBS

All Known Subinterfaces:

AmazonEBSAsync

All Known Implementing Classes:

AbstractAmazonEBS, AbstractAmazonEBSAsync, AmazonEBSAsyncClient, AmazonEBSClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonEBS

Interface for accessing Amazon EBS.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonEBS instead.

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

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CompleteSnapshotResult	completeSnapshot(CompleteSnapshotRequest completeSnapshotRequest) 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 getSnapshotBlockRequest) Returns the data in a block in an Amazon Elastic Block Store snapshot.
ListChangedBlocksResult	listChangedBlocks(ListChangedBlocksRequest listChangedBlocksRequest) Returns information about the blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.
ListSnapshotBlocksResult	listSnapshotBlocks(ListSnapshotBlocksRequest listSnapshotBlocksRequest) Returns information about the blocks in an Amazon Elastic Block Store snapshot.
PutSnapshotBlockResult	putSnapshotBlock(PutSnapshotBlockRequest putSnapshotBlockRequest) 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 startSnapshotRequest) Creates a new Amazon EBS snapshot.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

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 Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

completeSnapshot

CompleteSnapshotResult completeSnapshot(CompleteSnapshotRequest completeSnapshotRequest)

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.

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

GetSnapshotBlockResult getSnapshotBlock(GetSnapshotBlockRequest getSnapshotBlockRequest)

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.

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

ListChangedBlocksResult listChangedBlocks(ListChangedBlocksRequest listChangedBlocksRequest)

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.

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

ListSnapshotBlocksResult listSnapshotBlocks(ListSnapshotBlocksRequest listSnapshotBlocksRequest)

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.

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

PutSnapshotBlockResult putSnapshotBlock(PutSnapshotBlockRequest putSnapshotBlockRequest)

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.

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

StartSnapshotResult startSnapshot(StartSnapshotRequest startSnapshotRequest)

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.

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

shutdown

void shutdown()

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.

getCachedResponseMetadata

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

Parameters:

request - The originally executed request.

Returns:

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