Chilkat Online Tools

DescribeGatewayInformation PureBasic Example

AWS Storage Gateway

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

Procedure ChilkatExample()

    ; 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

    success.i

    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")

    ; Don't forget to change the region to your particular region. (Also make the same change in the call to Connect below.)
    CkAuthAws::setCkRegion(authAws, "us-west-2")
    CkAuthAws::setCkServiceName(authAws, "storagegateway")
    ; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
    CkRest::ckSetAuthAws(rest,authAws)

    ; URL: https://storagegateway.us-west-2.amazonaws.com/
    ; Use the same region as specified above.
    success = CkRest::ckConnect(rest,"storagegateway.us-west-2.amazonaws.com",443,1,1)
    If success <> 1
        Debug "ConnectFailReason: " + Str(CkRest::ckConnectFailReason(rest))
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkAuthAws::ckDispose(authAws)
        ProcedureReturn
    EndIf

    ; The following code creates the JSON request body.
    ; The JSON created by this code is shown below.

    ; Use this online tool to generate 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,"GatewayARN","string")

    ; The JSON request body created by the above code:

    ; {
    ;   "GatewayARN": "string"
    ; }

    CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
    CkRest::ckAddHeader(rest,"X-Amz-Target","StorageGateway_20130630.DescribeGatewayInformation")

    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

    success = CkRest::ckFullRequestSb(rest,"POST","/",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)
    Debug "response status code = " + Str(respStatusCode)
    If respStatusCode <> 200
        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

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

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)

    ; The following code parses the JSON response.
    ; A sample JSON response is shown below the sample code.

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

    Ipv4Address.s
    Ipv6Address.s
    MacAddress.s
    strVal.s
    Key.s
    Value.s

    CloudWatchLogGroupARN.s = CkJsonObject::ckStringOf(jResp,"CloudWatchLogGroupARN")
    DeprecationDate.s = CkJsonObject::ckStringOf(jResp,"DeprecationDate")
    Ec2InstanceId.s = CkJsonObject::ckStringOf(jResp,"Ec2InstanceId")
    Ec2InstanceRegion.s = CkJsonObject::ckStringOf(jResp,"Ec2InstanceRegion")
    EndpointType.s = CkJsonObject::ckStringOf(jResp,"EndpointType")
    GatewayARN.s = CkJsonObject::ckStringOf(jResp,"GatewayARN")
    GatewayCapacity.s = CkJsonObject::ckStringOf(jResp,"GatewayCapacity")
    GatewayId.s = CkJsonObject::ckStringOf(jResp,"GatewayId")
    GatewayName.s = CkJsonObject::ckStringOf(jResp,"GatewayName")
    GatewayState.s = CkJsonObject::ckStringOf(jResp,"GatewayState")
    GatewayTimezone.s = CkJsonObject::ckStringOf(jResp,"GatewayTimezone")
    GatewayType.s = CkJsonObject::ckStringOf(jResp,"GatewayType")
    HostEnvironment.s = CkJsonObject::ckStringOf(jResp,"HostEnvironment")
    HostEnvironmentId.s = CkJsonObject::ckStringOf(jResp,"HostEnvironmentId")
    LastSoftwareUpdate.s = CkJsonObject::ckStringOf(jResp,"LastSoftwareUpdate")
    NextUpdateAvailabilityDate.s = CkJsonObject::ckStringOf(jResp,"NextUpdateAvailabilityDate")
    SoftwareUpdatesEndDate.s = CkJsonObject::ckStringOf(jResp,"SoftwareUpdatesEndDate")
    VPCEndpoint.s = CkJsonObject::ckStringOf(jResp,"VPCEndpoint")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"GatewayNetworkInterfaces")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        Ipv4Address = CkJsonObject::ckStringOf(jResp,"GatewayNetworkInterfaces[i].Ipv4Address")
        Ipv6Address = CkJsonObject::ckStringOf(jResp,"GatewayNetworkInterfaces[i].Ipv6Address")
        MacAddress = CkJsonObject::ckStringOf(jResp,"GatewayNetworkInterfaces[i].MacAddress")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"SupportedGatewayCapacities")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        strVal = CkJsonObject::ckStringOf(jResp,"SupportedGatewayCapacities[i]")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"Tags")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        Key = CkJsonObject::ckStringOf(jResp,"Tags[i].Key")
        Value = CkJsonObject::ckStringOf(jResp,"Tags[i].Value")
        i = i + 1
    Wend

    ; A sample JSON response body parsed by the above code:

    ; {
    ;   "CloudWatchLogGroupARN": "string",
    ;   "DeprecationDate": "string",
    ;   "Ec2InstanceId": "string",
    ;   "Ec2InstanceRegion": "string",
    ;   "EndpointType": "string",
    ;   "GatewayARN": "string",
    ;   "GatewayCapacity": "string",
    ;   "GatewayId": "string",
    ;   "GatewayName": "string",
    ;   "GatewayNetworkInterfaces": [
    ;     {
    ;       "Ipv4Address": "string",
    ;       "Ipv6Address": "string",
    ;       "MacAddress": "string"
    ;     }
    ;   ],
    ;   "GatewayState": "string",
    ;   "GatewayTimezone": "string",
    ;   "GatewayType": "string",
    ;   "HostEnvironment": "string",
    ;   "HostEnvironmentId": "string",
    ;   "LastSoftwareUpdate": "string",
    ;   "NextUpdateAvailabilityDate": "string",
    ;   "SoftwareUpdatesEndDate": "string",
    ;   "SupportedGatewayCapacities": [
    ;     "string"
    ;   ],
    ;   "Tags": [
    ;     {
    ;       "Key": "string",
    ;       "Value": "string"
    ;     }
    ;   ],
    ;   "VPCEndpoint": "string"
    ; }


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


    ProcedureReturn
EndProcedure