Xojo Plugin

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.

Xojo Plugin

Dim success As Boolean
success = False

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

Dim rest As New Chilkat.Rest

// Connect to the Amazon AWS REST server in the desired region.
Dim bTls As Boolean
bTls = True
Dim port As Int32
port = 443
Dim bAutoReconnect As Boolean
bAutoReconnect = True
success = rest.Connect("glacier.us-west-2.amazonaws.com",port,bTls,bAutoReconnect)

// Provide AWS credentials.
Dim authAws As 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
// 
success = 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

Dim json As New Chilkat.JsonObject
success = json.UpdateString("Type","archive-retrieval")
success = json.UpdateString("ArchiveId","ARCHIVE_ID")
success = json.UpdateString("Description","My archive description")
// Possible tiers are Bulk, Standard, and Expedited.
success = 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.

Dim sbRequestBody As New Chilkat.StringBuilder
success = json.EmitSb(sbRequestBody)
Dim sbResponseBody As New Chilkat.StringBuilder

// Start an archive retrieval in for the vault named "chilkat".
success = rest.FullRequestSb("POST","/AWS_ACCOUNT_ID/vaults/chilkat/jobs",sbRequestBody,sbResponseBody)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

Dim respStatusCode As Int32
respStatusCode = rest.ResponseStatusCode
If (respStatusCode >= 400) Then
    System.DebugLog("Response Status Code = " + Str(respStatusCode))
    System.DebugLog("Response Header:")
    System.DebugLog(rest.ResponseHeader)
    System.DebugLog("Response Body:")
    System.DebugLog(sbResponseBody.GetAsString())
    Return
End If

// Success is indicated by a 202 response status with an empty response body.
System.DebugLog("response status code = " + Str(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
// 

Dim jobId As String
jobId = rest.ResponseHdrByName("x-amz-job-id")
System.DebugLog("x-amz-job-id = " + jobId)

Dim location As String
location = rest.ResponseHdrByName("Location")
System.DebugLog("Location = " + location)