DescribeBackups 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 "opsworks-cm"
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest_SetAuthAws $rest $authAws
# URL: https://opsworks-cm.us-west-2.amazonaws.com/
# Use the same region as specified above.
set success [CkRest_Connect $rest "opsworks-cm.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 "BackupId" "string"
CkJsonObject_UpdateInt $json "MaxResults" 123
CkJsonObject_UpdateString $json "NextToken" "string"
CkJsonObject_UpdateString $json "ServerName" "string"
# The JSON request body created by the above code:
# {
# "BackupId": "string",
# "MaxResults": number,
# "NextToken": "string",
# "ServerName": "string"
# }
CkRest_AddHeader $rest "Content-Type" "application/x-amz-json-1.1"
CkRest_AddHeader $rest "X-Amz-Target" "OpsWorksCM_V2016_11_01.DescribeBackups"
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 "Backups"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set BackupArn [CkJsonObject_stringOf $jResp "Backups[i].BackupArn"]
set BackupId [CkJsonObject_stringOf $jResp "Backups[i].BackupId"]
set BackupType [CkJsonObject_stringOf $jResp "Backups[i].BackupType"]
set CreatedAt [CkJsonObject_IntOf $jResp "Backups[i].CreatedAt"]
set Description [CkJsonObject_stringOf $jResp "Backups[i].Description"]
set Engine [CkJsonObject_stringOf $jResp "Backups[i].Engine"]
set EngineModel [CkJsonObject_stringOf $jResp "Backups[i].EngineModel"]
set EngineVersion [CkJsonObject_stringOf $jResp "Backups[i].EngineVersion"]
set InstanceProfileArn [CkJsonObject_stringOf $jResp "Backups[i].InstanceProfileArn"]
set InstanceType [CkJsonObject_stringOf $jResp "Backups[i].InstanceType"]
set KeyPair [CkJsonObject_stringOf $jResp "Backups[i].KeyPair"]
set PreferredBackupWindow [CkJsonObject_stringOf $jResp "Backups[i].PreferredBackupWindow"]
set PreferredMaintenanceWindow [CkJsonObject_stringOf $jResp "Backups[i].PreferredMaintenanceWindow"]
set S3DataSize [CkJsonObject_IntOf $jResp "Backups[i].S3DataSize"]
set S3DataUrl [CkJsonObject_stringOf $jResp "Backups[i].S3DataUrl"]
set S3LogUrl [CkJsonObject_stringOf $jResp "Backups[i].S3LogUrl"]
set ServerName [CkJsonObject_stringOf $jResp "Backups[i].ServerName"]
set ServiceRoleArn [CkJsonObject_stringOf $jResp "Backups[i].ServiceRoleArn"]
set Status [CkJsonObject_stringOf $jResp "Backups[i].Status"]
set StatusDescription [CkJsonObject_stringOf $jResp "Backups[i].StatusDescription"]
set ToolsVersion [CkJsonObject_stringOf $jResp "Backups[i].ToolsVersion"]
set UserArn [CkJsonObject_stringOf $jResp "Backups[i].UserArn"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "Backups[i].SecurityGroupIds"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set strVal [CkJsonObject_stringOf $jResp "Backups[i].SecurityGroupIds[j]"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "Backups[i].SubnetIds"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set strVal [CkJsonObject_stringOf $jResp "Backups[i].SubnetIds[j]"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
# 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"
# }
delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp