GetRightsizingRecommendation - AWS Billing and Cost Management

GetRightsizingRecommendation

Creates recommendations that help you save cost by identifying idle and underutilized Amazon EC2 instances.

Recommendations are generated to either downsize or terminate instances, along with providing savings detail and metrics. For more information about calculation and function, see Optimizing Your Cost with Rightsizing Recommendations in the AWS Billing and Cost Management User Guide.

Request Syntax

{ "Configuration": { "BenefitsConsidered": boolean, "RecommendationTarget": "string" }, "Filter": { "And": [ "Expression" ], "CostCategories": { "Key": "string", "MatchOptions": [ "string" ], "Values": [ "string" ] }, "Dimensions": { "Key": "string", "MatchOptions": [ "string" ], "Values": [ "string" ] }, "Not": "Expression", "Or": [ "Expression" ], "Tags": { "Key": "string", "MatchOptions": [ "string" ], "Values": [ "string" ] } }, "NextPageToken": "string", "PageSize": number, "Service": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Configuration

You can use Configuration to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings that are associated with recommendations with consideration of existing Savings Plans or RI benefits, or neither.

Type: RightsizingRecommendationConfiguration object

Required: No

Filter

Use Expression to filter in various Cost Explorer APIs.

Not all Expression types are supported in each API. Refer to the documentation for each specific API to see what is supported.

There are two patterns:

  • Simple dimension values.

    • There are three types of simple dimension values: CostCategories, Tags, and Dimensions.

      • Specify the CostCategories field to define a filter that acts on Cost Categories.

      • Specify the Tags field to define a filter that acts on Cost Allocation Tags.

      • Specify the Dimensions field to define a filter that acts on the DimensionValues.

    • For each filter type, you can set the dimension name and values for the filters that you plan to use.

      • For example, you can filter for REGION==us-east-1 OR REGION==us-west-1. For GetRightsizingRecommendation, the Region is a full name (for example, REGION==US East (N. Virginia).

      • The corresponding Expression for this example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } }

      • As shown in the previous example, lists of dimension values are combined with OR when applying the filter.

    • You can also set different match options to further control how the filter behaves. Not all APIs support match options. Refer to the documentation for each specific API to see what is supported.

      • For example, you can filter for linked account names that start with “a”.

      • The corresponding Expression for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } }

  • Compound Expression types with logical operations.

    • You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. By doing this, you can filter by more advanced options.

    • For example, you can filter by ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer).

    • The corresponding Expression for this example is as follows: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] }

    Note

    Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error: { "And": [ ... ], "Dimensions": { "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

    The following is an example of the corresponding error message: "Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories"

Note

For the GetRightsizingRecommendation action, a combination of OR and NOT isn't supported. OR isn't supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE.

For the GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR aren't supported. Dimensions are limited to LINKED_ACCOUNT.

Type: Expression object

Required: No

NextPageToken

The pagination token that indicates the next set of results that you want to retrieve.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: [\S\s]*

Required: No

PageSize

The number of recommendations that you want returned in a single response object.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

Service

The specific service that you want recommendations for. The only valid value for GetRightsizingRecommendation is "AmazonEC2".

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: [\S\s]*

Required: Yes

Response Syntax

{ "Configuration": { "BenefitsConsidered": boolean, "RecommendationTarget": "string" }, "Metadata": { "AdditionalMetadata": "string", "GenerationTimestamp": "string", "LookbackPeriodInDays": "string", "RecommendationId": "string" }, "NextPageToken": "string", "RightsizingRecommendations": [ { "AccountId": "string", "CurrentInstance": { "CurrencyCode": "string", "InstanceName": "string", "MonthlyCost": "string", "OnDemandHoursInLookbackPeriod": "string", "ReservationCoveredHoursInLookbackPeriod": "string", "ResourceDetails": { "EC2ResourceDetails": { "HourlyOnDemandRate": "string", "InstanceType": "string", "Memory": "string", "NetworkPerformance": "string", "Platform": "string", "Region": "string", "Sku": "string", "Storage": "string", "Vcpu": "string" } }, "ResourceId": "string", "ResourceUtilization": { "EC2ResourceUtilization": { "DiskResourceUtilization": { "DiskReadBytesPerSecond": "string", "DiskReadOpsPerSecond": "string", "DiskWriteBytesPerSecond": "string", "DiskWriteOpsPerSecond": "string" }, "EBSResourceUtilization": { "EbsReadBytesPerSecond": "string", "EbsReadOpsPerSecond": "string", "EbsWriteBytesPerSecond": "string", "EbsWriteOpsPerSecond": "string" }, "MaxCpuUtilizationPercentage": "string", "MaxMemoryUtilizationPercentage": "string", "MaxStorageUtilizationPercentage": "string", "NetworkResourceUtilization": { "NetworkInBytesPerSecond": "string", "NetworkOutBytesPerSecond": "string", "NetworkPacketsInPerSecond": "string", "NetworkPacketsOutPerSecond": "string" } } }, "SavingsPlansCoveredHoursInLookbackPeriod": "string", "Tags": [ { "Key": "string", "MatchOptions": [ "string" ], "Values": [ "string" ] } ], "TotalRunningHoursInLookbackPeriod": "string" }, "FindingReasonCodes": [ "string" ], "ModifyRecommendationDetail": { "TargetInstances": [ { "CurrencyCode": "string", "DefaultTargetInstance": boolean, "EstimatedMonthlyCost": "string", "EstimatedMonthlySavings": "string", "ExpectedResourceUtilization": { "EC2ResourceUtilization": { "DiskResourceUtilization": { "DiskReadBytesPerSecond": "string", "DiskReadOpsPerSecond": "string", "DiskWriteBytesPerSecond": "string", "DiskWriteOpsPerSecond": "string" }, "EBSResourceUtilization": { "EbsReadBytesPerSecond": "string", "EbsReadOpsPerSecond": "string", "EbsWriteBytesPerSecond": "string", "EbsWriteOpsPerSecond": "string" }, "MaxCpuUtilizationPercentage": "string", "MaxMemoryUtilizationPercentage": "string", "MaxStorageUtilizationPercentage": "string", "NetworkResourceUtilization": { "NetworkInBytesPerSecond": "string", "NetworkOutBytesPerSecond": "string", "NetworkPacketsInPerSecond": "string", "NetworkPacketsOutPerSecond": "string" } } }, "PlatformDifferences": [ "string" ], "ResourceDetails": { "EC2ResourceDetails": { "HourlyOnDemandRate": "string", "InstanceType": "string", "Memory": "string", "NetworkPerformance": "string", "Platform": "string", "Region": "string", "Sku": "string", "Storage": "string", "Vcpu": "string" } } } ] }, "RightsizingType": "string", "TerminateRecommendationDetail": { "CurrencyCode": "string", "EstimatedMonthlySavings": "string" } } ], "Summary": { "EstimatedTotalMonthlySavingsAmount": "string", "SavingsCurrencyCode": "string", "SavingsPercentage": "string", "TotalRecommendationCount": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Configuration

You can use Configuration to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings that are associated with recommendations with consideration of existing Savings Plans or RI benefits, or neither.

Type: RightsizingRecommendationConfiguration object

Metadata

Information regarding this specific recommendation set.

Type: RightsizingRecommendationMetadata object

NextPageToken

The token to retrieve the next set of results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: [\S\s]*

RightsizingRecommendations

Recommendations to rightsize resources.

Type: Array of RightsizingRecommendation objects

Summary

Summary of this recommendation set.

Type: RightsizingRecommendationSummary object

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidNextTokenException

The pagination token is invalid. Try again without a pagination token.

HTTP Status Code: 400

LimitExceededException

You made too many calls in a short period of time. Try again later.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: