Chilkat Online Tools

DescribeSavingsPlans TCL Example

AWS Savings Plans

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 "savingsplans"
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest_SetAuthAws $rest $authAws

# URL: https://savingsplans.us-west-2.amazonaws.com/
# Use the same region as specified above.
set success [CkRest_Connect $rest "savingsplans.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 "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 "savingsPlanArns[0]" "string"
CkJsonObject_UpdateString $json "savingsPlanIds[0]" "string"
CkJsonObject_UpdateString $json "states[0]" "string"

# The JSON request body created by the above code:

# {
#   "filters": [
#     {
#       "name": "string",
#       "values": [
#         "string"
#       ]
#     }
#   ],
#   "maxResults": number,
#   "nextToken": "string",
#   "savingsPlanArns": [
#     "string"
#   ],
#   "savingsPlanIds": [
#     "string"
#   ],
#   "states": [
#     "string"
#   ]
# }

CkRest_AddHeader $rest "Content-Type" "application/x-amz-json-1.0"
CkRest_AddHeader $rest "X-Amz-Target" "DescribeSavingsPlans"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody
set sbResponseBody [new_CkStringBuilder]

set success [CkRest_FullRequestSb $rest "POST" "/DescribeSavingsPlans" $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 "savingsPlans"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set commitment [CkJsonObject_stringOf $jResp "savingsPlans[i].commitment"]
    set v_currency [CkJsonObject_stringOf $jResp "savingsPlans[i].currency"]
    set description [CkJsonObject_stringOf $jResp "savingsPlans[i].description"]
    set ec2InstanceFamily [CkJsonObject_stringOf $jResp "savingsPlans[i].ec2InstanceFamily"]
    set v_end [CkJsonObject_stringOf $jResp "savingsPlans[i].end"]
    set offeringId [CkJsonObject_stringOf $jResp "savingsPlans[i].offeringId"]
    set paymentOption [CkJsonObject_stringOf $jResp "savingsPlans[i].paymentOption"]
    set recurringPaymentAmount [CkJsonObject_stringOf $jResp "savingsPlans[i].recurringPaymentAmount"]
    set region [CkJsonObject_stringOf $jResp "savingsPlans[i].region"]
    set savingsPlanArn [CkJsonObject_stringOf $jResp "savingsPlans[i].savingsPlanArn"]
    set savingsPlanId [CkJsonObject_stringOf $jResp "savingsPlans[i].savingsPlanId"]
    set savingsPlanType [CkJsonObject_stringOf $jResp "savingsPlans[i].savingsPlanType"]
    set start [CkJsonObject_stringOf $jResp "savingsPlans[i].start"]
    set state [CkJsonObject_stringOf $jResp "savingsPlans[i].state"]
    set v_String [CkJsonObject_stringOf $jResp "savingsPlans[i].tags.string"]
    set termDurationInSeconds [CkJsonObject_IntOf $jResp "savingsPlans[i].termDurationInSeconds"]
    set upfrontPaymentAmount [CkJsonObject_stringOf $jResp "savingsPlans[i].upfrontPaymentAmount"]
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "savingsPlans[i].productTypes"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set strVal [CkJsonObject_stringOf $jResp "savingsPlans[i].productTypes[j]"]
        set j [expr $j + 1]
    }
    set i [expr $i + 1]
}

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

# {
#   "nextToken": "string",
#   "savingsPlans": [
#     {
#       "commitment": "string",
#       "currency": "string",
#       "description": "string",
#       "ec2InstanceFamily": "string",
#       "end": "string",
#       "offeringId": "string",
#       "paymentOption": "string",
#       "productTypes": [
#         "string"
#       ],
#       "recurringPaymentAmount": "string",
#       "region": "string",
#       "savingsPlanArn": "string",
#       "savingsPlanId": "string",
#       "savingsPlanType": "string",
#       "start": "string",
#       "state": "string",
#       "tags": {
#         "string": "string"
#       },
#       "termDurationInSeconds": number,
#       "upfrontPaymentAmount": "string"
#     }
#   ]
# }

delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp