PureBasic

Amazon Glacier Describe Vault

See more Amazon Glacier Examples

Returns information about a vault, including the vault Amazon Resource Name (ARN), the date the vault was created, the number of archives contained within the vault, and the total size of all the archives in the vault... 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 Vault Reference Documentation
    ; 
    CkRest::ckAddHeader(rest,"x-amz-glacier-version","2012-06-01")

    ; Describe the "chilkat" vault
    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",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 with an empty response body.
    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)

    ; Use this online tool to generate parsing code from sample JSON: 
    ; Generate Parsing Code from JSON

    CreationDate.s
    LastInventoryDate.s
    NumberOfArchives.i
    SizeInBytes.i
    VaultARN.s
    VaultName.s

    CreationDate = CkJsonObject::ckStringOf(json,"CreationDate")
    LastInventoryDate = CkJsonObject::ckStringOf(json,"LastInventoryDate")
    NumberOfArchives = CkJsonObject::ckIntOf(json,"NumberOfArchives")
    SizeInBytes = CkJsonObject::ckIntOf(json,"SizeInBytes")
    VaultARN = CkJsonObject::ckStringOf(json,"VaultARN")
    VaultName = CkJsonObject::ckStringOf(json,"VaultName")

    ; Sample response
    ; 
    ; {
    ;   "CreationDate": "2019-04-05T19:10:28.428Z",
    ;   "LastInventoryDate": null,
    ;   "NumberOfArchives": 0,
    ;   "SizeInBytes": 0,
    ;   "VaultARN": "arn:aws:glacier:us-west-2:954491834127:vaults/chilkat",
    ;   "VaultName": "chilkat"
    ; }
    ; 


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


    ProcedureReturn
EndProcedure