Dart

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.

Dart

import 'package:chilkat/chilkat.dart';

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

  final rest = CkRest();

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

  // Provide AWS credentials.
  final authAws = CkAuthAws();
  authAws.accessKey = 'AWS_ACCESS_KEY';
  authAws.secretKey = 'AWS_SECRET_KEY';
  authAws.serviceName = 'glacier';
  authAws.region = '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": "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

  final json = CkJsonObject();
  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.

  final sbRequestBody = CkStringBuilder();
  json.emitSb(sbRequestBody);
  final sbResponseBody = CkStringBuilder();

  // Start an inventory retrieval job for the vault named "chilkat".
  try {
    rest.fullRequestSb('POST', '/AWS_ACCOUNT_ID/vaults/chilkat/jobs', sbRequestBody, sbResponseBody);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  final respStatusCode = rest.responseStatusCode;
  if (respStatusCode >= 400) {
    print('Response Status Code = $respStatusCode');
    print('Response Header:');
    print(rest.responseHeader);
    print('Response Body:');
    print(sbResponseBody.getAsString());
    return;
  }

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

  final jobId = rest.responseHdrByName('x-amz-job-id');
  print('x-amz-job-id = $jobId');

  final location = rest.responseHdrByName('Location');
  print('Location = $location');
}