Chilkat Online Tools

DescribeImageBuilders TCL Example

Amazon AppStream

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_UpdateInt $json "MaxResults" 123
CkJsonObject_UpdateString $json "Names[0]" "string"
CkJsonObject_UpdateString $json "NextToken" "string"

# The JSON request body created by the above code:

# {
#   "MaxResults": number,
#   "Names": [
#     "string"
#   ],
#   "NextToken": "string"
# }

CkRest_AddHeader $rest "Content-Type" "application/x-amz-json-1.1"
CkRest_AddHeader $rest "X-Amz-Target" "PhotonAdminProxyService.DescribeImageBuilders"

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 "ImageBuilders"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set AppstreamAgentVersion [CkJsonObject_stringOf $jResp "ImageBuilders[i].AppstreamAgentVersion"]
    set Arn [CkJsonObject_stringOf $jResp "ImageBuilders[i].Arn"]
    set CreatedTime [CkJsonObject_IntOf $jResp "ImageBuilders[i].CreatedTime"]
    set Description [CkJsonObject_stringOf $jResp "ImageBuilders[i].Description"]
    set DisplayName [CkJsonObject_stringOf $jResp "ImageBuilders[i].DisplayName"]
    set DirectoryName [CkJsonObject_stringOf $jResp "ImageBuilders[i].DomainJoinInfo.DirectoryName"]
    set OrganizationalUnitDistinguishedName [CkJsonObject_stringOf $jResp "ImageBuilders[i].DomainJoinInfo.OrganizationalUnitDistinguishedName"]
    set EnableDefaultInternetAccess [CkJsonObject_IntOf $jResp "ImageBuilders[i].EnableDefaultInternetAccess"]
    set IamRoleArn [CkJsonObject_stringOf $jResp "ImageBuilders[i].IamRoleArn"]
    set ImageArn [CkJsonObject_stringOf $jResp "ImageBuilders[i].ImageArn"]
    set InstanceType [CkJsonObject_stringOf $jResp "ImageBuilders[i].InstanceType"]
    set Name [CkJsonObject_stringOf $jResp "ImageBuilders[i].Name"]
    set EniId [CkJsonObject_stringOf $jResp "ImageBuilders[i].NetworkAccessConfiguration.EniId"]
    set EniPrivateIpAddress [CkJsonObject_stringOf $jResp "ImageBuilders[i].NetworkAccessConfiguration.EniPrivateIpAddress"]
    set Platform [CkJsonObject_stringOf $jResp "ImageBuilders[i].Platform"]
    set State [CkJsonObject_stringOf $jResp "ImageBuilders[i].State"]
    set Code [CkJsonObject_stringOf $jResp "ImageBuilders[i].StateChangeReason.Code"]
    set Message [CkJsonObject_stringOf $jResp "ImageBuilders[i].StateChangeReason.Message"]
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "ImageBuilders[i].AccessEndpoints"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set EndpointType [CkJsonObject_stringOf $jResp "ImageBuilders[i].AccessEndpoints[j].EndpointType"]
        set VpceId [CkJsonObject_stringOf $jResp "ImageBuilders[i].AccessEndpoints[j].VpceId"]
        set j [expr $j + 1]
    }
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "ImageBuilders[i].ImageBuilderErrors"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set ErrorCode [CkJsonObject_stringOf $jResp "ImageBuilders[i].ImageBuilderErrors[j].ErrorCode"]
        set ErrorMessage [CkJsonObject_stringOf $jResp "ImageBuilders[i].ImageBuilderErrors[j].ErrorMessage"]
        set ErrorTimestamp [CkJsonObject_IntOf $jResp "ImageBuilders[i].ImageBuilderErrors[j].ErrorTimestamp"]
        set j [expr $j + 1]
    }
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "ImageBuilders[i].VpcConfig.SecurityGroupIds"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set strVal [CkJsonObject_stringOf $jResp "ImageBuilders[i].VpcConfig.SecurityGroupIds[j]"]
        set j [expr $j + 1]
    }
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "ImageBuilders[i].VpcConfig.SubnetIds"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set strVal [CkJsonObject_stringOf $jResp "ImageBuilders[i].VpcConfig.SubnetIds[j]"]
        set j [expr $j + 1]
    }
    set i [expr $i + 1]
}

# 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"
# }

delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp