(Tcl) Glacier Initiate Inventory Retrieval Job

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.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set rest [new_CkRest]

# Connect to the Amazon AWS REST server in the desired region.
set bTls 1
set port 443
set bAutoReconnect 1
set success [CkRest_Connect $rest "glacier.us-west-2.amazonaws.com" $port $bTls $bAutoReconnect]

# Provide AWS credentials.
set authAws [new_CkAuthAws]

CkAuthAws_put_AccessKey $authAws "AWS_ACCESS_KEY"
CkAuthAws_put_SecretKey $authAws "AWS_SECRET_KEY"
CkAuthAws_put_ServiceName $authAws "glacier"
CkAuthAws_put_Region $authAws "us-west-2"

set 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

set json [new_CkJsonObject]

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.

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody
set sbResponseBody [new_CkStringBuilder]

# Start an inventory retrieval job for the vault named "chilkat".
set success [CkRest_FullRequestSb $rest "POST" "/AWS_ACCOUNT_ID/vaults/chilkat/jobs" $sbRequestBody $sbResponseBody]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

set respStatusCode [CkRest_get_ResponseStatusCode $rest]
if {$respStatusCode >= 400} then {
    puts "Response Status Code = $respStatusCode"
    puts "Response Header:"
    puts [CkRest_responseHeader $rest]
    puts "Response Body:"
    puts [CkStringBuilder_getAsString $sbResponseBody]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

# Success is indicated by a 202 response status with an empty response body.
puts "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
# 

set jobId [CkRest_responseHdrByName $rest "x-amz-job-id"]
puts "x-amz-job-id = $jobId"

set location [CkRest_responseHdrByName $rest "Location"]
puts "Location = $location"

delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody