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 (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
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonEBSClientBuilder	builder()
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 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 request) Returns the block indexes and block tokens for blocks in an Amazon Elastic Block Store snapshot.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

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

shutdown

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AmazonEBSClientBuilder builder()

getSnapshotBlock

public GetSnapshotBlockResult getSnapshotBlock(GetSnapshotBlockRequest request)

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

Specified by:

getSnapshotBlock in interface AmazonEBS

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

public ListChangedBlocksResult listChangedBlocks(ListChangedBlocksRequest request)

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.

Specified by:

listChangedBlocks in interface AmazonEBS

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

public ListSnapshotBlocksResult listSnapshotBlocks(ListSnapshotBlocksRequest request)

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

Specified by:

listSnapshotBlocks in interface AmazonEBS

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

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.