Ruby

Glacier Get Job Information and Status

See more Amazon Glacier Examples

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

require 'chilkat'

success = false

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

rest = Chilkat::CkRest.new()

# Connect to the Amazon AWS REST server in the desired region.
bTls = true
port = 443
bAutoReconnect = true
success = rest.Connect("glacier.us-west-2.amazonaws.com",port,bTls,bAutoReconnect)

# Provide AWS credentials.
authAws = Chilkat::CkAuthAws.new()
authAws.put_AccessKey("AWS_ACCESS_KEY")
authAws.put_SecretKey("AWS_SECRET_KEY")
authAws.put_ServiceName("glacier")
authAws.put_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 Describe Job Reference Documentation
# 
rest.AddHeader("x-amz-glacier-version","2012-06-01")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestNoBodySb("GET","/AWS_ACCOUNT_ID/vaults/chilkat/jobs/JOB_ID",sbResponseBody)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

respStatusCode = rest.get_ResponseStatusCode()
if (respStatusCode >= 400)
    print "Response Status Code = " + respStatusCode.to_s() + "\n";
    print "Response Header:" + "\n";
    print rest.responseHeader() + "\n";
    print "Response Body:" + "\n";
    print sbResponseBody.getAsString() + "\n";
    exit
end

# Success is indicated by a 200 response status.
print "response status code = " + respStatusCode.to_s() + "\n";

json = Chilkat::CkJsonObject.new()
json.LoadSb(sbResponseBody)
json.put_EmitCompact(false)
print json.emit() + "\n";

# 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"
# }
# 

Action = json.stringOf("Action")
ArchiveId = json.stringOf("ArchiveId")
ArchiveSHA256TreeHash = json.stringOf("ArchiveSHA256TreeHash")
ArchiveSizeInBytes = json.stringOf("ArchiveSizeInBytes")
Completed = json.BoolOf("Completed")
CompletionDate = json.stringOf("CompletionDate")
CreationDate = json.stringOf("CreationDate")
InventoryRetrievalParametersEndDate = json.stringOf("InventoryRetrievalParameters.EndDate")
InventoryRetrievalParametersFormat = json.stringOf("InventoryRetrievalParameters.Format")
InventoryRetrievalParametersLimit = json.stringOf("InventoryRetrievalParameters.Limit")
InventoryRetrievalParametersMarker = json.stringOf("InventoryRetrievalParameters.Marker")
InventoryRetrievalParametersStartDate = json.stringOf("InventoryRetrievalParameters.StartDate")
InventorySizeInBytes = json.stringOf("InventorySizeInBytes")
JobDescription = json.stringOf("JobDescription")
JobId = json.stringOf("JobId")
JobOutputPath = json.stringOf("JobOutputPath")
OutputLocation = json.stringOf("OutputLocation")
RetrievalByteRange = json.stringOf("RetrievalByteRange")
SHA256TreeHash = json.stringOf("SHA256TreeHash")
SNSTopic = json.stringOf("SNSTopic")
SelectParameters = json.stringOf("SelectParameters")
StatusCode = json.stringOf("StatusCode")
StatusMessage = json.stringOf("StatusMessage")
Tier = json.stringOf("Tier")
VaultARN = json.stringOf("VaultARN")