DescribeImages TCL Example
load ./chilkat.dll
# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set rest [new_CkRest]
set authAws [new_CkAuthAws]
CkAuthAws_put_AccessKey $authAws "AWS_ACCESS_KEY"
CkAuthAws_put_SecretKey $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_put_Region $authAws "us-west-2"
CkAuthAws_put_ServiceName $authAws "appstream"
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest_SetAuthAws $rest $authAws
# URL: https://appstream2.us-west-2.amazonaws.com/
# Use the same region as specified above.
set success [CkRest_Connect $rest "appstream2.us-west-2.amazonaws.com" 443 1 1]
if {$success != 1} then {
puts "ConnectFailReason: [CkRest_get_ConnectFailReason $rest]"
puts [CkRest_lastErrorText $rest]
delete_CkRest $rest
delete_CkAuthAws $authAws
exit
}
# 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
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "Arns[0]" "string"
CkJsonObject_UpdateInt $json "MaxResults" 123
CkJsonObject_UpdateString $json "Names[0]" "string"
CkJsonObject_UpdateString $json "NextToken" "string"
CkJsonObject_UpdateString $json "Type" "string"
# The JSON request body created by the above code:
# {
# "Arns": [
# "string"
# ],
# "MaxResults": number,
# "Names": [
# "string"
# ],
# "NextToken": "string",
# "Type": "string"
# }
CkRest_AddHeader $rest "Content-Type" "application/x-amz-json-1.1"
CkRest_AddHeader $rest "X-Amz-Target" "PhotonAdminProxyService.DescribeImages"
set sbRequestBody [new_CkStringBuilder]
CkJsonObject_EmitSb $json $sbRequestBody
set sbResponseBody [new_CkStringBuilder]
set success [CkRest_FullRequestSb $rest "POST" "/" $sbRequestBody $sbResponseBody]
if {$success != 1} then {
puts [CkRest_lastErrorText $rest]
delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
exit
}
set respStatusCode [CkRest_get_ResponseStatusCode $rest]
puts "response status code = $respStatusCode"
if {$respStatusCode != 200} then {
puts "Response Header:"
puts [CkRest_responseHeader $rest]
puts "Response Body:"
puts [CkStringBuilder_getAsString $sbResponseBody]
delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $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
set NextToken [CkJsonObject_stringOf $jResp "NextToken"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "Images"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set AppstreamAgentVersion [CkJsonObject_stringOf $jResp "Images[i].AppstreamAgentVersion"]
set Arn [CkJsonObject_stringOf $jResp "Images[i].Arn"]
set BaseImageArn [CkJsonObject_stringOf $jResp "Images[i].BaseImageArn"]
set CreatedTime [CkJsonObject_IntOf $jResp "Images[i].CreatedTime"]
set Description [CkJsonObject_stringOf $jResp "Images[i].Description"]
set DisplayName [CkJsonObject_stringOf $jResp "Images[i].DisplayName"]
set ImageBuilderName [CkJsonObject_stringOf $jResp "Images[i].ImageBuilderName"]
set ImageBuilderSupported [CkJsonObject_IntOf $jResp "Images[i].ImageBuilderSupported"]
set AllowFleet [CkJsonObject_IntOf $jResp "Images[i].ImagePermissions.allowFleet"]
set AllowImageBuilder [CkJsonObject_IntOf $jResp "Images[i].ImagePermissions.allowImageBuilder"]
set Name [CkJsonObject_stringOf $jResp "Images[i].Name"]
set Platform [CkJsonObject_stringOf $jResp "Images[i].Platform"]
set PublicBaseImageReleasedDate [CkJsonObject_IntOf $jResp "Images[i].PublicBaseImageReleasedDate"]
set State [CkJsonObject_stringOf $jResp "Images[i].State"]
set Code [CkJsonObject_stringOf $jResp "Images[i].StateChangeReason.Code"]
set Message [CkJsonObject_stringOf $jResp "Images[i].StateChangeReason.Message"]
set Visibility [CkJsonObject_stringOf $jResp "Images[i].Visibility"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "Images[i].Applications"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set AppBlockArn [CkJsonObject_stringOf $jResp "Images[i].Applications[j].AppBlockArn"]
set Arn [CkJsonObject_stringOf $jResp "Images[i].Applications[j].Arn"]
set CreatedTime [CkJsonObject_IntOf $jResp "Images[i].Applications[j].CreatedTime"]
set Description [CkJsonObject_stringOf $jResp "Images[i].Applications[j].Description"]
set DisplayName [CkJsonObject_stringOf $jResp "Images[i].Applications[j].DisplayName"]
set Enabled [CkJsonObject_IntOf $jResp "Images[i].Applications[j].Enabled"]
set S3Bucket [CkJsonObject_stringOf $jResp "Images[i].Applications[j].IconS3Location.S3Bucket"]
set S3Key [CkJsonObject_stringOf $jResp "Images[i].Applications[j].IconS3Location.S3Key"]
set IconURL [CkJsonObject_stringOf $jResp "Images[i].Applications[j].IconURL"]
set LaunchParameters [CkJsonObject_stringOf $jResp "Images[i].Applications[j].LaunchParameters"]
set LaunchPath [CkJsonObject_stringOf $jResp "Images[i].Applications[j].LaunchPath"]
set v_String [CkJsonObject_stringOf $jResp "Images[i].Applications[j].Metadata.string"]
set Name [CkJsonObject_stringOf $jResp "Images[i].Applications[j].Name"]
set WorkingDirectory [CkJsonObject_stringOf $jResp "Images[i].Applications[j].WorkingDirectory"]
set k 0
set count_k [CkJsonObject_SizeOfArray $jResp "Images[i].Applications[j].InstanceFamilies"]
while {$k < $count_k} {
CkJsonObject_put_K $jResp $k
set strVal [CkJsonObject_stringOf $jResp "Images[i].Applications[j].InstanceFamilies[k]"]
set k [expr $k + 1]
}
set k 0
set count_k [CkJsonObject_SizeOfArray $jResp "Images[i].Applications[j].Platforms"]
while {$k < $count_k} {
CkJsonObject_put_K $jResp $k
set strVal [CkJsonObject_stringOf $jResp "Images[i].Applications[j].Platforms[k]"]
set k [expr $k + 1]
}
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "Images[i].ImageErrors"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set ErrorCode [CkJsonObject_stringOf $jResp "Images[i].ImageErrors[j].ErrorCode"]
set ErrorMessage [CkJsonObject_stringOf $jResp "Images[i].ImageErrors[j].ErrorMessage"]
set ErrorTimestamp [CkJsonObject_IntOf $jResp "Images[i].ImageErrors[j].ErrorTimestamp"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
# 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"
# }
delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
