DescribeImageBuilders 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::ckUpdateInt(json,"MaxResults",123)
CkJsonObject::ckUpdateString(json,"Names[0]","string")
CkJsonObject::ckUpdateString(json,"NextToken","string")
; The JSON request body created by the above code:
; {
; "MaxResults": number,
; "Names": [
; "string"
; ],
; "NextToken": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","PhotonAdminProxyService.DescribeImageBuilders")
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
CreatedTime.i
Description.s
DisplayName.s
DirectoryName.s
OrganizationalUnitDistinguishedName.s
EnableDefaultInternetAccess.i
IamRoleArn.s
ImageArn.s
InstanceType.s
Name.s
EniId.s
EniPrivateIpAddress.s
Platform.s
State.s
Code.s
Message.s
j.i
count_j.i
EndpointType.s
VpceId.s
ErrorCode.s
ErrorMessage.s
ErrorTimestamp.i
strVal.s
NextToken.s = CkJsonObject::ckStringOf(jResp,"NextToken")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"ImageBuilders")
While i < count_i
CkJsonObject::setCkI(jResp, i)
AppstreamAgentVersion = CkJsonObject::ckStringOf(jResp,"ImageBuilders[i].AppstreamAgentVersion")
Arn = CkJsonObject::ckStringOf(jResp,"ImageBuilders[i].Arn")
CreatedTime = CkJsonObject::ckIntOf(jResp,"ImageBuilders[i].CreatedTime")
Description = CkJsonObject::ckStringOf(jResp,"ImageBuilders[i].Description")
DisplayName = CkJsonObject::ckStringOf(jResp,"ImageBuilders[i].DisplayName")
DirectoryName = CkJsonObject::ckStringOf(jResp,"ImageBuilders[i].DomainJoinInfo.DirectoryName")
OrganizationalUnitDistinguishedName = CkJsonObject::ckStringOf(jResp,"ImageBuilders[i].DomainJoinInfo.OrganizationalUnitDistinguishedName")
EnableDefaultInternetAccess = CkJsonObject::ckIntOf(jResp,"ImageBuilders[i].EnableDefaultInternetAccess")
IamRoleArn = CkJsonObject::ckStringOf(jResp,"ImageBuilders[i].IamRoleArn")
ImageArn = CkJsonObject::ckStringOf(jResp,"ImageBuilders[i].ImageArn")
InstanceType = CkJsonObject::ckStringOf(jResp,"ImageBuilders[i].InstanceType")
Name = CkJsonObject::ckStringOf(jResp,"ImageBuilders[i].Name")
EniId = CkJsonObject::ckStringOf(jResp,"ImageBuilders[i].NetworkAccessConfiguration.EniId")
EniPrivateIpAddress = CkJsonObject::ckStringOf(jResp,"ImageBuilders[i].NetworkAccessConfiguration.EniPrivateIpAddress")
Platform = CkJsonObject::ckStringOf(jResp,"ImageBuilders[i].Platform")
State = CkJsonObject::ckStringOf(jResp,"ImageBuilders[i].State")
Code = CkJsonObject::ckStringOf(jResp,"ImageBuilders[i].StateChangeReason.Code")
Message = CkJsonObject::ckStringOf(jResp,"ImageBuilders[i].StateChangeReason.Message")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"ImageBuilders[i].AccessEndpoints")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
EndpointType = CkJsonObject::ckStringOf(jResp,"ImageBuilders[i].AccessEndpoints[j].EndpointType")
VpceId = CkJsonObject::ckStringOf(jResp,"ImageBuilders[i].AccessEndpoints[j].VpceId")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"ImageBuilders[i].ImageBuilderErrors")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
ErrorCode = CkJsonObject::ckStringOf(jResp,"ImageBuilders[i].ImageBuilderErrors[j].ErrorCode")
ErrorMessage = CkJsonObject::ckStringOf(jResp,"ImageBuilders[i].ImageBuilderErrors[j].ErrorMessage")
ErrorTimestamp = CkJsonObject::ckIntOf(jResp,"ImageBuilders[i].ImageBuilderErrors[j].ErrorTimestamp")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"ImageBuilders[i].VpcConfig.SecurityGroupIds")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"ImageBuilders[i].VpcConfig.SecurityGroupIds[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"ImageBuilders[i].VpcConfig.SubnetIds")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"ImageBuilders[i].VpcConfig.SubnetIds[j]")
j = j + 1
Wend
i = i + 1
Wend
; A sample JSON response body parsed by the above code:
; {
; "ImageBuilders": [
; {
; "AccessEndpoints": [
; {
; "EndpointType": "string",
; "VpceId": "string"
; }
; ],
; "AppstreamAgentVersion": "string",
; "Arn": "string",
; "CreatedTime": number,
; "Description": "string",
; "DisplayName": "string",
; "DomainJoinInfo": {
; "DirectoryName": "string",
; "OrganizationalUnitDistinguishedName": "string"
; },
; "EnableDefaultInternetAccess": boolean,
; "IamRoleArn": "string",
; "ImageArn": "string",
; "ImageBuilderErrors": [
; {
; "ErrorCode": "string",
; "ErrorMessage": "string",
; "ErrorTimestamp": number
; }
; ],
; "InstanceType": "string",
; "Name": "string",
; "NetworkAccessConfiguration": {
; "EniId": "string",
; "EniPrivateIpAddress": "string"
; },
; "Platform": "string",
; "State": "string",
; "StateChangeReason": {
; "Code": "string",
; "Message": "string"
; },
; "VpcConfig": {
; "SecurityGroupIds": [
; "string"
; ],
; "SubnetIds": [
; "string"
; ]
; }
; }
; ],
; "NextToken": "string"
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
