Lianja

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.

Lianja

llSuccess = .F.

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

loRest = createobject("CkRest")

// Connect to the Amazon AWS REST server in the desired region.
llBTls = .T.
lnPort = 443
llBAutoReconnect = .T.
llSuccess = loRest.Connect("glacier.us-west-2.amazonaws.com",lnPort,llBTls,llBAutoReconnect)

// Provide AWS credentials.
loAuthAws = createobject("CkAuthAws")
loAuthAws.AccessKey = "AWS_ACCESS_KEY"
loAuthAws.SecretKey = "AWS_SECRET_KEY"
loAuthAws.ServiceName = "glacier"
loAuthAws.Region = "us-west-2"

llSuccess = loRest.SetAuthAws(loAuthAws)

// --------------------------------------------------------------------------
// 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
// 
loRest.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

loJson = createobject("CkJsonObject")
loJson.UpdateString("Type","archive-retrieval")
loJson.UpdateString("ArchiveId","ARCHIVE_ID")
loJson.UpdateString("Description","My archive description")
// Possible tiers are Bulk, Standard, and Expedited.
loJson.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.

loSbRequestBody = createobject("CkStringBuilder")
loJson.EmitSb(loSbRequestBody)
loSbResponseBody = createobject("CkStringBuilder")

// Start an archive retrieval in for the vault named "chilkat".
llSuccess = loRest.FullRequestSb("POST","/AWS_ACCOUNT_ID/vaults/chilkat/jobs",loSbRequestBody,loSbResponseBody)
if (llSuccess <> .T.) then
    ? loRest.LastErrorText
    release loRest
    release loAuthAws
    release loJson
    release loSbRequestBody
    release loSbResponseBody
    return
endif

lnRespStatusCode = loRest.ResponseStatusCode
if (lnRespStatusCode >= 400) then
    ? "Response Status Code = " + str(lnRespStatusCode)
    ? "Response Header:"
    ? loRest.ResponseHeader
    ? "Response Body:"
    ? loSbResponseBody.GetAsString()
    release loRest
    release loAuthAws
    release loJson
    release loSbRequestBody
    release loSbResponseBody
    return
endif

// Success is indicated by a 202 response status with an empty response body.
? "response status code = " + str(lnRespStatusCode)

// 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
// 

lcJobId = loRest.ResponseHdrByName("x-amz-job-id")
? "x-amz-job-id = " + lcJobId

lcLocation = loRest.ResponseHdrByName("Location")
? "Location = " + lcLocation


release loRest
release loAuthAws
release loJson
release loSbRequestBody
release loSbResponseBody