DescribeSavingsPlansOfferingRates 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,"operations[0]","string")
CkJsonObject::ckUpdateString(json,"products[0]","string")
CkJsonObject::ckUpdateString(json,"savingsPlanOfferingIds[0]","string")
CkJsonObject::ckUpdateString(json,"savingsPlanPaymentOptions[0]","string")
CkJsonObject::ckUpdateString(json,"savingsPlanTypes[0]","string")
CkJsonObject::ckUpdateString(json,"serviceCodes[0]","string")
CkJsonObject::ckUpdateString(json,"usageTypes[0]","string")
; The JSON request body created by the above code:
; {
; "filters": [
; {
; "name": "string",
; "values": [
; "string"
; ]
; }
; ],
; "maxResults": number,
; "nextToken": "string",
; "operations": [
; "string"
; ],
; "products": [
; "string"
; ],
; "savingsPlanOfferingIds": [
; "string"
; ],
; "savingsPlanPaymentOptions": [
; "string"
; ],
; "savingsPlanTypes": [
; "string"
; ],
; "serviceCodes": [
; "string"
; ],
; "usageTypes": [
; "string"
; ]
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.0")
CkRest::ckAddHeader(rest,"X-Amz-Target","DescribeSavingsPlansOfferingRates")
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","/DescribeSavingsPlansOfferingRates",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
operation.s
productType.s
rate.s
v_Currency.s
DurationSeconds.i
OfferingId.s
PaymentOption.s
PlanDescription.s
PlanType.s
serviceCode.s
unit.s
usageType.s
j.i
count_j.i
name.s
value.s
nextToken.s = CkJsonObject::ckStringOf(jResp,"nextToken")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"searchResults")
While i < count_i
CkJsonObject::setCkI(jResp, i)
operation = CkJsonObject::ckStringOf(jResp,"searchResults[i].operation")
productType = CkJsonObject::ckStringOf(jResp,"searchResults[i].productType")
rate = CkJsonObject::ckStringOf(jResp,"searchResults[i].rate")
v_Currency = CkJsonObject::ckStringOf(jResp,"searchResults[i].savingsPlanOffering.currency")
DurationSeconds = CkJsonObject::ckIntOf(jResp,"searchResults[i].savingsPlanOffering.durationSeconds")
OfferingId = CkJsonObject::ckStringOf(jResp,"searchResults[i].savingsPlanOffering.offeringId")
PaymentOption = CkJsonObject::ckStringOf(jResp,"searchResults[i].savingsPlanOffering.paymentOption")
PlanDescription = CkJsonObject::ckStringOf(jResp,"searchResults[i].savingsPlanOffering.planDescription")
PlanType = CkJsonObject::ckStringOf(jResp,"searchResults[i].savingsPlanOffering.planType")
serviceCode = CkJsonObject::ckStringOf(jResp,"searchResults[i].serviceCode")
unit = CkJsonObject::ckStringOf(jResp,"searchResults[i].unit")
usageType = CkJsonObject::ckStringOf(jResp,"searchResults[i].usageType")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"searchResults[i].properties")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
name = CkJsonObject::ckStringOf(jResp,"searchResults[i].properties[j].name")
value = CkJsonObject::ckStringOf(jResp,"searchResults[i].properties[j].value")
j = j + 1
Wend
i = i + 1
Wend
; A sample JSON response body parsed by the above code:
; {
; "nextToken": "string",
; "searchResults": [
; {
; "operation": "string",
; "productType": "string",
; "properties": [
; {
; "name": "string",
; "value": "string"
; }
; ],
; "rate": "string",
; "savingsPlanOffering": {
; "currency": "string",
; "durationSeconds": number,
; "offeringId": "string",
; "paymentOption": "string",
; "planDescription": "string",
; "planType": "string"
; },
; "serviceCode": "string",
; "unit": "string",
; "usageType": "string"
; }
; ]
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
