Chilkat Online Tools

ListPortals PureBasic Example

Amazon WorkSpaces Web

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, "workspaces-web")
    ; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
    CkRest::ckSetAuthAws(rest,authAws)

    ; URL: https://workspaces-web.us-west-2.amazonaws.com/
    ; Use the same region as specified above.
    success = CkRest::ckConnect(rest,"workspaces-web.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

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

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

    success = CkRest::ckFullRequestNoBodySb(rest,"GET","/portals",sbResponseBody)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkAuthAws::ckDispose(authAws)
        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)
        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

    browserSettingsArn.s
    browserType.s
    creationDate.i
    displayName.s
    networkSettingsArn.s
    portalArn.s
    portalEndpoint.s
    portalStatus.s
    rendererType.s
    trustStoreArn.s
    userSettingsArn.s

    nextToken.s = CkJsonObject::ckStringOf(jResp,"nextToken")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"portals")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        browserSettingsArn = CkJsonObject::ckStringOf(jResp,"portals[i].browserSettingsArn")
        browserType = CkJsonObject::ckStringOf(jResp,"portals[i].browserType")
        creationDate = CkJsonObject::ckIntOf(jResp,"portals[i].creationDate")
        displayName = CkJsonObject::ckStringOf(jResp,"portals[i].displayName")
        networkSettingsArn = CkJsonObject::ckStringOf(jResp,"portals[i].networkSettingsArn")
        portalArn = CkJsonObject::ckStringOf(jResp,"portals[i].portalArn")
        portalEndpoint = CkJsonObject::ckStringOf(jResp,"portals[i].portalEndpoint")
        portalStatus = CkJsonObject::ckStringOf(jResp,"portals[i].portalStatus")
        rendererType = CkJsonObject::ckStringOf(jResp,"portals[i].rendererType")
        trustStoreArn = CkJsonObject::ckStringOf(jResp,"portals[i].trustStoreArn")
        userSettingsArn = CkJsonObject::ckStringOf(jResp,"portals[i].userSettingsArn")
        i = i + 1
    Wend

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

    ; {
    ;   "nextToken": "string",
    ;   "portals": [
    ;     {
    ;       "browserSettingsArn": "string",
    ;       "browserType": "string",
    ;       "creationDate": number,
    ;       "displayName": "string",
    ;       "networkSettingsArn": "string",
    ;       "portalArn": "string",
    ;       "portalEndpoint": "string",
    ;       "portalStatus": "string",
    ;       "rendererType": "string",
    ;       "trustStoreArn": "string",
    ;       "userSettingsArn": "string"
    ;     }
    ;   ]
    ; }


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


    ProcedureReturn
EndProcedure