PureBasic

Glacier Get Inventory Retrieval Job Output

See more Amazon Glacier Examples

Demonstrates how to get and parse the inventory retrieval job output. PureBasic

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkAuthAws.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkCsv.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 Retrieve Job Output 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/output",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)

    ; The inventory retrieval job output is in CSV format.
    Debug "job output:"
    Debug CkStringBuilder::ckGetAsString(sbResponseBody)
    Debug "--"

    ; The CSV has these fields:  ArchiveId,ArchiveDescription,CreationDate,Size,SHA256TreeHash
    ; Parse the CSV like this...
    csv.i = CkCsv::ckCreate()
    If csv.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkCsv::setCkHasColumnNames(csv, 1)
    CkCsv::ckLoadFromString(csv,CkStringBuilder::ckGetAsString(sbResponseBody))

    i.i = 0
    numRows.i = CkCsv::ckNumRows(csv)
    While i < numRows
        Debug "ArchiveId: " + CkCsv::ckGetCellByName(csv,i,"ArchiveId")
        Debug "Description: " + CkCsv::ckGetCellByName(csv,i,"ArchiveDescription")
        Debug "Size: " + CkCsv::ckGetCellByName(csv,i,"Size")
        Debug "-"
        i = i + 1
    Wend


    CkRest::ckDispose(rest)
    CkAuthAws::ckDispose(authAws)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkCsv::ckDispose(csv)


    ProcedureReturn
EndProcedure