Java

Glacier Initiate Archive Retrieval Job

See more Amazon Glacier Examples

Demonstrates how to initiate an archive retrieval job to download an archive.

Note: This example requires Chilkat v9.5.0.78 or greater.

Chilkat2 Java

import com.chilkatsoft.chilkat2.AuthAws;
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.JsonObject;
import com.chilkatsoft.chilkat2.Rest;
import com.chilkatsoft.chilkat2.StringBuilder;

public class ChilkatExample {

    public static void main(String[] args) {
        // This example requires the Chilkat API to have been previously unlocked.
        // See Global Unlock Sample for sample code.

        Rest rest = new Rest();

        // Connect to the Amazon AWS REST server in the desired region.
        boolean bTls = true;
        int port = 443;
        boolean bAutoReconnect = true;
        rest.connect("glacier.us-west-2.amazonaws.com", port, bTls, bAutoReconnect);

        // Provide AWS credentials.
        AuthAws authAws = new AuthAws();
        authAws.setAccessKey("AWS_ACCESS_KEY");
        authAws.setSecretKey("AWS_SECRET_KEY");
        authAws.setServiceName("glacier");
        authAws.setRegion("us-west-2");

        rest.setAuthAws(authAws);

        // --------------------------------------------------------------------------
        // Note: The above REST connection and setup of the AWS credentials
        // can be done once.  After connecting, any number of REST calls can be made.
        // The "auto reconnect" property passed to rest.Connect indicates that if
        // the connection is lost, a REST method call will automatically reconnect
        // if needed.
        // --------------------------------------------------------------------------

        // For more information, see Glacier Initiate Job Post Reference Documentation
        //
        rest.addHeader("x-amz-glacier-version", "2012-06-01");

        // The body of our request will contain this JSON:
        // {
        //   "Type": "archive-retrieval",
        //   "ArchiveId": "NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId"
        //   "Description": "My archive description",
        //   "SNSTopic": "arn:aws:sns:us-west-2:111111111111:Glacier-ArchiveRetrieval-topic-Example",
        //   "Tier" : "Bulk"
        // }

        // Use this online tool to generate the code from sample JSON:
        // Generate Code to Create JSON

        JsonObject json = new JsonObject();
        json.updateString("Type", "archive-retrieval");
        json.updateString("ArchiveId", "ARCHIVE_ID");
        json.updateString("Description", "My archive description");
        // Possible tiers are Bulk, Standard, and Expedited.
        json.updateString("Tier", "Bulk");
        // The SNSTopic is optional.  If included, then notification is sent to the SNS topic when the job is complete.
        // This example will omit the SNSTopic.

        StringBuilder sbRequestBody = new StringBuilder();
        json.emitSb(sbRequestBody);
        StringBuilder sbResponseBody = new StringBuilder();

        // Start an archive retrieval in for the vault named "chilkat".
        try {
            rest.fullRequestSb("POST", "/AWS_ACCOUNT_ID/vaults/chilkat/jobs", sbRequestBody, sbResponseBody);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        int respStatusCode = rest.getResponseStatusCode();
        if (respStatusCode >= 400) {
            System.out.println("Response Status Code = " + respStatusCode);
            System.out.println("Response Header:");
            System.out.println(rest.getResponseHeader());
            System.out.println("Response Body:");
            System.out.println(sbResponseBody.getAsString());
            return;
        }

        // Success is indicated by a 202 response status with an empty response body.
        System.out.println("response status code = " + respStatusCode);

        // If successful, the response header looks like this.
        // The Location and x-amz-job-id are two items of information we may wish to save..

        // HTTP/1.1 202 Accepted
        // x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
        // Date: Wed, 10 Feb 2017 12:00:00 GMT
        // Location: /111122223333/vaults/examplevault/jobs/HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID
        // x-amz-job-id: HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID
        //

        String jobId = rest.responseHdrByName("x-amz-job-id");
        System.out.println("x-amz-job-id = " + jobId);

        String location = rest.responseHdrByName("Location");
        System.out.println("Location = " + location);
    }
}