Chilkat Online Tools

DescribeBackups Ruby Example

AWS OpsWorks CM

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.UpdateString("BackupId","string")
json.UpdateInt("MaxResults",123)
json.UpdateString("NextToken","string")
json.UpdateString("ServerName","string")

# The JSON request body created by the above code:

# {
#   "BackupId": "string",
#   "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.DescribeBackups")

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("Backups")
while i < count_i
    jResp.put_I(i)
    BackupArn = jResp.stringOf("Backups[i].BackupArn")
    BackupId = jResp.stringOf("Backups[i].BackupId")
    BackupType = jResp.stringOf("Backups[i].BackupType")
    CreatedAt = jResp.IntOf("Backups[i].CreatedAt")
    Description = jResp.stringOf("Backups[i].Description")
    Engine = jResp.stringOf("Backups[i].Engine")
    EngineModel = jResp.stringOf("Backups[i].EngineModel")
    EngineVersion = jResp.stringOf("Backups[i].EngineVersion")
    InstanceProfileArn = jResp.stringOf("Backups[i].InstanceProfileArn")
    InstanceType = jResp.stringOf("Backups[i].InstanceType")
    KeyPair = jResp.stringOf("Backups[i].KeyPair")
    PreferredBackupWindow = jResp.stringOf("Backups[i].PreferredBackupWindow")
    PreferredMaintenanceWindow = jResp.stringOf("Backups[i].PreferredMaintenanceWindow")
    S3DataSize = jResp.IntOf("Backups[i].S3DataSize")
    S3DataUrl = jResp.stringOf("Backups[i].S3DataUrl")
    S3LogUrl = jResp.stringOf("Backups[i].S3LogUrl")
    ServerName = jResp.stringOf("Backups[i].ServerName")
    ServiceRoleArn = jResp.stringOf("Backups[i].ServiceRoleArn")
    Status = jResp.stringOf("Backups[i].Status")
    StatusDescription = jResp.stringOf("Backups[i].StatusDescription")
    ToolsVersion = jResp.stringOf("Backups[i].ToolsVersion")
    UserArn = jResp.stringOf("Backups[i].UserArn")
    j = 0
    count_j = jResp.SizeOfArray("Backups[i].SecurityGroupIds")
    while j < count_j
        jResp.put_J(j)
        strVal = jResp.stringOf("Backups[i].SecurityGroupIds[j]")
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("Backups[i].SubnetIds")
    while j < count_j
        jResp.put_J(j)
        strVal = jResp.stringOf("Backups[i].SubnetIds[j]")
        j = j + 1
    end
    i = i + 1
end

# A sample JSON response body parsed by the above code:

# {
#   "Backups": [
#     {
#       "BackupArn": "string",
#       "BackupId": "string",
#       "BackupType": "string",
#       "CreatedAt": number,
#       "Description": "string",
#       "Engine": "string",
#       "EngineModel": "string",
#       "EngineVersion": "string",
#       "InstanceProfileArn": "string",
#       "InstanceType": "string",
#       "KeyPair": "string",
#       "PreferredBackupWindow": "string",
#       "PreferredMaintenanceWindow": "string",
#       "S3DataSize": number,
#       "S3DataUrl": "string",
#       "S3LogUrl": "string",
#       "SecurityGroupIds": [
#         "string"
#       ],
#       "ServerName": "string",
#       "ServiceRoleArn": "string",
#       "Status": "string",
#       "StatusDescription": "string",
#       "SubnetIds": [
#         "string"
#       ],
#       "ToolsVersion": "string",
#       "UserArn": "string"
#     }
#   ],
#   "NextToken": "string"
# }