DescribeServers 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("opsworks-cm")
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
rest.SetAuthAws(authAws)
# URL: https://opsworks-cm.us-west-2.amazonaws.com/
# Use the same region as specified above.
success = rest.Connect("opsworks-cm.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("NextToken","string")
json.UpdateString("ServerName","string")
# The JSON request body created by the above code:
# {
# "MaxResults": number,
# "NextToken": "string",
# "ServerName": "string"
# }
rest.AddHeader("Content-Type","application/x-amz-json-1.1")
rest.AddHeader("X-Amz-Target","OpsWorksCM_V2016_11_01.DescribeServers")
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("Servers")
while i < count_i
jResp.put_I(i)
AssociatePublicIpAddress = jResp.IntOf("Servers[i].AssociatePublicIpAddress")
BackupRetentionCount = jResp.IntOf("Servers[i].BackupRetentionCount")
CloudFormationStackArn = jResp.stringOf("Servers[i].CloudFormationStackArn")
CreatedAt = jResp.IntOf("Servers[i].CreatedAt")
CustomDomain = jResp.stringOf("Servers[i].CustomDomain")
DisableAutomatedBackup = jResp.IntOf("Servers[i].DisableAutomatedBackup")
Endpoint = jResp.stringOf("Servers[i].Endpoint")
Engine = jResp.stringOf("Servers[i].Engine")
EngineModel = jResp.stringOf("Servers[i].EngineModel")
EngineVersion = jResp.stringOf("Servers[i].EngineVersion")
InstanceProfileArn = jResp.stringOf("Servers[i].InstanceProfileArn")
InstanceType = jResp.stringOf("Servers[i].InstanceType")
KeyPair = jResp.stringOf("Servers[i].KeyPair")
MaintenanceStatus = jResp.stringOf("Servers[i].MaintenanceStatus")
PreferredBackupWindow = jResp.stringOf("Servers[i].PreferredBackupWindow")
PreferredMaintenanceWindow = jResp.stringOf("Servers[i].PreferredMaintenanceWindow")
ServerArn = jResp.stringOf("Servers[i].ServerArn")
ServerName = jResp.stringOf("Servers[i].ServerName")
ServiceRoleArn = jResp.stringOf("Servers[i].ServiceRoleArn")
Status = jResp.stringOf("Servers[i].Status")
StatusReason = jResp.stringOf("Servers[i].StatusReason")
j = 0
count_j = jResp.SizeOfArray("Servers[i].EngineAttributes")
while j < count_j
jResp.put_J(j)
Name = jResp.stringOf("Servers[i].EngineAttributes[j].Name")
Value = jResp.stringOf("Servers[i].EngineAttributes[j].Value")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("Servers[i].SecurityGroupIds")
while j < count_j
jResp.put_J(j)
strVal = jResp.stringOf("Servers[i].SecurityGroupIds[j]")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("Servers[i].SubnetIds")
while j < count_j
jResp.put_J(j)
strVal = jResp.stringOf("Servers[i].SubnetIds[j]")
j = j + 1
end
i = i + 1
end
# A sample JSON response body parsed by the above code:
# {
# "NextToken": "string",
# "Servers": [
# {
# "AssociatePublicIpAddress": boolean,
# "BackupRetentionCount": number,
# "CloudFormationStackArn": "string",
# "CreatedAt": number,
# "CustomDomain": "string",
# "DisableAutomatedBackup": boolean,
# "Endpoint": "string",
# "Engine": "string",
# "EngineAttributes": [
# {
# "Name": "string",
# "Value": "string"
# }
# ],
# "EngineModel": "string",
# "EngineVersion": "string",
# "InstanceProfileArn": "string",
# "InstanceType": "string",
# "KeyPair": "string",
# "MaintenanceStatus": "string",
# "PreferredBackupWindow": "string",
# "PreferredMaintenanceWindow": "string",
# "SecurityGroupIds": [
# "string"
# ],
# "ServerArn": "string",
# "ServerName": "string",
# "ServiceRoleArn": "string",
# "Status": "string",
# "StatusReason": "string",
# "SubnetIds": [
# "string"
# ]
# }
# ]
# }