DescribeImageBuilders Ruby Example
require 'chilkat'
# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
rest = Chilkat::CkRest.new()
authAws = Chilkat::CkAuthAws.new()
authAws.put_AccessKey("AWS_ACCESS_KEY")
authAws.put_SecretKey("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.)
authAws.put_Region("us-west-2")
authAws.put_ServiceName("appstream")
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
rest.SetAuthAws(authAws)
# URL: https://appstream2.us-west-2.amazonaws.com/
# Use the same region as specified above.
success = rest.Connect("appstream2.us-west-2.amazonaws.com",443,true,true)
if (success != true)
print "ConnectFailReason: " + rest.get_ConnectFailReason().to_s() + "\n";
print rest.lastErrorText() + "\n";
exit
end
# 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 = Chilkat::CkJsonObject.new()
json.UpdateInt("MaxResults",123)
json.UpdateString("Names[0]","string")
json.UpdateString("NextToken","string")
# The JSON request body created by the above code:
# {
# "MaxResults": number,
# "Names": [
# "string"
# ],
# "NextToken": "string"
# }
rest.AddHeader("Content-Type","application/x-amz-json-1.1")
rest.AddHeader("X-Amz-Target","PhotonAdminProxyService.DescribeImageBuilders")
sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)
sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody)
if (success != true)
print rest.lastErrorText() + "\n";
exit
end
respStatusCode = rest.get_ResponseStatusCode()
print "response status code = " + respStatusCode.to_s() + "\n";
if (respStatusCode != 200)
print "Response Header:" + "\n";
print rest.responseHeader() + "\n";
print "Response Body:" + "\n";
print sbResponseBody.getAsString() + "\n";
exit
end
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(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
NextToken = jResp.stringOf("NextToken")
i = 0
count_i = jResp.SizeOfArray("ImageBuilders")
while i < count_i
jResp.put_I(i)
AppstreamAgentVersion = jResp.stringOf("ImageBuilders[i].AppstreamAgentVersion")
Arn = jResp.stringOf("ImageBuilders[i].Arn")
CreatedTime = jResp.IntOf("ImageBuilders[i].CreatedTime")
Description = jResp.stringOf("ImageBuilders[i].Description")
DisplayName = jResp.stringOf("ImageBuilders[i].DisplayName")
DirectoryName = jResp.stringOf("ImageBuilders[i].DomainJoinInfo.DirectoryName")
OrganizationalUnitDistinguishedName = jResp.stringOf("ImageBuilders[i].DomainJoinInfo.OrganizationalUnitDistinguishedName")
EnableDefaultInternetAccess = jResp.IntOf("ImageBuilders[i].EnableDefaultInternetAccess")
IamRoleArn = jResp.stringOf("ImageBuilders[i].IamRoleArn")
ImageArn = jResp.stringOf("ImageBuilders[i].ImageArn")
InstanceType = jResp.stringOf("ImageBuilders[i].InstanceType")
Name = jResp.stringOf("ImageBuilders[i].Name")
EniId = jResp.stringOf("ImageBuilders[i].NetworkAccessConfiguration.EniId")
EniPrivateIpAddress = jResp.stringOf("ImageBuilders[i].NetworkAccessConfiguration.EniPrivateIpAddress")
Platform = jResp.stringOf("ImageBuilders[i].Platform")
State = jResp.stringOf("ImageBuilders[i].State")
Code = jResp.stringOf("ImageBuilders[i].StateChangeReason.Code")
Message = jResp.stringOf("ImageBuilders[i].StateChangeReason.Message")
j = 0
count_j = jResp.SizeOfArray("ImageBuilders[i].AccessEndpoints")
while j < count_j
jResp.put_J(j)
EndpointType = jResp.stringOf("ImageBuilders[i].AccessEndpoints[j].EndpointType")
VpceId = jResp.stringOf("ImageBuilders[i].AccessEndpoints[j].VpceId")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("ImageBuilders[i].ImageBuilderErrors")
while j < count_j
jResp.put_J(j)
ErrorCode = jResp.stringOf("ImageBuilders[i].ImageBuilderErrors[j].ErrorCode")
ErrorMessage = jResp.stringOf("ImageBuilders[i].ImageBuilderErrors[j].ErrorMessage")
ErrorTimestamp = jResp.IntOf("ImageBuilders[i].ImageBuilderErrors[j].ErrorTimestamp")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("ImageBuilders[i].VpcConfig.SecurityGroupIds")
while j < count_j
jResp.put_J(j)
strVal = jResp.stringOf("ImageBuilders[i].VpcConfig.SecurityGroupIds[j]")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("ImageBuilders[i].VpcConfig.SubnetIds")
while j < count_j
jResp.put_J(j)
strVal = jResp.stringOf("ImageBuilders[i].VpcConfig.SubnetIds[j]")
j = j + 1
end
i = i + 1
end
# 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"
# }