PureBasic

Glacier Get Job Information and Status

See more Amazon Glacier Examples

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

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkAuthAws.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkRest.pb"

Procedure ChilkatExample()

    success.i = 0

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

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Connect to the Amazon AWS REST server in the desired region.
    bTls.i = 1
    port.i = 443
    bAutoReconnect.i = 1
    success = CkRest::ckConnect(rest,"glacier.us-west-2.amazonaws.com",port,bTls,bAutoReconnect)

    ; Provide AWS credentials.
    authAws.i = CkAuthAws::ckCreate()
    If authAws.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkAuthAws::setCkAccessKey(authAws, "AWS_ACCESS_KEY")
    CkAuthAws::setCkSecretKey(authAws, "AWS_SECRET_KEY")
    CkAuthAws::setCkServiceName(authAws, "glacier")
    CkAuthAws::setCkRegion(authAws, "us-west-2")

    success = CkRest::ckSetAuthAws(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::ckAddHeader(rest,"x-amz-glacier-version","2012-06-01")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkRest::ckFullRequestNoBodySb(rest,"GET","/AWS_ACCOUNT_ID/vaults/chilkat/jobs/JOB_ID",sbResponseBody)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkAuthAws::ckDispose(authAws)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    respStatusCode.i = CkRest::ckResponseStatusCode(rest)
    If respStatusCode >= 400
        Debug "Response Status Code = " + Str(respStatusCode)
        Debug "Response Header:"
        Debug CkRest::ckResponseHeader(rest)
        Debug "Response Body:"
        Debug CkStringBuilder::ckGetAsString(sbResponseBody)
        CkRest::ckDispose(rest)
        CkAuthAws::ckDispose(authAws)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    ; Success is indicated by a 200 response status.
    Debug "response status code = " + Str(respStatusCode)

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(json,sbResponseBody)
    CkJsonObject::setCkEmitCompact(json, 0)
    Debug CkJsonObject::ckEmit(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"
    ; }
    ; 

    Action.s
    ArchiveId.s
    ArchiveSHA256TreeHash.s
    ArchiveSizeInBytes.s
    Completed.i
    CompletionDate.s
    CreationDate.s
    InventoryRetrievalParametersEndDate.s
    InventoryRetrievalParametersFormat.s
    InventoryRetrievalParametersLimit.s
    InventoryRetrievalParametersMarker.s
    InventoryRetrievalParametersStartDate.s
    InventorySizeInBytes.s
    JobDescription.s
    JobId.s
    JobOutputPath.s
    OutputLocation.s
    RetrievalByteRange.s
    SHA256TreeHash.s
    SNSTopic.s
    SelectParameters.s
    StatusCode.s
    StatusMessage.s
    Tier.s
    VaultARN.s

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


    CkRest::ckDispose(rest)
    CkAuthAws::ckDispose(authAws)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure