PureBasic

Glacier Initiate Inventory Retrieval Job

See more Amazon Glacier Examples

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.

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 Initiate Job Post Reference Documentation
    ; 
    CkRest::ckAddHeader(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

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

    CkJsonObject::ckUpdateString(json,"Type","inventory-retrieval")
    CkJsonObject::ckUpdateString(json,"Description","My inventory job")
    CkJsonObject::ckUpdateString(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.

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

    CkJsonObject::ckEmitSb(json,sbRequestBody)
    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Start an inventory retrieval job for the vault named "chilkat".
    success = CkRest::ckFullRequestSb(rest,"POST","/AWS_ACCOUNT_ID/vaults/chilkat/jobs",sbRequestBody,sbResponseBody)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkAuthAws::ckDispose(authAws)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        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)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    ; Success is indicated by a 202 response status with an empty response body.
    Debug "response status code = " + Str(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
    ; 

    jobId.s = CkRest::ckResponseHdrByName(rest,"x-amz-job-id")
    Debug "x-amz-job-id = " + jobId

    location.s = CkRest::ckResponseHdrByName(rest,"Location")
    Debug "Location = " + location


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


    ProcedureReturn
EndProcedure