Tcl

Glacier Get Job Information and Status

See more Amazon Glacier Examples

Demonstrates how to get information and status for a glacier job. Tcl

load ./chilkat.dll

set success 0

# 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 Describe Job Reference Documentation
# 
CkRest_AddHeader $rest "x-amz-glacier-version" "2012-06-01"

set sbResponseBody [new_CkStringBuilder]

set success [CkRest_FullRequestNoBodySb $rest "GET" "/AWS_ACCOUNT_ID/vaults/chilkat/jobs/JOB_ID" $sbResponseBody]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    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_CkStringBuilder $sbResponseBody
    exit
}

# Success is indicated by a 200 response status.
puts "response status code = $respStatusCode"

set json [new_CkJsonObject]

CkJsonObject_LoadSb $json $sbResponseBody
CkJsonObject_put_EmitCompact $json 0
puts [CkJsonObject_emit $json]

# Sample output:
# Use this online tool to generate parsing code from sample JSON: 
# Generate Parsing Code from JSON

# {
#   "Action": "InventoryRetrieval",
#   "ArchiveId": null,
#   "ArchiveSHA256TreeHash": null,
#   "ArchiveSizeInBytes": null,
#   "Completed": false,
#   "CompletionDate": null,
#   "CreationDate": "2019-04-09T22:48:48.700Z",
#   "InventoryRetrievalParameters": {
#     "EndDate": null,
#     "Format": "CSV",
#     "Limit": null,
#     "Marker": null,
#     "StartDate": null
#   },
#   "InventorySizeInBytes": null,
#   "JobDescription": "My inventory job",
#   "JobId": "E-mCnb3j122yvz5PRFGzETmFVXVrkX_pgI8PIuwBKNRyI8pAJqIetKwzkJC5a6blIvYZrrVohiBENQVhZE1a-K-x-uRO",
#   "JobOutputPath": null,
#   "OutputLocation": null,
#   "RetrievalByteRange": null,
#   "SHA256TreeHash": null,
#   "SNSTopic": null,
#   "SelectParameters": null,
#   "StatusCode": "InProgress",
#   "StatusMessage": null,
#   "Tier": null,
#   "VaultARN": "arn:aws:glacier:us-west-2:954491834127:vaults/chilkat"
# }
# 

set Action [CkJsonObject_stringOf $json "Action"]
set ArchiveId [CkJsonObject_stringOf $json "ArchiveId"]
set ArchiveSHA256TreeHash [CkJsonObject_stringOf $json "ArchiveSHA256TreeHash"]
set ArchiveSizeInBytes [CkJsonObject_stringOf $json "ArchiveSizeInBytes"]
set Completed [CkJsonObject_BoolOf $json "Completed"]
set CompletionDate [CkJsonObject_stringOf $json "CompletionDate"]
set CreationDate [CkJsonObject_stringOf $json "CreationDate"]
set InventoryRetrievalParametersEndDate [CkJsonObject_stringOf $json "InventoryRetrievalParameters.EndDate"]
set InventoryRetrievalParametersFormat [CkJsonObject_stringOf $json "InventoryRetrievalParameters.Format"]
set InventoryRetrievalParametersLimit [CkJsonObject_stringOf $json "InventoryRetrievalParameters.Limit"]
set InventoryRetrievalParametersMarker [CkJsonObject_stringOf $json "InventoryRetrievalParameters.Marker"]
set InventoryRetrievalParametersStartDate [CkJsonObject_stringOf $json "InventoryRetrievalParameters.StartDate"]
set InventorySizeInBytes [CkJsonObject_stringOf $json "InventorySizeInBytes"]
set JobDescription [CkJsonObject_stringOf $json "JobDescription"]
set JobId [CkJsonObject_stringOf $json "JobId"]
set JobOutputPath [CkJsonObject_stringOf $json "JobOutputPath"]
set OutputLocation [CkJsonObject_stringOf $json "OutputLocation"]
set RetrievalByteRange [CkJsonObject_stringOf $json "RetrievalByteRange"]
set SHA256TreeHash [CkJsonObject_stringOf $json "SHA256TreeHash"]
set SNSTopic [CkJsonObject_stringOf $json "SNSTopic"]
set SelectParameters [CkJsonObject_stringOf $json "SelectParameters"]
set StatusCode [CkJsonObject_stringOf $json "StatusCode"]
set StatusMessage [CkJsonObject_stringOf $json "StatusMessage"]
set Tier [CkJsonObject_stringOf $json "Tier"]
set VaultARN [CkJsonObject_stringOf $json "VaultARN"]

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