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 (EBS) direct APIs to directly read the data on your EBS snapshots, and identify the difference between two snapshots. You can view the details of blocks in an EBS snapshot, compare the block difference between two snapshots, and directly access the data in a snapshot. If you’re an independent software vendor (ISV) who offers backup services for EBS, the EBS direct APIs makes it easier and more cost-effective to track incremental changes on your EBS volumes via EBS snapshots. This can be done without having to create new volumes from EBS snapshots, and then use EC2 instances to compare the differences.

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 EBS Snapshot. For more information about how to use the EBS direct APIs, see the EBS direct APIs User Guide. To view the currently supported AWS Regions and endpoints for the EBS direct APIs, see AWS Service Endpoints in the AWS 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
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 the block indexes and block tokens for blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.
ListSnapshotBlocksResult	listSnapshotBlocks(ListSnapshotBlocksRequest listSnapshotBlocksRequest) Returns the block indexes and block tokens for blocks in an Amazon Elastic Block Store snapshot.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

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

getSnapshotBlock

GetSnapshotBlockResult getSnapshotBlock(GetSnapshotBlockRequest getSnapshotBlockRequest)

Returns the data in a block in an Amazon Elastic Block Store snapshot.

Parameters:

getSnapshotBlockRequest -

Returns:

Result of the GetSnapshotBlock operation returned by the service.

Throws:

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

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

listChangedBlocks

ListChangedBlocksResult listChangedBlocks(ListChangedBlocksRequest listChangedBlocksRequest)

Returns the block indexes and block tokens for blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.

Parameters:

listChangedBlocksRequest -

Returns:

Result of the ListChangedBlocks operation returned by the service.

Throws:

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

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

listSnapshotBlocks

ListSnapshotBlocksResult listSnapshotBlocks(ListSnapshotBlocksRequest listSnapshotBlocksRequest)

Returns the block indexes and block tokens for blocks in an Amazon Elastic Block Store snapshot.

Parameters:

listSnapshotBlocksRequest -

Returns:

Result of the ListSnapshotBlocks operation returned by the service.

Throws:

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

ResourceNotFoundException - The specified resource does not exist.

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.