public class AmazonGlacierClient extends AmazonWebServiceClient implements AmazonGlacier
Amazon Glacier is a storage solution for "cold data."
Amazon Glacier is an extremely low-cost storage service that provides secure, durable, and easy-to-use storage for data backup and archival. With Amazon Glacier, customers can store their data cost effectively for months, years, or decades. Amazon Glacier also enables customers to offload the administrative burdens of operating and scaling storage to AWS, so they don't have to worry about capacity planning, hardware provisioning, data replication, hardware failure and recovery, or time-consuming hardware migrations.
Amazon Glacier is a great storage choice when low storage cost is paramount, your data is rarely retrieved, and retrieval latency of several hours is acceptable. If your application requires fast or frequent access to your data, consider using Amazon S3. For more information, go to Amazon Simple Storage Service (Amazon S3) .
You can store any kind of data in any format. There is no maximum limit on the total amount of data you can store in Amazon Glacier.
If you are a first-time user of Amazon Glacier, we recommend that you begin by reading the following sections in the Amazon Glacier Developer Guide :
What is Amazon Glacier - This section of the Developer Guide describes the underlying data model, the operations it supports, and the AWS SDKs that you can use to interact with the service.
Getting Started with Amazon Glacier - The Getting Started section walks you through the process of creating a vault, uploading archives, creating jobs to download archives, retrieving the job output, and deleting archives.
| Modifier and Type | Field and Description |
|---|---|
protected List<com.amazonaws.transform.GlacierErrorUnmarshaller> |
jsonErrorUnmarshallers
List of exception unmarshallers for all AmazonGlacier exceptions.
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset| Constructor and Description |
|---|
AmazonGlacierClient()
Constructs a new client to invoke service methods on
AmazonGlacier.
|
AmazonGlacierClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on
AmazonGlacier using the specified AWS account credentials.
|
AmazonGlacierClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonGlacier using the specified AWS account credentials
and client configuration options.
|
AmazonGlacierClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on
AmazonGlacier using the specified AWS account credentials provider.
|
AmazonGlacierClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonGlacier using the specified AWS account credentials
provider and client configuration options.
|
AmazonGlacierClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on
AmazonGlacier using the specified AWS account credentials
provider, client configuration options and request metric collector.
|
AmazonGlacierClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonGlacier.
|
| Modifier and Type | Method and Description |
|---|---|
void |
abortMultipartUpload(AbortMultipartUploadRequest abortMultipartUploadRequest)
This operation aborts a multipart upload identified by the upload ID.
|
CompleteMultipartUploadResult |
completeMultipartUpload(CompleteMultipartUploadRequest completeMultipartUploadRequest)
You call this operation to inform Amazon Glacier that all the archive
parts have been uploaded and that Amazon Glacier can now assemble the
archive from the uploaded parts.
|
CreateVaultResult |
createVault(CreateVaultRequest createVaultRequest)
This operation creates a new vault with the specified name.
|
void |
deleteArchive(DeleteArchiveRequest deleteArchiveRequest)
This operation deletes an archive from a vault.
|
void |
deleteVault(DeleteVaultRequest deleteVaultRequest)
This operation deletes a vault.
|
void |
deleteVaultNotifications(DeleteVaultNotificationsRequest deleteVaultNotificationsRequest)
This operation deletes the notification configuration set for a
vault.
|
DescribeJobResult |
describeJob(DescribeJobRequest describeJobRequest)
This operation returns information about a job you previously
initiated, including the job initiation date, the user who initiated
the job, the job status code/message and the Amazon SNS topic to
notify after Amazon Glacier completes the job.
|
DescribeVaultResult |
describeVault(DescribeVaultRequest describeVaultRequest)
This operation returns information about a vault, including the
vault's Amazon Resource Name (ARN), the date the vault was created,
the number of archives it contains, and the total size of all the
archives in the vault.
|
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.
|
GetJobOutputResult |
getJobOutput(GetJobOutputRequest getJobOutputRequest)
This operation downloads the output of the job you initiated using
InitiateJob.
|
GetVaultNotificationsResult |
getVaultNotifications(GetVaultNotificationsRequest getVaultNotificationsRequest)
This operation retrieves the
notification-configuration
subresource of the specified vault. |
InitiateJobResult |
initiateJob(InitiateJobRequest initiateJobRequest)
This operation initiates a job of the specified type.
|
InitiateMultipartUploadResult |
initiateMultipartUpload(InitiateMultipartUploadRequest initiateMultipartUploadRequest)
This operation initiates a multipart upload.
|
ListJobsResult |
listJobs(ListJobsRequest listJobsRequest)
This operation lists jobs for a vault, including jobs that are
in-progress and jobs that have recently finished.
|
ListMultipartUploadsResult |
listMultipartUploads(ListMultipartUploadsRequest listMultipartUploadsRequest)
This operation lists in-progress multipart uploads for the specified
vault.
|
ListPartsResult |
listParts(ListPartsRequest listPartsRequest)
This operation lists the parts of an archive that have been uploaded
in a specific multipart upload.
|
ListVaultsResult |
listVaults(ListVaultsRequest listVaultsRequest)
This operation lists all vaults owned by the calling user's account.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://glacier.us-east-1.amazonaws.com").
|
void |
setEndpoint(String endpoint,
String serviceName,
String regionId) |
void |
setVaultNotifications(SetVaultNotificationsRequest setVaultNotificationsRequest)
This operation configures notifications that will be sent when
specific events happen to a vault.
|
UploadArchiveResult |
uploadArchive(UploadArchiveRequest uploadArchiveRequest)
This operation adds an archive to a vault.
|
UploadMultipartPartResult |
uploadMultipartPart(UploadMultipartPartRequest uploadMultipartPartRequest)
This operation uploads a part of an archive.
|
addRequestHandler, addRequestHandler, configSigner, configSigner, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetRegion, shutdownprotected List<com.amazonaws.transform.GlacierErrorUnmarshaller> jsonErrorUnmarshallers
public AmazonGlacierClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChainpublic AmazonGlacierClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this
client connects to AmazonGlacier
(ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChainpublic AmazonGlacierClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.public AmazonGlacierClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this
client connects to AmazonGlacier
(ex: proxy settings, retry counts, etc.).public AmazonGlacierClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.public AmazonGlacierClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this
client connects to AmazonGlacier
(ex: proxy settings, retry counts, etc.).public AmazonGlacierClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this
client connects to AmazonGlacier
(ex: proxy settings, retry counts, etc.).requestMetricCollector - optional request metric collectorpublic ListVaultsResult listVaults(ListVaultsRequest listVaultsRequest)
This operation lists all vaults owned by the calling user's account. The list returned in the response is ASCII-sorted by vault name.
By default, this operation returns up to 1,000 items. If there are
more vaults to list, the response marker field contains
the vault Amazon Resource Name (ARN) at which to continue the list
with a new List Vaults request; otherwise, the marker
field is null . To return a list of vaults that begins at
a specific vault, set the marker request parameter to the
vault ARN you obtained from a previous List Vaults request. You can
also limit the number of vaults returned in the response by specifying
the limit parameter in the request.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .
For conceptual information and underlying REST API, go to Retrieving Vault Metadata in Amazon Glacier and List Vaults in the Amazon Glacier Developer Guide .
listVaults in interface AmazonGlacierlistVaultsRequest - Container for the necessary parameters to
execute the ListVaults service method on AmazonGlacier.ResourceNotFoundExceptionMissingParameterValueExceptionServiceUnavailableExceptionInvalidParameterValueExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonGlacier indicating
either a problem with the data in the request, or a server side issue.public DescribeJobResult describeJob(DescribeJobRequest describeJobRequest)
This operation returns information about a job you previously initiated, including the job initiation date, the user who initiated the job, the job status code/message and the Amazon SNS topic to notify after Amazon Glacier completes the job. For more information about initiating a job, see InitiateJob.
NOTE: This operation enables you to check the status of your job. However, it is strongly recommended that you set up an Amazon SNS topic and specify it in your initiate job request so that Amazon Glacier can notify the topic after it completes the job.
A job ID will not expire for at least 24 hours after Amazon Glacier completes the job.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .
For information about the underlying REST API, go to Working with Archives in Amazon Glacier in the Amazon Glacier Developer Guide .
describeJob in interface AmazonGlacierdescribeJobRequest - Container for the necessary parameters to
execute the DescribeJob service method on AmazonGlacier.ResourceNotFoundExceptionMissingParameterValueExceptionServiceUnavailableExceptionInvalidParameterValueExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonGlacier indicating
either a problem with the data in the request, or a server side issue.public ListPartsResult listParts(ListPartsRequest listPartsRequest)
This operation lists the parts of an archive that have been uploaded in a specific multipart upload. You can make this request at any time during an in-progress multipart upload before you complete the upload (see CompleteMultipartUpload. List Parts returns an error for completed uploads. The list returned in the List Parts response is sorted by part range.
The List Parts operation supports pagination. By default, this
operation returns up to 1,000 uploaded parts in the response. You
should always check the response for a marker at which to
continue the list; if there are no more items the marker
is null . To return a list of parts that begins at a
specific part, set the marker request parameter to the
value you obtained from a previous List Parts request. You can also
limit the number of parts returned in the response by specifying the
limit parameter in the request.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .
For conceptual information and the underlying REST API, go to Working with Archives in Amazon Glacier and List Parts in the Amazon Glacier Developer Guide .
listParts in interface AmazonGlacierlistPartsRequest - Container for the necessary parameters to
execute the ListParts service method on AmazonGlacier.ResourceNotFoundExceptionMissingParameterValueExceptionServiceUnavailableExceptionInvalidParameterValueExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonGlacier indicating
either a problem with the data in the request, or a server side issue.public GetVaultNotificationsResult getVaultNotifications(GetVaultNotificationsRequest getVaultNotificationsRequest)
This operation retrieves the notification-configuration
subresource of the specified vault.
For information about setting a notification configuration on a
vault, see SetVaultNotifications. If a notification configuration for
a vault is not set, the operation returns a 404 Not Found
error. For more information about vault notifications, see
Configuring Vault Notifications in Amazon Glacier
.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .
For conceptual information and underlying REST API, go to Configuring Vault Notifications in Amazon Glacier and Get Vault Notification Configuration in the Amazon Glacier Developer Guide .
getVaultNotifications in interface AmazonGlaciergetVaultNotificationsRequest - Container for the necessary
parameters to execute the GetVaultNotifications service method on
AmazonGlacier.ResourceNotFoundExceptionMissingParameterValueExceptionServiceUnavailableExceptionInvalidParameterValueExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonGlacier indicating
either a problem with the data in the request, or a server side issue.public ListJobsResult listJobs(ListJobsRequest listJobsRequest)
This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished.
NOTE: Amazon Glacier retains recently completed jobs for a period before deleting them; however, it eventually removes completed jobs. The output of completed jobs can be retrieved. Retaining completed jobs for a period of time after they have completed enables you to get a job output in the event you miss the job completion notification or your first attempt to download it fails. For example, suppose you start an archive retrieval job to download an archive. After the job completes, you start to download the archive but encounter a network error. In this scenario, you can retry and download the archive while the job exists.
To retrieve an archive or retrieve a vault inventory from Amazon Glacier, you first initiate a job, and after the job completes, you download the data. For an archive retrieval, the output is the archive data, and for an inventory retrieval, it is the inventory list. The List Job operation returns a list of these jobs sorted by job initiation time.
This List Jobs operation supports pagination. By default, this
operation returns up to 1,000 jobs in the response. You should always
check the response for a marker at which to continue the
list; if there are no more items the marker is
null . To return a list of jobs that begins at a specific
job, set the marker request parameter to the value you
obtained from a previous List Jobs request. You can also limit the
number of jobs returned in the response by specifying the
limit parameter in the request.
Additionally, you can filter the jobs list returned by specifying an
optional statuscode (InProgress, Succeeded, or Failed)
and completed (true, false) parameter. The
statuscode allows you to specify that only jobs that
match a specified status are returned. The completed
parameter allows you to specify that only jobs in a specific
completion state are returned.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .
For the underlying REST API, go to List Jobs
listJobs in interface AmazonGlacierlistJobsRequest - Container for the necessary parameters to
execute the ListJobs service method on AmazonGlacier.ResourceNotFoundExceptionMissingParameterValueExceptionServiceUnavailableExceptionInvalidParameterValueExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonGlacier indicating
either a problem with the data in the request, or a server side issue.public CreateVaultResult createVault(CreateVaultRequest createVaultRequest)
This operation creates a new vault with the specified name. The name of the vault must be unique within a region for an AWS account. You can create up to 1,000 vaults per account. If you need to create more vaults, contact Amazon Glacier.
You must use the following guidelines when naming a vault.
Names can be between 1 and 255 characters long.
Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period).
This operation is idempotent.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .
For conceptual information and underlying REST API, go to Creating a Vault in Amazon Glacier and Create Vault in the Amazon Glacier Developer Guide .
createVault in interface AmazonGlaciercreateVaultRequest - Container for the necessary parameters to
execute the CreateVault service method on AmazonGlacier.MissingParameterValueExceptionServiceUnavailableExceptionInvalidParameterValueExceptionLimitExceededExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonGlacier indicating
either a problem with the data in the request, or a server side issue.public InitiateMultipartUploadResult initiateMultipartUpload(InitiateMultipartUploadRequest initiateMultipartUploadRequest)
This operation initiates a multipart upload. Amazon Glacier creates a multipart upload resource and returns its ID in the response. The multipart upload ID is used in subsequent requests to upload parts of an archive (see UploadMultipartPart).
When you initiate a multipart upload, you specify the part size in number of bytes. The part size must be a megabyte (1024 KB) multiplied by a power of 2-for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB.
Every part you upload to this resource (see UploadMultipartPart), except the last one, must have the same size. The last one can be the same size or smaller. For example, suppose you want to upload a 16.2 MB file. If you initiate the multipart upload with a part size of 4 MB, you will upload four parts of 4 MB each and one part of 0.2 MB.
NOTE: You don't need to know the size of the archive when you start a multipart upload because Amazon Glacier does not require you to specify the overall archive size.
After you complete the multipart upload, Amazon Glacier removes the multipart upload resource referenced by the ID. Amazon Glacier also removes the multipart upload resource if you cancel the multipart upload or it may be removed if there is no activity for a period of 24 hours.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .
For conceptual information and underlying REST API, go to Uploading Large Archives in Parts (Multipart Upload) and Initiate Multipart Upload in the Amazon Glacier Developer Guide .
initiateMultipartUpload in interface AmazonGlacierinitiateMultipartUploadRequest - Container for the necessary
parameters to execute the InitiateMultipartUpload service method on
AmazonGlacier.ResourceNotFoundExceptionMissingParameterValueExceptionServiceUnavailableExceptionInvalidParameterValueExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonGlacier indicating
either a problem with the data in the request, or a server side issue.public void abortMultipartUpload(AbortMultipartUploadRequest abortMultipartUploadRequest)
This operation aborts a multipart upload identified by the upload ID.
After the Abort Multipart Upload request succeeds, you cannot upload any more parts to the multipart upload or complete the multipart upload. Aborting a completed upload fails. However, aborting an already-aborted upload will succeed, for a short time. For more information about uploading a part and completing a multipart upload, see UploadMultipartPart and CompleteMultipartUpload.
This operation is idempotent.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .
For conceptual information and underlying REST API, go to Working with Archives in Amazon Glacier and Abort Multipart Upload in the Amazon Glacier Developer Guide .
abortMultipartUpload in interface AmazonGlacierabortMultipartUploadRequest - Container for the necessary
parameters to execute the AbortMultipartUpload service method on
AmazonGlacier.ResourceNotFoundExceptionMissingParameterValueExceptionServiceUnavailableExceptionInvalidParameterValueExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonGlacier indicating
either a problem with the data in the request, or a server side issue.public void deleteArchive(DeleteArchiveRequest deleteArchiveRequest)
This operation deletes an archive from a vault. Subsequent requests to initiate a retrieval of this archive will fail. Archive retrievals that are in progress for this archive ID may or may not succeed according to the following scenarios:
This operation is idempotent. Attempting to delete an already-deleted archive does not result in an error.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .
For conceptual information and underlying REST API, go to Deleting an Archive in Amazon Glacier and Delete Archive in the Amazon Glacier Developer Guide .
deleteArchive in interface AmazonGlacierdeleteArchiveRequest - Container for the necessary parameters to
execute the DeleteArchive service method on AmazonGlacier.ResourceNotFoundExceptionMissingParameterValueExceptionServiceUnavailableExceptionInvalidParameterValueExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonGlacier indicating
either a problem with the data in the request, or a server side issue.public GetJobOutputResult getJobOutput(GetJobOutputRequest getJobOutputRequest)
This operation downloads the output of the job you initiated using InitiateJob. Depending on the job type you specified when you initiated the job, the output will be either the content of an archive or a vault inventory.
A job ID will not expire for at least 24 hours after Amazon Glacier completes the job. That is, you can download the job output within the 24 hours period after Amazon Glacier completes the job.
If the job output is large, then you can use the Range
request header to retrieve a portion of the output. This allows you to
download the entire output in smaller chunks of bytes. For example,
suppose you have 1 GB of job output you want to download and you
decide to download 128 MB chunks of data at a time, which is a total
of eight Get Job Output requests. You use the following process to
download the job output:
Download a 128 MB chunk of output by specifying the appropriate byte
range using the Range header.
Along with the data, the response includes a checksum of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data.
Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range.
After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the DescribeJob API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .
For conceptual information and the underlying REST API, go to Downloading a Vault Inventory , Downloading an Archive , and Get Job Output
getJobOutput in interface AmazonGlaciergetJobOutputRequest - Container for the necessary parameters to
execute the GetJobOutput service method on AmazonGlacier.ResourceNotFoundExceptionMissingParameterValueExceptionServiceUnavailableExceptionInvalidParameterValueExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonGlacier indicating
either a problem with the data in the request, or a server side issue.public InitiateJobResult initiateJob(InitiateJobRequest initiateJobRequest)
This operation initiates a job of the specified type. In this release, you can initiate a job to retrieve either an archive or a vault inventory (a list of archives in a vault).
Retrieving data from Amazon Glacier is a two-step process:
Initiate a retrieval job.
After the job completes, download the bytes.
The retrieval request is executed asynchronously. When you initiate a retrieval job, Amazon Glacier creates a job and returns a job ID in the response. When Amazon Glacier completes the job, you can get the job output (archive or inventory data). For information about getting job output, see GetJobOutput operation.
The job must complete before you can get its output. To determine when a job is complete, you have the following options:
Use Amazon SNS Notification You can specify an Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Glacier can post a notification after the job is completed. You can specify an SNS topic per job request. The notification is sent only after Amazon Glacier completes the job. In addition to specifying an SNS topic per job request, you can configure vault notifications for a vault so that job notifications are always sent. For more information, see SetVaultNotifications.
Get job details You can make a DescribeJob request to obtain job status information while a job is in progress. However, it is more efficient to use an Amazon SNS notification to determine when a job is complete.
NOTE: The information you get via notification is same that you get by calling DescribeJob.
If for a specific event, you add both the notification configuration on the vault and also specify an SNS topic in your initiate job request, Amazon Glacier sends both notifications. For more information, see SetVaultNotifications.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .
About the Vault Inventory
Amazon Glacier prepares an inventory for each vault periodically, every 24 hours. When you initiate a job for a vault inventory, Amazon Glacier returns the last inventory for the vault. The inventory data you get might be up to a day or two days old. Also, the initiate inventory job might take some time to complete before you can download the vault inventory. So you do not want to retrieve a vault inventory for each vault operation. However, in some scenarios, you might find the vault inventory useful. For example, when you upload an archive, you can provide an archive description but not an archive name. Amazon Glacier provides you a unique archive ID, an opaque string of characters. So, you might maintain your own database that maps archive names to their corresponding Amazon Glacier assigned archive IDs. You might find the vault inventory useful in the event you need to reconcile information in your database with the actual vault inventory.
Range Inventory Retrieval
You can limit the number of inventory items retrieved by filtering on the archive creation date or by setting a limit.
Filtering by Archive Creation Date
You can retrieve inventory items for archives created between
StartDate and EndDate by specifying values
for these parameters in the InitiateJob request. Archives
created on or after the StartDate and before the
EndDate will be returned. If you only provide the
StartDate without the EndDate , you will
retrieve the inventory for all archives created on or after the
StartDate . If you only provide the EndDate
without the StartDate , you will get back the inventory
for all archives created before the EndDate .
Limiting Inventory Items per Retrieval
You can limit the number of inventory items returned by setting the
Limit parameter in the InitiateJob request. The
inventory job output will contain inventory items up to the specified
Limit . If there are more inventory items available, the
result is paginated. After a job is complete you can use the
DescribeJob operation to get a marker that you use in a subsequent
InitiateJob request. The marker will indicate the starting
point to retrieve the next set of inventory items. You can page
through your entire inventory by repeatedly making InitiateJob
requests with the marker from the previous DescribeJob output,
until you get a marker from DescribeJob that returns null,
indicating that there are no more inventory items available.
You can use the Limit parameter together with the date
range parameters.
About Ranged Archive Retrieval
You can initiate an archive retrieval for the whole archive or a range of the archive. In the case of ranged archive retrieval, you specify a byte range to return or the whole archive. The range specified must be megabyte (MB) aligned, that is the range start value must be divisible by 1 MB and range end value plus 1 must be divisible by 1 MB or equal the end of the archive. If the ranged archive retrieval is not megabyte aligned, this operation returns a 400 response. Furthermore, to ensure you get checksum values for data you download using Get Job Output API, the range must be tree hash aligned.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .
For conceptual information and the underlying REST API, go to Initiate a Job and Downloading a Vault Inventory
initiateJob in interface AmazonGlacierinitiateJobRequest - Container for the necessary parameters to
execute the InitiateJob service method on AmazonGlacier.ResourceNotFoundExceptionMissingParameterValueExceptionServiceUnavailableExceptionInvalidParameterValueExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonGlacier indicating
either a problem with the data in the request, or a server side issue.public UploadArchiveResult uploadArchive(UploadArchiveRequest uploadArchiveRequest)
This operation adds an archive to a vault. This is a synchronous
operation, and for a successful upload, your data is durably
persisted. Amazon Glacier returns the archive ID in the
x-amz-archive-id header of the response.
You must use the archive ID to access your data in Amazon Glacier. After you upload an archive, you should save the archive ID returned so that you can retrieve or delete the archive later. Besides saving the archive ID, you can also index it and give it a friendly name to allow for better searching. You can also use the optional archive description field to specify how the archive is referred to in an external index of archives, such as you might create in Amazon DynamoDB. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob.
You must provide a SHA256 tree hash of the data you are uploading. For information about computing a SHA256 tree hash, see Computing Checksums .
You can optionally specify an archive description of up to 1,024 printable ASCII characters. You can get the archive description when you either retrieve the archive or get the vault inventory. For more information, see InitiateJob. Amazon Glacier does not interpret the description in any way. An archive description does not need to be unique. You cannot use the description to retrieve or sort the archive list.
Archives are immutable. After you upload an archive, you cannot edit the archive or its description.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .
For conceptual information and underlying REST API, go to Uploading an Archive in Amazon Glacier and Upload Archive in the Amazon Glacier Developer Guide .
uploadArchive in interface AmazonGlacieruploadArchiveRequest - Container for the necessary parameters to
execute the UploadArchive service method on AmazonGlacier.ResourceNotFoundExceptionMissingParameterValueExceptionRequestTimeoutExceptionServiceUnavailableExceptionInvalidParameterValueExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonGlacier indicating
either a problem with the data in the request, or a server side issue.public void setVaultNotifications(SetVaultNotificationsRequest setVaultNotificationsRequest)
This operation configures notifications that will be sent when specific events happen to a vault. By default, you don't get any notifications.
To configure vault notifications, send a PUT request to the
notification-configuration subresource of the vault. The
request should include a JSON document that provides an Amazon SNS
topic and specific events for which you want Amazon Glacier to send
notifications to the topic.
Amazon SNS topics must grant permission to the vault to be allowed to publish notifications to the topic. You can configure a vault to publish a notification for the following vault events:
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .
For conceptual information and underlying REST API, go to Configuring Vault Notifications in Amazon Glacier and Set Vault Notification Configuration in the Amazon Glacier Developer Guide .
setVaultNotifications in interface AmazonGlaciersetVaultNotificationsRequest - Container for the necessary
parameters to execute the SetVaultNotifications service method on
AmazonGlacier.ResourceNotFoundExceptionMissingParameterValueExceptionServiceUnavailableExceptionInvalidParameterValueExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonGlacier indicating
either a problem with the data in the request, or a server side issue.public CompleteMultipartUploadResult completeMultipartUpload(CompleteMultipartUploadRequest completeMultipartUploadRequest)
You call this operation to inform Amazon Glacier that all the archive parts have been uploaded and that Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Amazon Glacier returns the URI path of the newly created archive resource. Using the URI path, you can then access the archive. After you upload an archive, you should save the archive ID returned to retrieve the archive at a later point. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob.
In the request, you must include the computed SHA256 tree hash of the entire archive you have uploaded. For information about computing a SHA256 tree hash, see Computing Checksums . On the server side, Amazon Glacier also constructs the SHA256 tree hash of the assembled archive. If the values match, Amazon Glacier saves the archive to the vault; otherwise, it returns an error, and the operation fails. The ListParts operation returns a list of parts uploaded for a specific multipart upload. It includes checksum information for each uploaded part that can be used to debug a bad checksum issue.
Additionally, Amazon Glacier also checks for any missing content ranges when assembling the archive, if missing content ranges are found, Amazon Glacier returns an error and the operation fails.
Complete Multipart Upload is an idempotent operation. After your first successful complete multipart upload, if you call the operation again within a short period, the operation will succeed and return the same archive ID. This is useful in the event you experience a network issue that causes an aborted connection or receive a 500 server error, in which case you can repeat your Complete Multipart Upload request and get the same archive ID without creating duplicate archives. Note, however, that after the multipart upload completes, you cannot call the List Parts operation and the multipart upload will not appear in List Multipart Uploads response, even if idempotent complete is possible.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .
For conceptual information and underlying REST API, go to Uploading Large Archives in Parts (Multipart Upload) and Complete Multipart Upload in the Amazon Glacier Developer Guide .
completeMultipartUpload in interface AmazonGlaciercompleteMultipartUploadRequest - Container for the necessary
parameters to execute the CompleteMultipartUpload service method on
AmazonGlacier.ResourceNotFoundExceptionMissingParameterValueExceptionServiceUnavailableExceptionInvalidParameterValueExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonGlacier indicating
either a problem with the data in the request, or a server side issue.public UploadMultipartPartResult uploadMultipartPart(UploadMultipartPartRequest uploadMultipartPartRequest)
This operation uploads a part of an archive. You can upload archive parts in any order. You can also upload them in parallel. You can upload up to 10,000 parts for a multipart upload.
Amazon Glacier rejects your upload part request if any of the following conditions is true:
SHA256 tree hash does not match To ensure that part data is not corrupted in transmission, you compute a SHA256 tree hash of the part and include it in your request. Upon receiving the part data, Amazon Glacier also computes a SHA256 tree hash. If these hash values don't match, the operation fails. For information about computing a SHA256 tree hash, see Computing Checksums .
Part size does not match The size of each part except the last must match the size specified in the corresponding InitiateMultipartUpload request. The size of the last part must be the same size as, or smaller than, the specified size.
NOTE: If you upload a part whose size is smaller than the part size you specified in your initiate multipart upload request and that part is not the last part, then the upload part request will succeed. However, the subsequent Complete Multipart Upload request will fail.
This operation is idempotent. If you upload the same part multiple times, the data included in the most recent request overwrites the previously uploaded data.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .
For conceptual information and underlying REST API, go to Uploading Large Archives in Parts (Multipart Upload) and Upload Part in the Amazon Glacier Developer Guide .
uploadMultipartPart in interface AmazonGlacieruploadMultipartPartRequest - Container for the necessary
parameters to execute the UploadMultipartPart service method on
AmazonGlacier.ResourceNotFoundExceptionMissingParameterValueExceptionRequestTimeoutExceptionServiceUnavailableExceptionInvalidParameterValueExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonGlacier indicating
either a problem with the data in the request, or a server side issue.public DescribeVaultResult describeVault(DescribeVaultRequest describeVaultRequest)
This operation returns information about a vault, including the vault's Amazon Resource Name (ARN), the date the vault was created, the number of archives it contains, and the total size of all the archives in the vault. The number of archives and their total size are as of the last inventory generation. This means that if you add or remove an archive from a vault, and then immediately use Describe Vault, the change in contents will not be immediately reflected. If you want to retrieve the latest inventory of the vault, use InitiateJob. Amazon Glacier generates vault inventories approximately daily. For more information, see Downloading a Vault Inventory in Amazon Glacier .
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .
For conceptual information and underlying REST API, go to Retrieving Vault Metadata in Amazon Glacier and Describe Vault in the Amazon Glacier Developer Guide .
describeVault in interface AmazonGlacierdescribeVaultRequest - Container for the necessary parameters to
execute the DescribeVault service method on AmazonGlacier.ResourceNotFoundExceptionMissingParameterValueExceptionServiceUnavailableExceptionInvalidParameterValueExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonGlacier indicating
either a problem with the data in the request, or a server side issue.public void deleteVaultNotifications(DeleteVaultNotificationsRequest deleteVaultNotificationsRequest)
This operation deletes the notification configuration set for a vault. The operation is eventually consistent;that is, it might take some time for Amazon Glacier to completely disable the notifications and you might still receive some notifications for a short time after you send the delete request.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .
For conceptual information and underlying REST API, go to Configuring Vault Notifications in Amazon Glacier and Delete Vault Notification Configuration in the Amazon Glacier Developer Guide.
deleteVaultNotifications in interface AmazonGlacierdeleteVaultNotificationsRequest - Container for the necessary
parameters to execute the DeleteVaultNotifications service method on
AmazonGlacier.ResourceNotFoundExceptionMissingParameterValueExceptionServiceUnavailableExceptionInvalidParameterValueExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonGlacier indicating
either a problem with the data in the request, or a server side issue.public ListMultipartUploadsResult listMultipartUploads(ListMultipartUploadsRequest listMultipartUploadsRequest)
This operation lists in-progress multipart uploads for the specified vault. An in-progress multipart upload is a multipart upload that has been initiated by an InitiateMultipartUpload request, but has not yet been completed or aborted. The list returned in the List Multipart Upload response has no guaranteed order.
The List Multipart Uploads operation supports pagination. By default,
this operation returns up to 1,000 multipart uploads in the response.
You should always check the response for a marker at
which to continue the list; if there are no more items the
marker is null . To return a list of
multipart uploads that begins at a specific upload, set the
marker request parameter to the value you obtained from a
previous List Multipart Upload request. You can also limit the number
of uploads returned in the response by specifying the
limit parameter in the request.
Note the difference between this operation and listing parts (ListParts). The List Multipart Uploads operation lists all multipart uploads for a vault and does not require a multipart upload ID. The List Parts operation requires a multipart upload ID since parts are associated with a single upload.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .
For conceptual information and the underlying REST API, go to Working with Archives in Amazon Glacier and List Multipart Uploads in the Amazon Glacier Developer Guide .
listMultipartUploads in interface AmazonGlacierlistMultipartUploadsRequest - Container for the necessary
parameters to execute the ListMultipartUploads service method on
AmazonGlacier.ResourceNotFoundExceptionMissingParameterValueExceptionServiceUnavailableExceptionInvalidParameterValueExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonGlacier indicating
either a problem with the data in the request, or a server side issue.public void deleteVault(DeleteVaultRequest deleteVaultRequest)
This operation deletes a vault. Amazon Glacier will delete a vault only if there are no archives in the vault as of the last inventory and there have been no writes to the vault since the last inventory. If either of these conditions is not satisfied, the vault deletion fails (that is, the vault is not removed) and Amazon Glacier returns an error. You can use DescribeVault to return the number of archives in a vault, and you can use Initiate a Job (POST jobs) to initiate a new inventory retrieval for a vault. The inventory contains the archive IDs you use to delete archives using Delete Archive (DELETE archive) .
This operation is idempotent.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .
For conceptual information and underlying REST API, go to Deleting a Vault in Amazon Glacier and Delete Vault in the Amazon Glacier Developer Guide .
deleteVault in interface AmazonGlacierdeleteVaultRequest - Container for the necessary parameters to
execute the DeleteVault service method on AmazonGlacier.ResourceNotFoundExceptionMissingParameterValueExceptionServiceUnavailableExceptionInvalidParameterValueExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonGlacier indicating
either a problem with the data in the request, or a server side issue.public void setEndpoint(String endpoint)
AmazonGlacier
Callers can pass in just the endpoint (ex: "glacier.us-east-1.amazonaws.com") or a full
URL, including the protocol (ex: "https://glacier.us-east-1.amazonaws.com"). If the
protocol is not specified here, the default protocol from this client's
ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint in interface AmazonGlaciersetEndpoint in class AmazonWebServiceClientendpoint - The endpoint (ex: "glacier.us-east-1.amazonaws.com") or a full URL,
including the protocol (ex: "https://glacier.us-east-1.amazonaws.com") of
the region specific AWS endpoint this client will communicate
with.public void setEndpoint(String endpoint, String serviceName, String regionId) throws IllegalArgumentException
setEndpoint in class AmazonWebServiceClientIllegalArgumentExceptionpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata in interface AmazonGlacierrequest - The originally executed requestCopyright © 2015. All rights reserved.