GetEC2InstanceRecommendations 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::ckUpdateString(json,"instanceArns[0]","string")
CkJsonObject::ckUpdateInt(json,"maxResults",123)
CkJsonObject::ckUpdateString(json,"nextToken","string")
CkJsonObject::ckUpdateString(json,"recommendationPreferences.cpuVendorArchitectures[0]","string")
; The JSON request body created by the above code:
; {
; "accountIds": [
; "string"
; ],
; "filters": [
; {
; "name": "string",
; "values": [
; "string"
; ]
; }
; ],
; "instanceArns": [
; "string"
; ],
; "maxResults": number,
; "nextToken": "string",
; "recommendationPreferences": {
; "cpuVendorArchitectures": [
; "string"
; ]
; }
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.0")
CkRest::ckAddHeader(rest,"X-Amz-Target","ComputeOptimizerService.GetEC2InstanceRecommendations")
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
currentInstanceType.s
currentPerformanceRisk.s
EnhancedInfrastructureMetrics.s
InferredWorkloadTypes.s
finding.s
instanceArn.s
instanceName.s
lastRefreshTimestamp.i
lookBackPeriodInDays.i
j.i
count_j.i
strVal.s
instanceType.s
migrationEffort.s
performanceRisk.i
rank.i
v_Currency.s
Value.i
SavingsOpportunityPercentage.i
k.i
count_k.i
name.s
statistic.s
value.i
recommendationSourceArn.s
recommendationSourceType.s
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,"instanceRecommendations")
While i < count_i
CkJsonObject::setCkI(jResp, i)
accountId = CkJsonObject::ckStringOf(jResp,"instanceRecommendations[i].accountId")
currentInstanceType = CkJsonObject::ckStringOf(jResp,"instanceRecommendations[i].currentInstanceType")
currentPerformanceRisk = CkJsonObject::ckStringOf(jResp,"instanceRecommendations[i].currentPerformanceRisk")
EnhancedInfrastructureMetrics = CkJsonObject::ckStringOf(jResp,"instanceRecommendations[i].effectiveRecommendationPreferences.enhancedInfrastructureMetrics")
InferredWorkloadTypes = CkJsonObject::ckStringOf(jResp,"instanceRecommendations[i].effectiveRecommendationPreferences.inferredWorkloadTypes")
finding = CkJsonObject::ckStringOf(jResp,"instanceRecommendations[i].finding")
instanceArn = CkJsonObject::ckStringOf(jResp,"instanceRecommendations[i].instanceArn")
instanceName = CkJsonObject::ckStringOf(jResp,"instanceRecommendations[i].instanceName")
lastRefreshTimestamp = CkJsonObject::ckIntOf(jResp,"instanceRecommendations[i].lastRefreshTimestamp")
lookBackPeriodInDays = CkJsonObject::ckIntOf(jResp,"instanceRecommendations[i].lookBackPeriodInDays")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"instanceRecommendations[i].effectiveRecommendationPreferences.cpuVendorArchitectures")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"instanceRecommendations[i].effectiveRecommendationPreferences.cpuVendorArchitectures[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"instanceRecommendations[i].findingReasonCodes")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"instanceRecommendations[i].findingReasonCodes[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"instanceRecommendations[i].inferredWorkloadTypes")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"instanceRecommendations[i].inferredWorkloadTypes[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"instanceRecommendations[i].recommendationOptions")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
instanceType = CkJsonObject::ckStringOf(jResp,"instanceRecommendations[i].recommendationOptions[j].instanceType")
migrationEffort = CkJsonObject::ckStringOf(jResp,"instanceRecommendations[i].recommendationOptions[j].migrationEffort")
performanceRisk = CkJsonObject::ckIntOf(jResp,"instanceRecommendations[i].recommendationOptions[j].performanceRisk")
rank = CkJsonObject::ckIntOf(jResp,"instanceRecommendations[i].recommendationOptions[j].rank")
v_Currency = CkJsonObject::ckStringOf(jResp,"instanceRecommendations[i].recommendationOptions[j].savingsOpportunity.estimatedMonthlySavings.currency")
Value = CkJsonObject::ckIntOf(jResp,"instanceRecommendations[i].recommendationOptions[j].savingsOpportunity.estimatedMonthlySavings.value")
SavingsOpportunityPercentage = CkJsonObject::ckIntOf(jResp,"instanceRecommendations[i].recommendationOptions[j].savingsOpportunity.savingsOpportunityPercentage")
k = 0
count_k = CkJsonObject::ckSizeOfArray(jResp,"instanceRecommendations[i].recommendationOptions[j].platformDifferences")
While k < count_k
CkJsonObject::setCkK(jResp, k)
strVal = CkJsonObject::ckStringOf(jResp,"instanceRecommendations[i].recommendationOptions[j].platformDifferences[k]")
k = k + 1
Wend
k = 0
count_k = CkJsonObject::ckSizeOfArray(jResp,"instanceRecommendations[i].recommendationOptions[j].projectedUtilizationMetrics")
While k < count_k
CkJsonObject::setCkK(jResp, k)
name = CkJsonObject::ckStringOf(jResp,"instanceRecommendations[i].recommendationOptions[j].projectedUtilizationMetrics[k].name")
statistic = CkJsonObject::ckStringOf(jResp,"instanceRecommendations[i].recommendationOptions[j].projectedUtilizationMetrics[k].statistic")
value = CkJsonObject::ckIntOf(jResp,"instanceRecommendations[i].recommendationOptions[j].projectedUtilizationMetrics[k].value")
k = k + 1
Wend
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"instanceRecommendations[i].recommendationSources")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
recommendationSourceArn = CkJsonObject::ckStringOf(jResp,"instanceRecommendations[i].recommendationSources[j].recommendationSourceArn")
recommendationSourceType = CkJsonObject::ckStringOf(jResp,"instanceRecommendations[i].recommendationSources[j].recommendationSourceType")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"instanceRecommendations[i].utilizationMetrics")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
name = CkJsonObject::ckStringOf(jResp,"instanceRecommendations[i].utilizationMetrics[j].name")
statistic = CkJsonObject::ckStringOf(jResp,"instanceRecommendations[i].utilizationMetrics[j].statistic")
value = CkJsonObject::ckIntOf(jResp,"instanceRecommendations[i].utilizationMetrics[j].value")
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"
; }
; ],
; "instanceRecommendations": [
; {
; "accountId": "string",
; "currentInstanceType": "string",
; "currentPerformanceRisk": "string",
; "effectiveRecommendationPreferences": {
; "cpuVendorArchitectures": [
; "string"
; ],
; "enhancedInfrastructureMetrics": "string",
; "inferredWorkloadTypes": "string"
; },
; "finding": "string",
; "findingReasonCodes": [
; "string"
; ],
; "inferredWorkloadTypes": [
; "string"
; ],
; "instanceArn": "string",
; "instanceName": "string",
; "lastRefreshTimestamp": number,
; "lookBackPeriodInDays": number,
; "recommendationOptions": [
; {
; "instanceType": "string",
; "migrationEffort": "string",
; "performanceRisk": number,
; "platformDifferences": [
; "string"
; ],
; "projectedUtilizationMetrics": [
; {
; "name": "string",
; "statistic": "string",
; "value": number
; }
; ],
; "rank": number,
; "savingsOpportunity": {
; "estimatedMonthlySavings": {
; "currency": "string",
; "value": number
; },
; "savingsOpportunityPercentage": number
; }
; }
; ],
; "recommendationSources": [
; {
; "recommendationSourceArn": "string",
; "recommendationSourceType": "string"
; }
; ],
; "utilizationMetrics": [
; {
; "name": "string",
; "statistic": "string",
; "value": number
; }
; ]
; }
; ],
; "nextToken": "string"
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
