DescribeImages PureBasic Example
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, "appstream")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://appstream2.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"appstream2.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,"Arns[0]","string")
CkJsonObject::ckUpdateInt(json,"MaxResults",123)
CkJsonObject::ckUpdateString(json,"Names[0]","string")
CkJsonObject::ckUpdateString(json,"NextToken","string")
CkJsonObject::ckUpdateString(json,"Type","string")
; The JSON request body created by the above code:
; {
; "Arns": [
; "string"
; ],
; "MaxResults": number,
; "Names": [
; "string"
; ],
; "NextToken": "string",
; "Type": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","PhotonAdminProxyService.DescribeImages")
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
AppstreamAgentVersion.s
Arn.s
BaseImageArn.s
CreatedTime.i
Description.s
DisplayName.s
ImageBuilderName.s
ImageBuilderSupported.i
AllowFleet.i
AllowImageBuilder.i
Name.s
Platform.s
PublicBaseImageReleasedDate.i
State.s
Code.s
Message.s
Visibility.s
j.i
count_j.i
AppBlockArn.s
Enabled.i
S3Bucket.s
S3Key.s
IconURL.s
LaunchParameters.s
LaunchPath.s
v_String.s
WorkingDirectory.s
k.i
count_k.i
strVal.s
ErrorCode.s
ErrorMessage.s
ErrorTimestamp.i
NextToken.s = CkJsonObject::ckStringOf(jResp,"NextToken")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"Images")
While i < count_i
CkJsonObject::setCkI(jResp, i)
AppstreamAgentVersion = CkJsonObject::ckStringOf(jResp,"Images[i].AppstreamAgentVersion")
Arn = CkJsonObject::ckStringOf(jResp,"Images[i].Arn")
BaseImageArn = CkJsonObject::ckStringOf(jResp,"Images[i].BaseImageArn")
CreatedTime = CkJsonObject::ckIntOf(jResp,"Images[i].CreatedTime")
Description = CkJsonObject::ckStringOf(jResp,"Images[i].Description")
DisplayName = CkJsonObject::ckStringOf(jResp,"Images[i].DisplayName")
ImageBuilderName = CkJsonObject::ckStringOf(jResp,"Images[i].ImageBuilderName")
ImageBuilderSupported = CkJsonObject::ckIntOf(jResp,"Images[i].ImageBuilderSupported")
AllowFleet = CkJsonObject::ckIntOf(jResp,"Images[i].ImagePermissions.allowFleet")
AllowImageBuilder = CkJsonObject::ckIntOf(jResp,"Images[i].ImagePermissions.allowImageBuilder")
Name = CkJsonObject::ckStringOf(jResp,"Images[i].Name")
Platform = CkJsonObject::ckStringOf(jResp,"Images[i].Platform")
PublicBaseImageReleasedDate = CkJsonObject::ckIntOf(jResp,"Images[i].PublicBaseImageReleasedDate")
State = CkJsonObject::ckStringOf(jResp,"Images[i].State")
Code = CkJsonObject::ckStringOf(jResp,"Images[i].StateChangeReason.Code")
Message = CkJsonObject::ckStringOf(jResp,"Images[i].StateChangeReason.Message")
Visibility = CkJsonObject::ckStringOf(jResp,"Images[i].Visibility")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"Images[i].Applications")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
AppBlockArn = CkJsonObject::ckStringOf(jResp,"Images[i].Applications[j].AppBlockArn")
Arn = CkJsonObject::ckStringOf(jResp,"Images[i].Applications[j].Arn")
CreatedTime = CkJsonObject::ckIntOf(jResp,"Images[i].Applications[j].CreatedTime")
Description = CkJsonObject::ckStringOf(jResp,"Images[i].Applications[j].Description")
DisplayName = CkJsonObject::ckStringOf(jResp,"Images[i].Applications[j].DisplayName")
Enabled = CkJsonObject::ckIntOf(jResp,"Images[i].Applications[j].Enabled")
S3Bucket = CkJsonObject::ckStringOf(jResp,"Images[i].Applications[j].IconS3Location.S3Bucket")
S3Key = CkJsonObject::ckStringOf(jResp,"Images[i].Applications[j].IconS3Location.S3Key")
IconURL = CkJsonObject::ckStringOf(jResp,"Images[i].Applications[j].IconURL")
LaunchParameters = CkJsonObject::ckStringOf(jResp,"Images[i].Applications[j].LaunchParameters")
LaunchPath = CkJsonObject::ckStringOf(jResp,"Images[i].Applications[j].LaunchPath")
v_String = CkJsonObject::ckStringOf(jResp,"Images[i].Applications[j].Metadata.string")
Name = CkJsonObject::ckStringOf(jResp,"Images[i].Applications[j].Name")
WorkingDirectory = CkJsonObject::ckStringOf(jResp,"Images[i].Applications[j].WorkingDirectory")
k = 0
count_k = CkJsonObject::ckSizeOfArray(jResp,"Images[i].Applications[j].InstanceFamilies")
While k < count_k
CkJsonObject::setCkK(jResp, k)
strVal = CkJsonObject::ckStringOf(jResp,"Images[i].Applications[j].InstanceFamilies[k]")
k = k + 1
Wend
k = 0
count_k = CkJsonObject::ckSizeOfArray(jResp,"Images[i].Applications[j].Platforms")
While k < count_k
CkJsonObject::setCkK(jResp, k)
strVal = CkJsonObject::ckStringOf(jResp,"Images[i].Applications[j].Platforms[k]")
k = k + 1
Wend
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"Images[i].ImageErrors")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
ErrorCode = CkJsonObject::ckStringOf(jResp,"Images[i].ImageErrors[j].ErrorCode")
ErrorMessage = CkJsonObject::ckStringOf(jResp,"Images[i].ImageErrors[j].ErrorMessage")
ErrorTimestamp = CkJsonObject::ckIntOf(jResp,"Images[i].ImageErrors[j].ErrorTimestamp")
j = j + 1
Wend
i = i + 1
Wend
; A sample JSON response body parsed by the above code:
; {
; "Images": [
; {
; "Applications": [
; {
; "AppBlockArn": "string",
; "Arn": "string",
; "CreatedTime": number,
; "Description": "string",
; "DisplayName": "string",
; "Enabled": boolean,
; "IconS3Location": {
; "S3Bucket": "string",
; "S3Key": "string"
; },
; "IconURL": "string",
; "InstanceFamilies": [
; "string"
; ],
; "LaunchParameters": "string",
; "LaunchPath": "string",
; "Metadata": {
; "string": "string"
; },
; "Name": "string",
; "Platforms": [
; "string"
; ],
; "WorkingDirectory": "string"
; }
; ],
; "AppstreamAgentVersion": "string",
; "Arn": "string",
; "BaseImageArn": "string",
; "CreatedTime": number,
; "Description": "string",
; "DisplayName": "string",
; "ImageBuilderName": "string",
; "ImageBuilderSupported": boolean,
; "ImageErrors": [
; {
; "ErrorCode": "string",
; "ErrorMessage": "string",
; "ErrorTimestamp": number
; }
; ],
; "ImagePermissions": {
; "allowFleet": boolean,
; "allowImageBuilder": boolean
; },
; "Name": "string",
; "Platform": "string",
; "PublicBaseImageReleasedDate": number,
; "State": "string",
; "StateChangeReason": {
; "Code": "string",
; "Message": "string"
; },
; "Visibility": "string"
; }
; ],
; "NextToken": "string"
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
