PowerBuilder

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.

PowerBuilder

integer li_rc
long li_Success
oleobject loo_Rest
long li_BTls
long li_Port
long li_BAutoReconnect
oleobject loo_AuthAws
oleobject loo_Json
oleobject loo_SbRequestBody
oleobject loo_SbResponseBody
long li_RespStatusCode
string ls_JobId
string ls_Location

li_Success = 0

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

loo_Rest = create oleobject
li_rc = loo_Rest.ConnectToNewObject("Chilkat.Rest")
if li_rc < 0 then
    destroy loo_Rest
    MessageBox("Error","Connecting to COM object failed")
    return
end if

//  Connect to the Amazon AWS REST server in the desired region.
li_BTls = 1
li_Port = 443
li_BAutoReconnect = 1
li_Success = loo_Rest.Connect("glacier.us-west-2.amazonaws.com",li_Port,li_BTls,li_BAutoReconnect)

//  Provide AWS credentials.
loo_AuthAws = create oleobject
li_rc = loo_AuthAws.ConnectToNewObject("Chilkat.AuthAws")

loo_AuthAws.AccessKey = "AWS_ACCESS_KEY"
loo_AuthAws.SecretKey = "AWS_SECRET_KEY"
loo_AuthAws.ServiceName = "glacier"
loo_AuthAws.Region = "us-west-2"

li_Success = loo_Rest.SetAuthAws(loo_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
//  
loo_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

loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Json.UpdateString("Type","inventory-retrieval")
loo_Json.UpdateString("Description","My inventory job")
loo_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.

loo_SbRequestBody = create oleobject
li_rc = loo_SbRequestBody.ConnectToNewObject("Chilkat.StringBuilder")

loo_Json.EmitSb(loo_SbRequestBody)
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")

//  Start an inventory retrieval job for the vault named "chilkat".
li_Success = loo_Rest.FullRequestSb("POST","/AWS_ACCOUNT_ID/vaults/chilkat/jobs",loo_SbRequestBody,loo_SbResponseBody)
if li_Success <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    destroy loo_AuthAws
    destroy loo_Json
    destroy loo_SbRequestBody
    destroy loo_SbResponseBody
    return
end if

li_RespStatusCode = loo_Rest.ResponseStatusCode
if li_RespStatusCode >= 400 then
    Write-Debug "Response Status Code = " + string(li_RespStatusCode)
    Write-Debug "Response Header:"
    Write-Debug loo_Rest.ResponseHeader
    Write-Debug "Response Body:"
    Write-Debug loo_SbResponseBody.GetAsString()
    destroy loo_Rest
    destroy loo_AuthAws
    destroy loo_Json
    destroy loo_SbRequestBody
    destroy loo_SbResponseBody
    return
end if

//  Success is indicated by a 202 response status with an empty response body.
Write-Debug "response status code = " + string(li_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
//  

ls_JobId = loo_Rest.ResponseHdrByName("x-amz-job-id")
Write-Debug "x-amz-job-id = " + ls_JobId

ls_Location = loo_Rest.ResponseHdrByName("Location")
Write-Debug "Location = " + ls_Location


destroy loo_Rest
destroy loo_AuthAws
destroy loo_Json
destroy loo_SbRequestBody
destroy loo_SbResponseBody