Delphi DLL

Glacier Initiate Inventory Retrieval Job

See more Amazon Glacier Examples

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.

Delphi DLL

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, AuthAws, Rest, JsonObject, StringBuilder;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
rest: HCkRest;
bTls: Boolean;
port: Integer;
bAutoReconnect: Boolean;
authAws: HCkAuthAws;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
sbResponseBody: HCkStringBuilder;
respStatusCode: Integer;
jobId: PWideChar;
location: PWideChar;

begin
success := False;

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

rest := CkRest_Create();

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

// Provide AWS credentials.
authAws := CkAuthAws_Create();
CkAuthAws_putAccessKey(authAws,'AWS_ACCESS_KEY');
CkAuthAws_putSecretKey(authAws,'AWS_SECRET_KEY');
CkAuthAws_putServiceName(authAws,'glacier');
CkAuthAws_putRegion(authAws,'us-west-2');

success := CkRest_SetAuthAws(rest,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
// 
CkRest_AddHeader(rest,'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

json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'Type','inventory-retrieval');
CkJsonObject_UpdateString(json,'Description','My inventory job');
CkJsonObject_UpdateString(json,'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.

sbRequestBody := CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);
sbResponseBody := CkStringBuilder_Create();

// Start an inventory retrieval job for the vault named "chilkat".
success := CkRest_FullRequestSb(rest,'POST','/AWS_ACCOUNT_ID/vaults/chilkat/jobs',sbRequestBody,sbResponseBody);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

respStatusCode := CkRest_getResponseStatusCode(rest);
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkRest__responseHeader(rest));
    Memo1.Lines.Add('Response Body:');
    Memo1.Lines.Add(CkStringBuilder__getAsString(sbResponseBody));
    Exit;
  end;

// Success is indicated by a 202 response status with an empty response body.
Memo1.Lines.Add('response status code = ' + IntToStr(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
// 

jobId := CkRest__responseHdrByName(rest,'x-amz-job-id');
Memo1.Lines.Add('x-amz-job-id = ' + jobId);

location := CkRest__responseHdrByName(rest,'Location');
Memo1.Lines.Add('Location = ' + location);

CkRest_Dispose(rest);
CkAuthAws_Dispose(authAws);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);

end;