GetEBSVolumeRecommendations 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 "compute-optimizer"
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest_SetAuthAws $rest $authAws
# URL: https://compute-optimizer.us-west-2.amazonaws.com/
# Use the same region as specified above.
set success [CkRest_Connect $rest "compute-optimizer.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 "accountIds[0]" "string"
CkJsonObject_UpdateString $json "filters[0].name" "string"
CkJsonObject_UpdateString $json "filters[0].values[0]" "string"
CkJsonObject_UpdateInt $json "maxResults" 123
CkJsonObject_UpdateString $json "nextToken" "string"
CkJsonObject_UpdateString $json "volumeArns[0]" "string"
# The JSON request body created by the above code:
# {
# "accountIds": [
# "string"
# ],
# "filters": [
# {
# "name": "string",
# "values": [
# "string"
# ]
# }
# ],
# "maxResults": number,
# "nextToken": "string",
# "volumeArns": [
# "string"
# ]
# }
CkRest_AddHeader $rest "Content-Type" "application/x-amz-json-1.0"
CkRest_AddHeader $rest "X-Amz-Target" "ComputeOptimizerService.GetEBSVolumeRecommendations"
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 "errors"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set code [CkJsonObject_stringOf $jResp "errors[i].code"]
set identifier [CkJsonObject_stringOf $jResp "errors[i].identifier"]
set message [CkJsonObject_stringOf $jResp "errors[i].message"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "volumeRecommendations"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set accountId [CkJsonObject_stringOf $jResp "volumeRecommendations[i].accountId"]
set VolumeBaselineIOPS [CkJsonObject_IntOf $jResp "volumeRecommendations[i].currentConfiguration.volumeBaselineIOPS"]
set VolumeBaselineThroughput [CkJsonObject_IntOf $jResp "volumeRecommendations[i].currentConfiguration.volumeBaselineThroughput"]
set VolumeBurstIOPS [CkJsonObject_IntOf $jResp "volumeRecommendations[i].currentConfiguration.volumeBurstIOPS"]
set VolumeBurstThroughput [CkJsonObject_IntOf $jResp "volumeRecommendations[i].currentConfiguration.volumeBurstThroughput"]
set VolumeSize [CkJsonObject_IntOf $jResp "volumeRecommendations[i].currentConfiguration.volumeSize"]
set VolumeType [CkJsonObject_stringOf $jResp "volumeRecommendations[i].currentConfiguration.volumeType"]
set currentPerformanceRisk [CkJsonObject_stringOf $jResp "volumeRecommendations[i].currentPerformanceRisk"]
set finding [CkJsonObject_stringOf $jResp "volumeRecommendations[i].finding"]
set lastRefreshTimestamp [CkJsonObject_IntOf $jResp "volumeRecommendations[i].lastRefreshTimestamp"]
set lookBackPeriodInDays [CkJsonObject_IntOf $jResp "volumeRecommendations[i].lookBackPeriodInDays"]
set volumeArn [CkJsonObject_stringOf $jResp "volumeRecommendations[i].volumeArn"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "volumeRecommendations[i].utilizationMetrics"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set name [CkJsonObject_stringOf $jResp "volumeRecommendations[i].utilizationMetrics[j].name"]
set statistic [CkJsonObject_stringOf $jResp "volumeRecommendations[i].utilizationMetrics[j].statistic"]
set value [CkJsonObject_IntOf $jResp "volumeRecommendations[i].utilizationMetrics[j].value"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "volumeRecommendations[i].volumeRecommendationOptions"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set configurationVolumeBaselineIOPS [CkJsonObject_IntOf $jResp "volumeRecommendations[i].volumeRecommendationOptions[j].configuration.volumeBaselineIOPS"]
set configurationVolumeBaselineThroughput [CkJsonObject_IntOf $jResp "volumeRecommendations[i].volumeRecommendationOptions[j].configuration.volumeBaselineThroughput"]
set configurationVolumeBurstIOPS [CkJsonObject_IntOf $jResp "volumeRecommendations[i].volumeRecommendationOptions[j].configuration.volumeBurstIOPS"]
set configurationVolumeBurstThroughput [CkJsonObject_IntOf $jResp "volumeRecommendations[i].volumeRecommendationOptions[j].configuration.volumeBurstThroughput"]
set configurationVolumeSize [CkJsonObject_IntOf $jResp "volumeRecommendations[i].volumeRecommendationOptions[j].configuration.volumeSize"]
set configurationVolumeType [CkJsonObject_stringOf $jResp "volumeRecommendations[i].volumeRecommendationOptions[j].configuration.volumeType"]
set performanceRisk [CkJsonObject_IntOf $jResp "volumeRecommendations[i].volumeRecommendationOptions[j].performanceRisk"]
set rank [CkJsonObject_IntOf $jResp "volumeRecommendations[i].volumeRecommendationOptions[j].rank"]
set v_Currency [CkJsonObject_stringOf $jResp "volumeRecommendations[i].volumeRecommendationOptions[j].savingsOpportunity.estimatedMonthlySavings.currency"]
set Value [CkJsonObject_IntOf $jResp "volumeRecommendations[i].volumeRecommendationOptions[j].savingsOpportunity.estimatedMonthlySavings.value"]
set SavingsOpportunityPercentage [CkJsonObject_IntOf $jResp "volumeRecommendations[i].volumeRecommendationOptions[j].savingsOpportunity.savingsOpportunityPercentage"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
# A sample JSON response body parsed by the above code:
# {
# "errors": [
# {
# "code": "string",
# "identifier": "string",
# "message": "string"
# }
# ],
# "nextToken": "string",
# "volumeRecommendations": [
# {
# "accountId": "string",
# "currentConfiguration": {
# "volumeBaselineIOPS": number,
# "volumeBaselineThroughput": number,
# "volumeBurstIOPS": number,
# "volumeBurstThroughput": number,
# "volumeSize": number,
# "volumeType": "string"
# },
# "currentPerformanceRisk": "string",
# "finding": "string",
# "lastRefreshTimestamp": number,
# "lookBackPeriodInDays": number,
# "utilizationMetrics": [
# {
# "name": "string",
# "statistic": "string",
# "value": number
# }
# ],
# "volumeArn": "string",
# "volumeRecommendationOptions": [
# {
# "configuration": {
# "volumeBaselineIOPS": number,
# "volumeBaselineThroughput": number,
# "volumeBurstIOPS": number,
# "volumeBurstThroughput": number,
# "volumeSize": number,
# "volumeType": "string"
# },
# "performanceRisk": number,
# "rank": number,
# "savingsOpportunity": {
# "estimatedMonthlySavings": {
# "currency": "string",
# "value": number
# },
# "savingsOpportunityPercentage": number
# }
# }
# ]
# }
# ]
# }
delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
