(Node.js) Glacier Initiate Inventory Retrieval Job

Demonstrates how to initiate an inventory retrieval job to get a list of archives from the examplevault vault. The Format set to CSV in the body of the request indicates that the inventory is returned in CSV format.

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

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

    // This example requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var rest = new chilkat.Rest();

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

    // Provide AWS credentials.
    var authAws = new chilkat.AuthAws();
    authAws.AccessKey = "AWS_ACCESS_KEY";
    authAws.SecretKey = "AWS_SECRET_KEY";
    authAws.ServiceName = "glacier";
    authAws.Region = "us-west-2";

    success = 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": "inventory-retrieval",
    //   "Description": "My inventory job",
    //   "Format": "CSV",  
    //   "SNSTopic": "arn:aws:sns:us-west-2:111111111111:Glacier-InventoryRetrieval-topic-Example"
    // }

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

    var json = new chilkat.JsonObject();
    json.UpdateString("Type","inventory-retrieval");
    json.UpdateString("Description","My inventory job");
    json.UpdateString("Format","CSV");
    // 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.

    var sbRequestBody = new chilkat.StringBuilder();
    json.EmitSb(sbRequestBody);
    var sbResponseBody = new chilkat.StringBuilder();

    // Start an inventory retrieval job for the vault named "chilkat".
    success = rest.FullRequestSb("POST","/AWS_ACCOUNT_ID/vaults/chilkat/jobs",sbRequestBody,sbResponseBody);
    if (success !== true) {
        console.log(rest.LastErrorText);
        return;
    }

    var respStatusCode = rest.ResponseStatusCode;
    if (respStatusCode >= 400) {
        console.log("Response Status Code = " + respStatusCode);
        console.log("Response Header:");
        console.log(rest.ResponseHeader);
        console.log("Response Body:");
        console.log(sbResponseBody.GetAsString());
        return;
    }

    // Success is indicated by a 202 response status with an empty response body.
    console.log("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
    // 

    var jobId = rest.ResponseHdrByName("x-amz-job-id");
    console.log("x-amz-job-id = " + jobId);

    var location = rest.ResponseHdrByName("Location");
    console.log("Location = " + location);

}

chilkatExample();