C++

Glacier Get Job Information and Status

See more Amazon Glacier Examples

Demonstrates how to get information and status for a glacier job. C++

#include <CkRest.h>
#include <CkAuthAws.h>
#include <CkStringBuilder.h>
#include <CkJsonObject.h>

void ChilkatSample(void)
    {
    bool success = false;

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

    CkRest rest;

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

    // Provide AWS credentials.
    CkAuthAws authAws;
    authAws.put_AccessKey("AWS_ACCESS_KEY");
    authAws.put_SecretKey("AWS_SECRET_KEY");
    authAws.put_ServiceName("glacier");
    authAws.put_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 Describe Job Reference Documentation
    // 
    rest.AddHeader("x-amz-glacier-version","2012-06-01");

    CkStringBuilder sbResponseBody;
    success = rest.FullRequestNoBodySb("GET","/AWS_ACCOUNT_ID/vaults/chilkat/jobs/JOB_ID",sbResponseBody);
    if (success != true) {
        std::cout << rest.lastErrorText() << "\r\n";
        return;
    }

    int respStatusCode = rest.get_ResponseStatusCode();
    if (respStatusCode >= 400) {
        std::cout << "Response Status Code = " << respStatusCode << "\r\n";
        std::cout << "Response Header:" << "\r\n";
        std::cout << rest.responseHeader() << "\r\n";
        std::cout << "Response Body:" << "\r\n";
        std::cout << sbResponseBody.getAsString() << "\r\n";
        return;
    }

    // Success is indicated by a 200 response status.
    std::cout << "response status code = " << respStatusCode << "\r\n";

    CkJsonObject json;
    json.LoadSb(sbResponseBody);
    json.put_EmitCompact(false);
    std::cout << json.emit() << "\r\n";

    // Sample output:
    // Use this online tool to generate parsing code from sample JSON: 
    // Generate Parsing Code from JSON

    // {
    //   "Action": "InventoryRetrieval",
    //   "ArchiveId": null,
    //   "ArchiveSHA256TreeHash": null,
    //   "ArchiveSizeInBytes": null,
    //   "Completed": false,
    //   "CompletionDate": null,
    //   "CreationDate": "2019-04-09T22:48:48.700Z",
    //   "InventoryRetrievalParameters": {
    //     "EndDate": null,
    //     "Format": "CSV",
    //     "Limit": null,
    //     "Marker": null,
    //     "StartDate": null
    //   },
    //   "InventorySizeInBytes": null,
    //   "JobDescription": "My inventory job",
    //   "JobId": "E-mCnb3j122yvz5PRFGzETmFVXVrkX_pgI8PIuwBKNRyI8pAJqIetKwzkJC5a6blIvYZrrVohiBENQVhZE1a-K-x-uRO",
    //   "JobOutputPath": null,
    //   "OutputLocation": null,
    //   "RetrievalByteRange": null,
    //   "SHA256TreeHash": null,
    //   "SNSTopic": null,
    //   "SelectParameters": null,
    //   "StatusCode": "InProgress",
    //   "StatusMessage": null,
    //   "Tier": null,
    //   "VaultARN": "arn:aws:glacier:us-west-2:954491834127:vaults/chilkat"
    // }
    // 

    const char *Action = 0;
    const char *ArchiveId = 0;
    const char *ArchiveSHA256TreeHash = 0;
    const char *ArchiveSizeInBytes = 0;
    bool Completed;
    const char *CompletionDate = 0;
    const char *CreationDate = 0;
    const char *InventoryRetrievalParametersEndDate = 0;
    const char *InventoryRetrievalParametersFormat = 0;
    const char *InventoryRetrievalParametersLimit = 0;
    const char *InventoryRetrievalParametersMarker = 0;
    const char *InventoryRetrievalParametersStartDate = 0;
    const char *InventorySizeInBytes = 0;
    const char *JobDescription = 0;
    const char *JobId = 0;
    const char *JobOutputPath = 0;
    const char *OutputLocation = 0;
    const char *RetrievalByteRange = 0;
    const char *SHA256TreeHash = 0;
    const char *SNSTopic = 0;
    const char *SelectParameters = 0;
    const char *StatusCode = 0;
    const char *StatusMessage = 0;
    const char *Tier = 0;
    const char *VaultARN = 0;

    Action = json.stringOf("Action");
    ArchiveId = json.stringOf("ArchiveId");
    ArchiveSHA256TreeHash = json.stringOf("ArchiveSHA256TreeHash");
    ArchiveSizeInBytes = json.stringOf("ArchiveSizeInBytes");
    Completed = json.BoolOf("Completed");
    CompletionDate = json.stringOf("CompletionDate");
    CreationDate = json.stringOf("CreationDate");
    InventoryRetrievalParametersEndDate = json.stringOf("InventoryRetrievalParameters.EndDate");
    InventoryRetrievalParametersFormat = json.stringOf("InventoryRetrievalParameters.Format");
    InventoryRetrievalParametersLimit = json.stringOf("InventoryRetrievalParameters.Limit");
    InventoryRetrievalParametersMarker = json.stringOf("InventoryRetrievalParameters.Marker");
    InventoryRetrievalParametersStartDate = json.stringOf("InventoryRetrievalParameters.StartDate");
    InventorySizeInBytes = json.stringOf("InventorySizeInBytes");
    JobDescription = json.stringOf("JobDescription");
    JobId = json.stringOf("JobId");
    JobOutputPath = json.stringOf("JobOutputPath");
    OutputLocation = json.stringOf("OutputLocation");
    RetrievalByteRange = json.stringOf("RetrievalByteRange");
    SHA256TreeHash = json.stringOf("SHA256TreeHash");
    SNSTopic = json.stringOf("SNSTopic");
    SelectParameters = json.stringOf("SelectParameters");
    StatusCode = json.stringOf("StatusCode");
    StatusMessage = json.stringOf("StatusMessage");
    Tier = json.stringOf("Tier");
    VaultARN = json.stringOf("VaultARN");
    }