Chilkat Tools

GetEBSVolumeRecommendations Python Example

AWS Compute Optimizer

import sys
import chilkat2

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

rest = chilkat2.Rest()

authAws = chilkat2.AuthAws()
authAws.AccessKey = "AWS_ACCESS_KEY"
authAws.SecretKey = "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.)
authAws.Region = "us-west-2"
authAws.ServiceName = "compute-optimizer"
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
rest.SetAuthAws(authAws)

# URL: https://compute-optimizer.us-west-2.amazonaws.com/
# Use the same region as specified above.
success = rest.Connect("compute-optimizer.us-west-2.amazonaws.com",443,True,True)
if (success != True):
    print("ConnectFailReason: " + str(rest.ConnectFailReason))
    print(rest.LastErrorText)
    sys.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

json = chilkat2.JsonObject()
json.UpdateString("accountIds[0]","string")
json.UpdateString("filters[0].name","string")
json.UpdateString("filters[0].values[0]","string")
json.UpdateInt("maxResults",123)
json.UpdateString("nextToken","string")
json.UpdateString("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"
#   ]
# }

rest.AddHeader("Content-Type","application/x-amz-json-1.0")
rest.AddHeader("X-Amz-Target","ComputeOptimizerService.GetEBSVolumeRecommendations")

sbRequestBody = chilkat2.StringBuilder()
json.EmitSb(sbRequestBody)
sbResponseBody = chilkat2.StringBuilder()
success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody)
if (success != True):
    print(rest.LastErrorText)
    sys.exit()

respStatusCode = rest.ResponseStatusCode
print("response status code = " + str(respStatusCode))
if (respStatusCode != 200):
    print("Response Header:")
    print(rest.ResponseHeader)
    print("Response Body:")
    print(sbResponseBody.GetAsString())
    sys.exit()

jResp = chilkat2.JsonObject()
jResp.LoadSb(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

nextToken = jResp.StringOf("nextToken")
i = 0
count_i = jResp.SizeOfArray("errors")
while i < count_i :
    jResp.I = i
    code = jResp.StringOf("errors[i].code")
    identifier = jResp.StringOf("errors[i].identifier")
    message = jResp.StringOf("errors[i].message")
    i = i + 1

i = 0
count_i = jResp.SizeOfArray("volumeRecommendations")
while i < count_i :
    jResp.I = i
    accountId = jResp.StringOf("volumeRecommendations[i].accountId")
    VolumeBaselineIOPS = jResp.IntOf("volumeRecommendations[i].currentConfiguration.volumeBaselineIOPS")
    VolumeBaselineThroughput = jResp.IntOf("volumeRecommendations[i].currentConfiguration.volumeBaselineThroughput")
    VolumeBurstIOPS = jResp.IntOf("volumeRecommendations[i].currentConfiguration.volumeBurstIOPS")
    VolumeBurstThroughput = jResp.IntOf("volumeRecommendations[i].currentConfiguration.volumeBurstThroughput")
    VolumeSize = jResp.IntOf("volumeRecommendations[i].currentConfiguration.volumeSize")
    VolumeType = jResp.StringOf("volumeRecommendations[i].currentConfiguration.volumeType")
    currentPerformanceRisk = jResp.StringOf("volumeRecommendations[i].currentPerformanceRisk")
    finding = jResp.StringOf("volumeRecommendations[i].finding")
    lastRefreshTimestamp = jResp.IntOf("volumeRecommendations[i].lastRefreshTimestamp")
    lookBackPeriodInDays = jResp.IntOf("volumeRecommendations[i].lookBackPeriodInDays")
    volumeArn = jResp.StringOf("volumeRecommendations[i].volumeArn")
    j = 0
    count_j = jResp.SizeOfArray("volumeRecommendations[i].utilizationMetrics")
    while j < count_j :
        jResp.J = j
        name = jResp.StringOf("volumeRecommendations[i].utilizationMetrics[j].name")
        statistic = jResp.StringOf("volumeRecommendations[i].utilizationMetrics[j].statistic")
        value = jResp.IntOf("volumeRecommendations[i].utilizationMetrics[j].value")
        j = j + 1

    j = 0
    count_j = jResp.SizeOfArray("volumeRecommendations[i].volumeRecommendationOptions")
    while j < count_j :
        jResp.J = j
        configurationVolumeBaselineIOPS = jResp.IntOf("volumeRecommendations[i].volumeRecommendationOptions[j].configuration.volumeBaselineIOPS")
        configurationVolumeBaselineThroughput = jResp.IntOf("volumeRecommendations[i].volumeRecommendationOptions[j].configuration.volumeBaselineThroughput")
        configurationVolumeBurstIOPS = jResp.IntOf("volumeRecommendations[i].volumeRecommendationOptions[j].configuration.volumeBurstIOPS")
        configurationVolumeBurstThroughput = jResp.IntOf("volumeRecommendations[i].volumeRecommendationOptions[j].configuration.volumeBurstThroughput")
        configurationVolumeSize = jResp.IntOf("volumeRecommendations[i].volumeRecommendationOptions[j].configuration.volumeSize")
        configurationVolumeType = jResp.StringOf("volumeRecommendations[i].volumeRecommendationOptions[j].configuration.volumeType")
        performanceRisk = jResp.IntOf("volumeRecommendations[i].volumeRecommendationOptions[j].performanceRisk")
        rank = jResp.IntOf("volumeRecommendations[i].volumeRecommendationOptions[j].rank")
        v_Currency = jResp.StringOf("volumeRecommendations[i].volumeRecommendationOptions[j].savingsOpportunity.estimatedMonthlySavings.currency")
        Value = jResp.IntOf("volumeRecommendations[i].volumeRecommendationOptions[j].savingsOpportunity.estimatedMonthlySavings.value")
        SavingsOpportunityPercentage = jResp.IntOf("volumeRecommendations[i].volumeRecommendationOptions[j].savingsOpportunity.savingsOpportunityPercentage")
        j = j + 1

    i = i + 1

# 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
#           }
#         }
#       ]
#     }
#   ]
# }
Chilkat Online Tools

GetEBSVolumeRecommendations Python Example

AWS Compute Optimizer
