DescribeSavingsPlans PureBasic Example
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkAuthAws.pb"
Procedure ChilkatExample()
; This example requires the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
rest.i = CkRest::ckCreate()
If rest.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
authAws.i = CkAuthAws::ckCreate()
If authAws.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkAuthAws::setCkAccessKey(authAws, "AWS_ACCESS_KEY")
CkAuthAws::setCkSecretKey(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::setCkRegion(authAws, "us-west-2")
CkAuthAws::setCkServiceName(authAws, "savingsplans")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://savingsplans.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"savingsplans.us-west-2.amazonaws.com",443,1,1)
If success <> 1
Debug "ConnectFailReason: " + Str(CkRest::ckConnectFailReason(rest))
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
ProcedureReturn
EndIf
; 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.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"filters[0].name","string")
CkJsonObject::ckUpdateString(json,"filters[0].values[0]","string")
CkJsonObject::ckUpdateInt(json,"maxResults",123)
CkJsonObject::ckUpdateString(json,"nextToken","string")
CkJsonObject::ckUpdateString(json,"savingsPlanArns[0]","string")
CkJsonObject::ckUpdateString(json,"savingsPlanIds[0]","string")
CkJsonObject::ckUpdateString(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::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.0")
CkRest::ckAddHeader(rest,"X-Amz-Target","DescribeSavingsPlans")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkRest::ckFullRequestSb(rest,"POST","/DescribeSavingsPlans",sbRequestBody,sbResponseBody)
If success <> 1
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
respStatusCode.i = CkRest::ckResponseStatusCode(rest)
Debug "response status code = " + Str(respStatusCode)
If respStatusCode <> 200
Debug "Response Header:"
Debug CkRest::ckResponseHeader(rest)
Debug "Response Body:"
Debug CkStringBuilder::ckGetAsString(sbResponseBody)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(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
commitment.s
v_currency.s
description.s
ec2InstanceFamily.s
v_end.s
offeringId.s
paymentOption.s
recurringPaymentAmount.s
region.s
savingsPlanArn.s
savingsPlanId.s
savingsPlanType.s
start.s
state.s
v_String.s
termDurationInSeconds.i
upfrontPaymentAmount.s
j.i
count_j.i
strVal.s
nextToken.s = CkJsonObject::ckStringOf(jResp,"nextToken")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"savingsPlans")
While i < count_i
CkJsonObject::setCkI(jResp, i)
commitment = CkJsonObject::ckStringOf(jResp,"savingsPlans[i].commitment")
v_currency = CkJsonObject::ckStringOf(jResp,"savingsPlans[i].currency")
description = CkJsonObject::ckStringOf(jResp,"savingsPlans[i].description")
ec2InstanceFamily = CkJsonObject::ckStringOf(jResp,"savingsPlans[i].ec2InstanceFamily")
v_end = CkJsonObject::ckStringOf(jResp,"savingsPlans[i].end")
offeringId = CkJsonObject::ckStringOf(jResp,"savingsPlans[i].offeringId")
paymentOption = CkJsonObject::ckStringOf(jResp,"savingsPlans[i].paymentOption")
recurringPaymentAmount = CkJsonObject::ckStringOf(jResp,"savingsPlans[i].recurringPaymentAmount")
region = CkJsonObject::ckStringOf(jResp,"savingsPlans[i].region")
savingsPlanArn = CkJsonObject::ckStringOf(jResp,"savingsPlans[i].savingsPlanArn")
savingsPlanId = CkJsonObject::ckStringOf(jResp,"savingsPlans[i].savingsPlanId")
savingsPlanType = CkJsonObject::ckStringOf(jResp,"savingsPlans[i].savingsPlanType")
start = CkJsonObject::ckStringOf(jResp,"savingsPlans[i].start")
state = CkJsonObject::ckStringOf(jResp,"savingsPlans[i].state")
v_String = CkJsonObject::ckStringOf(jResp,"savingsPlans[i].tags.string")
termDurationInSeconds = CkJsonObject::ckIntOf(jResp,"savingsPlans[i].termDurationInSeconds")
upfrontPaymentAmount = CkJsonObject::ckStringOf(jResp,"savingsPlans[i].upfrontPaymentAmount")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"savingsPlans[i].productTypes")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"savingsPlans[i].productTypes[j]")
j = j + 1
Wend
i = i + 1
Wend
; 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"
; }
; ]
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
