com.amazonaws.services.backupstorage

Interface AWSBackupStorage

All Known Subinterfaces:

AWSBackupStorageAsync

All Known Implementing Classes:

AbstractAWSBackupStorage, AbstractAWSBackupStorageAsync, AWSBackupStorageAsyncClient, AWSBackupStorageClient

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

Interface for accessing AWS Backup Storage.

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

The frontend service for Cryo Storage.

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
DeleteObjectResult	deleteObject(DeleteObjectRequest deleteObjectRequest) Delete Object from the incremental base Backup.
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.
GetChunkResult	getChunk(GetChunkRequest getChunkRequest) Gets the specified object's chunk.
GetObjectMetadataResult	getObjectMetadata(GetObjectMetadataRequest getObjectMetadataRequest) Get metadata associated with an Object.
ListChunksResult	listChunks(ListChunksRequest listChunksRequest) List chunks in a given Object
ListObjectsResult	listObjects(ListObjectsRequest listObjectsRequest) List all Objects in a given Backup.
NotifyObjectCompleteResult	notifyObjectComplete(NotifyObjectCompleteRequest notifyObjectCompleteRequest) Complete upload
PutChunkResult	putChunk(PutChunkRequest putChunkRequest) Upload chunk.
PutObjectResult	putObject(PutObjectRequest putObjectRequest) Upload object that can store object metadata String and data blob in single API call using inline chunk field.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartObjectResult	startObject(StartObjectRequest startObjectRequest) Start upload containing one or many chunks.

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

deleteObject

DeleteObjectResult deleteObject(DeleteObjectRequest deleteObjectRequest)

Delete Object from the incremental base Backup.

Parameters:

deleteObjectRequest -

Returns:

Result of the DeleteObject operation returned by the service.

Throws:

ServiceUnavailableException - Retryable exception, indicates internal server error.

ServiceInternalException - Deprecated. To be removed from the model.

RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.

IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.

ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.

AccessDeniedException

See Also:

AWS API Documentation

getChunk

GetChunkResult getChunk(GetChunkRequest getChunkRequest)

Gets the specified object's chunk.

Parameters:

getChunkRequest -

Returns:

Result of the GetChunk operation returned by the service.

Throws:

IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.

ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.

ServiceInternalException - Deprecated. To be removed from the model.

ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.

KMSInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.

AccessDeniedException

See Also:

AWS API Documentation

getObjectMetadata

GetObjectMetadataResult getObjectMetadata(GetObjectMetadataRequest getObjectMetadataRequest)

Get metadata associated with an Object.

Parameters:

getObjectMetadataRequest -

Returns:

Result of the GetObjectMetadata operation returned by the service.

Throws:

ServiceUnavailableException - Retryable exception, indicates internal server error.

ServiceInternalException - Deprecated. To be removed from the model.

ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.

RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.

IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.

KMSInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.

AccessDeniedException

See Also:

AWS API Documentation

listChunks

ListChunksResult listChunks(ListChunksRequest listChunksRequest)

List chunks in a given Object

Parameters:

listChunksRequest -

Returns:

Result of the ListChunks operation returned by the service.

Throws:

ServiceUnavailableException - Retryable exception, indicates internal server error.

ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.

ServiceInternalException - Deprecated. To be removed from the model.

RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.

IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

AccessDeniedException

See Also:

AWS API Documentation

listObjects

ListObjectsResult listObjects(ListObjectsRequest listObjectsRequest)

List all Objects in a given Backup.

Parameters:

listObjectsRequest -

Returns:

Result of the ListObjects operation returned by the service.

Throws:

ServiceUnavailableException - Retryable exception, indicates internal server error.

ServiceInternalException - Deprecated. To be removed from the model.

RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.

IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.

ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.

KMSInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.

AccessDeniedException

See Also:

AWS API Documentation

notifyObjectComplete

NotifyObjectCompleteResult notifyObjectComplete(NotifyObjectCompleteRequest notifyObjectCompleteRequest)

Complete upload

Parameters:

notifyObjectCompleteRequest -

Returns:

Result of the NotifyObjectComplete operation returned by the service.

Throws:

ServiceUnavailableException - Retryable exception, indicates internal server error.

ServiceInternalException - Deprecated. To be removed from the model.

NotReadableInputStreamException - Retryalble exception. Indicated issues while reading an input stream due to the networking issues or connection drop on the client side.

RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.

IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.

KMSInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.

AccessDeniedException

See Also:

AWS API Documentation

putChunk

PutChunkResult putChunk(PutChunkRequest putChunkRequest)

Upload chunk.

Parameters:

putChunkRequest -

Returns:

Result of the PutChunk operation returned by the service.

Throws:

ServiceUnavailableException - Retryable exception, indicates internal server error.

ServiceInternalException - Deprecated. To be removed from the model.

NotReadableInputStreamException - Retryalble exception. Indicated issues while reading an input stream due to the networking issues or connection drop on the client side.

RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.

IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.

KMSInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.

AccessDeniedException

See Also:

AWS API Documentation

putObject

PutObjectResult putObject(PutObjectRequest putObjectRequest)

Upload object that can store object metadata String and data blob in single API call using inline chunk field.

Parameters:

putObjectRequest -

Returns:

Result of the PutObject operation returned by the service.

Throws:

ServiceUnavailableException - Retryable exception, indicates internal server error.

ServiceInternalException - Deprecated. To be removed from the model.

NotReadableInputStreamException - Retryalble exception. Indicated issues while reading an input stream due to the networking issues or connection drop on the client side.

RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.

IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.

KMSInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.

AccessDeniedException

See Also:

AWS API Documentation

startObject

StartObjectResult startObject(StartObjectRequest startObjectRequest)

Start upload containing one or many chunks.

Parameters:

startObjectRequest -

Returns:

Result of the StartObject operation returned by the service.

Throws:

ServiceUnavailableException - Retryable exception, indicates internal server error.

ServiceInternalException - Deprecated. To be removed from the model.

RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.

IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.

DataAlreadyExistsException - Non-retryable exception. Attempted to create already existing object or chunk. This message contains a checksum of already presented data.

ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.

AccessDeniedException

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.