GetEBSVolumeRecommendations 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, "compute-optimizer")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://compute-optimizer.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"compute-optimizer.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,"accountIds[0]","string")
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,"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::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.0")
CkRest::ckAddHeader(rest,"X-Amz-Target","ComputeOptimizerService.GetEBSVolumeRecommendations")
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","/",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
code.s
identifier.s
message.s
accountId.s
VolumeBaselineIOPS.i
VolumeBaselineThroughput.i
VolumeBurstIOPS.i
VolumeBurstThroughput.i
VolumeSize.i
VolumeType.s
currentPerformanceRisk.s
finding.s
lastRefreshTimestamp.i
lookBackPeriodInDays.i
volumeArn.s
j.i
count_j.i
name.s
statistic.s
value.i
configurationVolumeBaselineIOPS.i
configurationVolumeBaselineThroughput.i
configurationVolumeBurstIOPS.i
configurationVolumeBurstThroughput.i
configurationVolumeSize.i
configurationVolumeType.s
performanceRisk.i
rank.i
v_Currency.s
Value.i
SavingsOpportunityPercentage.i
nextToken.s = CkJsonObject::ckStringOf(jResp,"nextToken")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"errors")
While i < count_i
CkJsonObject::setCkI(jResp, i)
code = CkJsonObject::ckStringOf(jResp,"errors[i].code")
identifier = CkJsonObject::ckStringOf(jResp,"errors[i].identifier")
message = CkJsonObject::ckStringOf(jResp,"errors[i].message")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"volumeRecommendations")
While i < count_i
CkJsonObject::setCkI(jResp, i)
accountId = CkJsonObject::ckStringOf(jResp,"volumeRecommendations[i].accountId")
VolumeBaselineIOPS = CkJsonObject::ckIntOf(jResp,"volumeRecommendations[i].currentConfiguration.volumeBaselineIOPS")
VolumeBaselineThroughput = CkJsonObject::ckIntOf(jResp,"volumeRecommendations[i].currentConfiguration.volumeBaselineThroughput")
VolumeBurstIOPS = CkJsonObject::ckIntOf(jResp,"volumeRecommendations[i].currentConfiguration.volumeBurstIOPS")
VolumeBurstThroughput = CkJsonObject::ckIntOf(jResp,"volumeRecommendations[i].currentConfiguration.volumeBurstThroughput")
VolumeSize = CkJsonObject::ckIntOf(jResp,"volumeRecommendations[i].currentConfiguration.volumeSize")
VolumeType = CkJsonObject::ckStringOf(jResp,"volumeRecommendations[i].currentConfiguration.volumeType")
currentPerformanceRisk = CkJsonObject::ckStringOf(jResp,"volumeRecommendations[i].currentPerformanceRisk")
finding = CkJsonObject::ckStringOf(jResp,"volumeRecommendations[i].finding")
lastRefreshTimestamp = CkJsonObject::ckIntOf(jResp,"volumeRecommendations[i].lastRefreshTimestamp")
lookBackPeriodInDays = CkJsonObject::ckIntOf(jResp,"volumeRecommendations[i].lookBackPeriodInDays")
volumeArn = CkJsonObject::ckStringOf(jResp,"volumeRecommendations[i].volumeArn")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"volumeRecommendations[i].utilizationMetrics")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
name = CkJsonObject::ckStringOf(jResp,"volumeRecommendations[i].utilizationMetrics[j].name")
statistic = CkJsonObject::ckStringOf(jResp,"volumeRecommendations[i].utilizationMetrics[j].statistic")
value = CkJsonObject::ckIntOf(jResp,"volumeRecommendations[i].utilizationMetrics[j].value")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"volumeRecommendations[i].volumeRecommendationOptions")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
configurationVolumeBaselineIOPS = CkJsonObject::ckIntOf(jResp,"volumeRecommendations[i].volumeRecommendationOptions[j].configuration.volumeBaselineIOPS")
configurationVolumeBaselineThroughput = CkJsonObject::ckIntOf(jResp,"volumeRecommendations[i].volumeRecommendationOptions[j].configuration.volumeBaselineThroughput")
configurationVolumeBurstIOPS = CkJsonObject::ckIntOf(jResp,"volumeRecommendations[i].volumeRecommendationOptions[j].configuration.volumeBurstIOPS")
configurationVolumeBurstThroughput = CkJsonObject::ckIntOf(jResp,"volumeRecommendations[i].volumeRecommendationOptions[j].configuration.volumeBurstThroughput")
configurationVolumeSize = CkJsonObject::ckIntOf(jResp,"volumeRecommendations[i].volumeRecommendationOptions[j].configuration.volumeSize")
configurationVolumeType = CkJsonObject::ckStringOf(jResp,"volumeRecommendations[i].volumeRecommendationOptions[j].configuration.volumeType")
performanceRisk = CkJsonObject::ckIntOf(jResp,"volumeRecommendations[i].volumeRecommendationOptions[j].performanceRisk")
rank = CkJsonObject::ckIntOf(jResp,"volumeRecommendations[i].volumeRecommendationOptions[j].rank")
v_Currency = CkJsonObject::ckStringOf(jResp,"volumeRecommendations[i].volumeRecommendationOptions[j].savingsOpportunity.estimatedMonthlySavings.currency")
Value = CkJsonObject::ckIntOf(jResp,"volumeRecommendations[i].volumeRecommendationOptions[j].savingsOpportunity.estimatedMonthlySavings.value")
SavingsOpportunityPercentage = CkJsonObject::ckIntOf(jResp,"volumeRecommendations[i].volumeRecommendationOptions[j].savingsOpportunity.savingsOpportunityPercentage")
j = j + 1
Wend
i = i + 1
Wend
; 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
; }
; }
; ]
; }
; ]
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
