All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.glacier.AmazonGlacierClient Maven / Gradle / Ivy

Go to download

The Amazon Web Services SDK for Java provides Java APIs for building software on AWS' cost-effective, scalable, and reliable infrastructure products. The AWS Java SDK allows developers to code against APIs for all of Amazon's infrastructure web services (Amazon S3, Amazon EC2, Amazon SQS, Amazon Relational Database Service, Amazon AutoScaling, etc).

The newest version!
/*
 * Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 * 
 *  http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */
package com.amazonaws.services.glacier;

import java.net.*;
import java.util.*;

import org.apache.commons.logging.*;

import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.auth.*;
import com.amazonaws.handlers.*;
import com.amazonaws.http.*;
import com.amazonaws.regions.*;
import com.amazonaws.internal.*;
import com.amazonaws.metrics.*;
import com.amazonaws.transform.*;
import com.amazonaws.util.*;
import com.amazonaws.util.AWSRequestMetrics.Field;
import com.amazonaws.util.json.*;

import com.amazonaws.services.glacier.model.*;
import com.amazonaws.services.glacier.model.transform.*;

/**
 * Client for accessing AmazonGlacier.  All service calls made
 * using this client are blocking, and will not return until the service call
 * completes.
 * 

*

* 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. *

    *
  • * *
*/ public class AmazonGlacierClient extends AmazonWebServiceClient implements AmazonGlacier { /** Provider for AWS credentials. */ private AWSCredentialsProvider awsCredentialsProvider; private static final Log log = LogFactory.getLog(AmazonGlacier.class); /** * List of exception unmarshallers for all AmazonGlacier exceptions. */ protected List jsonErrorUnmarshallers; /** * Constructs a new client to invoke service methods on * AmazonGlacier. A credentials provider chain will be used * that searches for credentials in this order: *
    *
  • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
  • *
  • Java System Properties - aws.accessKeyId and aws.secretKey
  • *
  • Instance profile credentials delivered through the Amazon EC2 metadata service
  • *
* *

* All service calls made using this new client object are blocking, and will not * return until the service call completes. * * @see DefaultAWSCredentialsProviderChain */ public AmazonGlacierClient() { this(new DefaultAWSCredentialsProviderChain(), new ClientConfiguration()); } /** * Constructs a new client to invoke service methods on * AmazonGlacier. A credentials provider chain will be used * that searches for credentials in this order: *

    *
  • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
  • *
  • Java System Properties - aws.accessKeyId and aws.secretKey
  • *
  • Instance profile credentials delivered through the Amazon EC2 metadata service
  • *
* *

* All service calls made using this new client object are blocking, and will not * return until the service call completes. * * @param clientConfiguration The client configuration options controlling how this * client connects to AmazonGlacier * (ex: proxy settings, retry counts, etc.). * * @see DefaultAWSCredentialsProviderChain */ public AmazonGlacierClient(ClientConfiguration clientConfiguration) { this(new DefaultAWSCredentialsProviderChain(), clientConfiguration); } /** * Constructs a new client to invoke service methods on * AmazonGlacier using the specified AWS account credentials. * *

* All service calls made using this new client object are blocking, and will not * return until the service call completes. * * @param awsCredentials The AWS credentials (access key ID and secret key) to use * when authenticating with AWS services. */ public AmazonGlacierClient(AWSCredentials awsCredentials) { this(awsCredentials, new ClientConfiguration()); } /** * Constructs a new client to invoke service methods on * AmazonGlacier using the specified AWS account credentials * and client configuration options. * *

* All service calls made using this new client object are blocking, and will not * return until the service call completes. * * @param awsCredentials The AWS credentials (access key ID and secret key) to use * when authenticating with AWS services. * @param clientConfiguration The client configuration options controlling how this * client connects to AmazonGlacier * (ex: proxy settings, retry counts, etc.). */ public AmazonGlacierClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) { super(adjustClientConfiguration(clientConfiguration)); this.awsCredentialsProvider = new StaticCredentialsProvider(awsCredentials); init(); } /** * Constructs a new client to invoke service methods on * AmazonGlacier using the specified AWS account credentials provider. * *

* All service calls made using this new client object are blocking, and will not * return until the service call completes. * * @param awsCredentialsProvider * The AWS credentials provider which will provide credentials * to authenticate requests with AWS services. */ public AmazonGlacierClient(AWSCredentialsProvider awsCredentialsProvider) { this(awsCredentialsProvider, new ClientConfiguration()); } /** * Constructs a new client to invoke service methods on * AmazonGlacier using the specified AWS account credentials * provider and client configuration options. * *

* All service calls made using this new client object are blocking, and will not * return until the service call completes. * * @param awsCredentialsProvider * The AWS credentials provider which will provide credentials * to authenticate requests with AWS services. * @param clientConfiguration The client configuration options controlling how this * client connects to AmazonGlacier * (ex: proxy settings, retry counts, etc.). */ public AmazonGlacierClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) { this(awsCredentialsProvider, clientConfiguration, null); } /** * Constructs a new client to invoke service methods on * AmazonGlacier using the specified AWS account credentials * provider, client configuration options and request metric collector. * *

* All service calls made using this new client object are blocking, and will not * return until the service call completes. * * @param awsCredentialsProvider * The AWS credentials provider which will provide credentials * to authenticate requests with AWS services. * @param clientConfiguration The client configuration options controlling how this * client connects to AmazonGlacier * (ex: proxy settings, retry counts, etc.). * @param requestMetricCollector optional request metric collector */ public AmazonGlacierClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) { super(adjustClientConfiguration(clientConfiguration), requestMetricCollector); this.awsCredentialsProvider = awsCredentialsProvider; init(); } private void init() { jsonErrorUnmarshallers = new ArrayList(); jsonErrorUnmarshallers.add(new InvalidParameterValueExceptionUnmarshaller()); jsonErrorUnmarshallers.add(new LimitExceededExceptionUnmarshaller()); jsonErrorUnmarshallers.add(new MissingParameterValueExceptionUnmarshaller()); jsonErrorUnmarshallers.add(new RequestTimeoutExceptionUnmarshaller()); jsonErrorUnmarshallers.add(new ServiceUnavailableExceptionUnmarshaller()); jsonErrorUnmarshallers.add(new ResourceNotFoundExceptionUnmarshaller()); jsonErrorUnmarshallers.add(new GlacierErrorUnmarshaller()); // calling this.setEndPoint(...) will also modify the signer accordingly this.setEndpoint("glacier.us-east-1.amazonaws.com"); HandlerChainFactory chainFactory = new HandlerChainFactory(); requestHandler2s.addAll(chainFactory.newRequestHandlerChain( "/com/amazonaws/services/glacier/request.handlers")); requestHandler2s.addAll(chainFactory.newRequestHandler2Chain( "/com/amazonaws/services/glacier/request.handler2s")); } private static ClientConfiguration adjustClientConfiguration(ClientConfiguration orig) { ClientConfiguration config = orig; return config; } /** *

* 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 . * *

* * @param listVaultsRequest Container for the necessary parameters to * execute the ListVaults service method on AmazonGlacier. * * @return The response from the ListVaults service method, as returned * by AmazonGlacier. * * @throws ResourceNotFoundException * @throws MissingParameterValueException * @throws ServiceUnavailableException * @throws InvalidParameterValueException * * @throws AmazonClientException * 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. * @throws 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 ListVaultsResult listVaults(ListVaultsRequest listVaultsRequest) { ExecutionContext executionContext = createExecutionContext(listVaultsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new ListVaultsRequestMarshaller().marshall(listVaultsRequest); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } Unmarshaller unmarshaller = new ListVaultsResultJsonUnmarshaller(); JsonResponseHandler responseHandler = new JsonResponseHandler(unmarshaller); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC); } } /** *

* 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 . * *

* * @param describeJobRequest Container for the necessary parameters to * execute the DescribeJob service method on AmazonGlacier. * * @return The response from the DescribeJob service method, as returned * by AmazonGlacier. * * @throws ResourceNotFoundException * @throws MissingParameterValueException * @throws ServiceUnavailableException * @throws InvalidParameterValueException * * @throws AmazonClientException * 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. * @throws 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) { ExecutionContext executionContext = createExecutionContext(describeJobRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new DescribeJobRequestMarshaller().marshall(describeJobRequest); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } Unmarshaller unmarshaller = new DescribeJobResultJsonUnmarshaller(); JsonResponseHandler responseHandler = new JsonResponseHandler(unmarshaller); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC); } } /** *

* 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 . *

* * @param listPartsRequest Container for the necessary parameters to * execute the ListParts service method on AmazonGlacier. * * @return The response from the ListParts service method, as returned by * AmazonGlacier. * * @throws ResourceNotFoundException * @throws MissingParameterValueException * @throws ServiceUnavailableException * @throws InvalidParameterValueException * * @throws AmazonClientException * 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. * @throws 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) { ExecutionContext executionContext = createExecutionContext(listPartsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new ListPartsRequestMarshaller().marshall(listPartsRequest); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } Unmarshaller unmarshaller = new ListPartsResultJsonUnmarshaller(); JsonResponseHandler responseHandler = new JsonResponseHandler(unmarshaller); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC); } } /** *

* 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 . * *

* * @param getVaultNotificationsRequest Container for the necessary * parameters to execute the GetVaultNotifications service method on * AmazonGlacier. * * @return The response from the GetVaultNotifications service method, as * returned by AmazonGlacier. * * @throws ResourceNotFoundException * @throws MissingParameterValueException * @throws ServiceUnavailableException * @throws InvalidParameterValueException * * @throws AmazonClientException * 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. * @throws 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) { ExecutionContext executionContext = createExecutionContext(getVaultNotificationsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new GetVaultNotificationsRequestMarshaller().marshall(getVaultNotificationsRequest); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } Unmarshaller unmarshaller = new GetVaultNotificationsResultJsonUnmarshaller(); JsonResponseHandler responseHandler = new JsonResponseHandler(unmarshaller); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC); } } /** *

* 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 * *

* * @param listJobsRequest Container for the necessary parameters to * execute the ListJobs service method on AmazonGlacier. * * @return The response from the ListJobs service method, as returned by * AmazonGlacier. * * @throws ResourceNotFoundException * @throws MissingParameterValueException * @throws ServiceUnavailableException * @throws InvalidParameterValueException * * @throws AmazonClientException * 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. * @throws 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) { ExecutionContext executionContext = createExecutionContext(listJobsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new ListJobsRequestMarshaller().marshall(listJobsRequest); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } Unmarshaller unmarshaller = new ListJobsResultJsonUnmarshaller(); JsonResponseHandler responseHandler = new JsonResponseHandler(unmarshaller); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC); } } /** *

* 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 . * *

* * @param createVaultRequest Container for the necessary parameters to * execute the CreateVault service method on AmazonGlacier. * * @return The response from the CreateVault service method, as returned * by AmazonGlacier. * * @throws MissingParameterValueException * @throws ServiceUnavailableException * @throws InvalidParameterValueException * @throws LimitExceededException * * @throws AmazonClientException * 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. * @throws 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) { ExecutionContext executionContext = createExecutionContext(createVaultRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new CreateVaultRequestMarshaller().marshall(createVaultRequest); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } Unmarshaller unmarshaller = new CreateVaultResultJsonUnmarshaller(); JsonResponseHandler responseHandler = new JsonResponseHandler(unmarshaller); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC); } } /** *

* 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 . *

* * @param initiateMultipartUploadRequest Container for the necessary * parameters to execute the InitiateMultipartUpload service method on * AmazonGlacier. * * @return The response from the InitiateMultipartUpload service method, * as returned by AmazonGlacier. * * @throws ResourceNotFoundException * @throws MissingParameterValueException * @throws ServiceUnavailableException * @throws InvalidParameterValueException * * @throws AmazonClientException * 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. * @throws 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) { ExecutionContext executionContext = createExecutionContext(initiateMultipartUploadRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new InitiateMultipartUploadRequestMarshaller().marshall(initiateMultipartUploadRequest); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } Unmarshaller unmarshaller = new InitiateMultipartUploadResultJsonUnmarshaller(); JsonResponseHandler responseHandler = new JsonResponseHandler(unmarshaller); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC); } } /** *

* 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 . * *

* * @param abortMultipartUploadRequest Container for the necessary * parameters to execute the AbortMultipartUpload service method on * AmazonGlacier. * * * @throws ResourceNotFoundException * @throws MissingParameterValueException * @throws ServiceUnavailableException * @throws InvalidParameterValueException * * @throws AmazonClientException * 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. * @throws 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) { ExecutionContext executionContext = createExecutionContext(abortMultipartUploadRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); Request request; awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new AbortMultipartUploadRequestMarshaller().marshall(abortMultipartUploadRequest); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } JsonResponseHandler responseHandler = new JsonResponseHandler(null); invoke(request, responseHandler, executionContext); } /** *

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

* *
    *
  • If the archive retrieval job is actively preparing the data for * download when Amazon Glacier receives the delete archive request, the * archival retrieval operation might fail.
  • *
  • If the archive retrieval job has successfully prepared the * archive for download when Amazon Glacier receives the delete archive * request, you will be able to download the output.
  • * *
*

* 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 . * *

* * @param deleteArchiveRequest Container for the necessary parameters to * execute the DeleteArchive service method on AmazonGlacier. * * * @throws ResourceNotFoundException * @throws MissingParameterValueException * @throws ServiceUnavailableException * @throws InvalidParameterValueException * * @throws AmazonClientException * 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. * @throws 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) { ExecutionContext executionContext = createExecutionContext(deleteArchiveRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); Request request; awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new DeleteArchiveRequestMarshaller().marshall(deleteArchiveRequest); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } JsonResponseHandler responseHandler = new JsonResponseHandler(null); invoke(request, responseHandler, executionContext); } /** *

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

*
  1. * Download a 128 MB chunk of output by specifying the appropriate byte * range using the Range header. *

    *
  2. *
  3. * 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. *

    *
  4. *
  5. * Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, * each time specifying the appropriate byte range. *

    *
  6. *
  7. * 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. *

    *
  8. *

* 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 * *

* * @param getJobOutputRequest Container for the necessary parameters to * execute the GetJobOutput service method on AmazonGlacier. * * @return The response from the GetJobOutput service method, as returned * by AmazonGlacier. * * @throws ResourceNotFoundException * @throws MissingParameterValueException * @throws ServiceUnavailableException * @throws InvalidParameterValueException * * @throws AmazonClientException * 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. * @throws 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) { ExecutionContext executionContext = createExecutionContext(getJobOutputRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new GetJobOutputRequestMarshaller().marshall(getJobOutputRequest); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } Unmarshaller unmarshaller = new GetJobOutputResultJsonUnmarshaller(); JsonResponseHandler responseHandler = new JsonResponseHandler(unmarshaller); responseHandler.needsConnectionLeftOpen = true; response = invoke(request, responseHandler, executionContext); GetJobOutputResult awsResponse = response.getAwsResponse(); awsResponse.setBody(new ServiceClientHolderInputStream(awsResponse.getBody(),this)); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC); } } /** *

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

*
  1. * Initiate a retrieval job. *

    *
  2. *
  3. * After the job completes, download the bytes. *

    *
  4. *

* 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 * *

* * @param initiateJobRequest Container for the necessary parameters to * execute the InitiateJob service method on AmazonGlacier. * * @return The response from the InitiateJob service method, as returned * by AmazonGlacier. * * @throws ResourceNotFoundException * @throws MissingParameterValueException * @throws ServiceUnavailableException * @throws InvalidParameterValueException * * @throws AmazonClientException * 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. * @throws 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) { ExecutionContext executionContext = createExecutionContext(initiateJobRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new InitiateJobRequestMarshaller().marshall(initiateJobRequest); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } Unmarshaller unmarshaller = new InitiateJobResultJsonUnmarshaller(); JsonResponseHandler responseHandler = new JsonResponseHandler(unmarshaller); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC); } } /** *

* 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 . * *

* * @param uploadArchiveRequest Container for the necessary parameters to * execute the UploadArchive service method on AmazonGlacier. * * @return The response from the UploadArchive service method, as * returned by AmazonGlacier. * * @throws ResourceNotFoundException * @throws MissingParameterValueException * @throws RequestTimeoutException * @throws ServiceUnavailableException * @throws InvalidParameterValueException * * @throws AmazonClientException * 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. * @throws 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) { ExecutionContext executionContext = createExecutionContext(uploadArchiveRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new UploadArchiveRequestMarshaller().marshall(uploadArchiveRequest); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } Unmarshaller unmarshaller = new UploadArchiveResultJsonUnmarshaller(); JsonResponseHandler responseHandler = new JsonResponseHandler(unmarshaller); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC); } } /** *

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

* *
    *
  • ArchiveRetrievalCompleted This event occurs when a job * that was initiated for an archive retrieval is completed * (InitiateJob). The status of the completed job can be "Succeeded" or * "Failed". The notification sent to the SNS topic is the same output as * returned from DescribeJob.
  • *
  • InventoryRetrievalCompleted This event occurs when a job * that was initiated for an inventory retrieval is completed * (InitiateJob). The status of the completed job can be "Succeeded" or * "Failed". The notification sent to the SNS topic is the same output as * returned from DescribeJob.
  • * *
*

* 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 . * *

* * @param setVaultNotificationsRequest Container for the necessary * parameters to execute the SetVaultNotifications service method on * AmazonGlacier. * * * @throws ResourceNotFoundException * @throws MissingParameterValueException * @throws ServiceUnavailableException * @throws InvalidParameterValueException * * @throws AmazonClientException * 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. * @throws 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) { ExecutionContext executionContext = createExecutionContext(setVaultNotificationsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); Request request; awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new SetVaultNotificationsRequestMarshaller().marshall(setVaultNotificationsRequest); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } JsonResponseHandler responseHandler = new JsonResponseHandler(null); invoke(request, responseHandler, executionContext); } /** *

* 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 . * *

* * @param completeMultipartUploadRequest Container for the necessary * parameters to execute the CompleteMultipartUpload service method on * AmazonGlacier. * * @return The response from the CompleteMultipartUpload service method, * as returned by AmazonGlacier. * * @throws ResourceNotFoundException * @throws MissingParameterValueException * @throws ServiceUnavailableException * @throws InvalidParameterValueException * * @throws AmazonClientException * 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. * @throws 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) { ExecutionContext executionContext = createExecutionContext(completeMultipartUploadRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new CompleteMultipartUploadRequestMarshaller().marshall(completeMultipartUploadRequest); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } Unmarshaller unmarshaller = new CompleteMultipartUploadResultJsonUnmarshaller(); JsonResponseHandler responseHandler = new JsonResponseHandler(unmarshaller); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC); } } /** *

* 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. *

    *
  • *
  • Range does not align The byte range value in the request * does not align with the part size specified in the corresponding * initiate request. For example, if you specify a part size of 4194304 * bytes (4 MB), then 0 to 4194303 bytes (4 MB - 1) and 4194304 (4 MB) to * 8388607 (8 MB - 1) are valid part ranges. However, if you set a range * value of 2 MB to 6 MB, the range does not align with the part size and * the upload 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 . *

* * @param uploadMultipartPartRequest Container for the necessary * parameters to execute the UploadMultipartPart service method on * AmazonGlacier. * * @return The response from the UploadMultipartPart service method, as * returned by AmazonGlacier. * * @throws ResourceNotFoundException * @throws MissingParameterValueException * @throws RequestTimeoutException * @throws ServiceUnavailableException * @throws InvalidParameterValueException * * @throws AmazonClientException * 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. * @throws 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) { ExecutionContext executionContext = createExecutionContext(uploadMultipartPartRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new UploadMultipartPartRequestMarshaller().marshall(uploadMultipartPartRequest); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } Unmarshaller unmarshaller = new UploadMultipartPartResultJsonUnmarshaller(); JsonResponseHandler responseHandler = new JsonResponseHandler(unmarshaller); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC); } } /** *

* 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 . * *

* * @param describeVaultRequest Container for the necessary parameters to * execute the DescribeVault service method on AmazonGlacier. * * @return The response from the DescribeVault service method, as * returned by AmazonGlacier. * * @throws ResourceNotFoundException * @throws MissingParameterValueException * @throws ServiceUnavailableException * @throws InvalidParameterValueException * * @throws AmazonClientException * 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. * @throws 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) { ExecutionContext executionContext = createExecutionContext(describeVaultRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new DescribeVaultRequestMarshaller().marshall(describeVaultRequest); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } Unmarshaller unmarshaller = new DescribeVaultResultJsonUnmarshaller(); JsonResponseHandler responseHandler = new JsonResponseHandler(unmarshaller); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC); } } /** *

* 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. *

* * @param deleteVaultNotificationsRequest Container for the necessary * parameters to execute the DeleteVaultNotifications service method on * AmazonGlacier. * * * @throws ResourceNotFoundException * @throws MissingParameterValueException * @throws ServiceUnavailableException * @throws InvalidParameterValueException * * @throws AmazonClientException * 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. * @throws 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) { ExecutionContext executionContext = createExecutionContext(deleteVaultNotificationsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); Request request; awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new DeleteVaultNotificationsRequestMarshaller().marshall(deleteVaultNotificationsRequest); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } JsonResponseHandler responseHandler = new JsonResponseHandler(null); invoke(request, responseHandler, executionContext); } /** *

* 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 . *

* * @param listMultipartUploadsRequest Container for the necessary * parameters to execute the ListMultipartUploads service method on * AmazonGlacier. * * @return The response from the ListMultipartUploads service method, as * returned by AmazonGlacier. * * @throws ResourceNotFoundException * @throws MissingParameterValueException * @throws ServiceUnavailableException * @throws InvalidParameterValueException * * @throws AmazonClientException * 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. * @throws 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) { ExecutionContext executionContext = createExecutionContext(listMultipartUploadsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new ListMultipartUploadsRequestMarshaller().marshall(listMultipartUploadsRequest); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } Unmarshaller unmarshaller = new ListMultipartUploadsResultJsonUnmarshaller(); JsonResponseHandler responseHandler = new JsonResponseHandler(unmarshaller); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC); } } /** *

* 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 . * *

* * @param deleteVaultRequest Container for the necessary parameters to * execute the DeleteVault service method on AmazonGlacier. * * * @throws ResourceNotFoundException * @throws MissingParameterValueException * @throws ServiceUnavailableException * @throws InvalidParameterValueException * * @throws AmazonClientException * 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. * @throws 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) { ExecutionContext executionContext = createExecutionContext(deleteVaultRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); Request request; awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new DeleteVaultRequestMarshaller().marshall(deleteVaultRequest); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } JsonResponseHandler responseHandler = new JsonResponseHandler(null); invoke(request, responseHandler, executionContext); } @Override public void setEndpoint(String endpoint) { super.setEndpoint(endpoint); } @Override public void setEndpoint(String endpoint, String serviceName, String regionId) throws IllegalArgumentException { super.setEndpoint(endpoint, serviceName, regionId); } /** * 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. * * @param request * The originally executed request * * @return The response metadata for the specified request, or null if none * is available. */ public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) { return client.getResponseMetadataForRequest(request); } private Response invoke(Request request, HttpResponseHandler> responseHandler, ExecutionContext executionContext) { request.setEndpoint(endpoint); request.setTimeOffset(timeOffset); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); AWSCredentials credentials; awsRequestMetrics.startEvent(Field.CredentialsRequestTime); try { credentials = awsCredentialsProvider.getCredentials(); } finally { awsRequestMetrics.endEvent(Field.CredentialsRequestTime); } AmazonWebServiceRequest originalRequest = request.getOriginalRequest(); if (originalRequest != null && originalRequest.getRequestCredentials() != null) { credentials = originalRequest.getRequestCredentials(); } executionContext.setCredentials(credentials); JsonErrorResponseHandler errorResponseHandler = new JsonErrorResponseHandler(jsonErrorUnmarshallers); Response result = client.execute(request, responseHandler, errorResponseHandler, executionContext); return result; } }





© 2015 - 2025 Weber Informatics LLC | Privacy Policy