AWS Cost Explorer Service
Cost Management APIs

GetReservationPurchaseRecommendation

Gets recommendations for which reservations to purchase. These recommendations could help you reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.

AWS generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage into categories that are eligible for a reservation. After AWS has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of RI to purchase to maximize your estimated savings.

For example, AWS automatically aggregates your EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region and recommends that you buy size-flexible regional reservations to apply to the c4 family usage. AWS recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible RI. AWS also shows the equal number of normalized units so that you can purchase any instance size that you want. For this example, your RI recommendation would be for c4.large, because that is the smallest size instance in the c4 instance family.

Request Syntax

{ "AccountId": "string", "AccountScope": "string", "LookbackPeriodInDays": "string", "NextPageToken": "string", "PageSize": number, "PaymentOption": "string", "Service": "string", "ServiceSpecification": { "EC2Specification": { "OfferingClass": "string" } }, "TermInYears": "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.

AccountId

The account ID that is associated with the recommendation.

Type: String

Required: No

AccountScope

The account scope that you want recommendations for. PAYER means that AWS includes the master account and any member accounts when it calculates its recommendations. LINKED means that AWS includes only member accounts when it calculates its recommendations.

Valid values are PAYER and LINKED.

Type: String

Valid Values: PAYER | LINKED

Required: No

LookbackPeriodInDays

The number of previous days that you want AWS to consider when it calculates your recommendations.

Type: String

Valid Values: SEVEN_DAYS | THIRTY_DAYS | SIXTY_DAYS

Required: No

NextPageToken

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

Type: String

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

PaymentOption

The reservation purchase option that you want recommendations for.

Type: String

Valid Values: NO_UPFRONT | PARTIAL_UPFRONT | ALL_UPFRONT | LIGHT_UTILIZATION | MEDIUM_UTILIZATION | HEAVY_UTILIZATION

Required: No

Service

The specific service that you want recommendations for.

Type: String

Required: Yes

ServiceSpecification

The hardware specifications for the service instances that you want recommendations for, such as standard or convertible EC2 instances.

Type: ServiceSpecification object

Required: No

TermInYears

The reservation term that you want recommendations for.

Type: String

Valid Values: ONE_YEAR | THREE_YEARS

Required: No

Response Syntax

{ "Metadata": { "GenerationTimestamp": "string", "RecommendationId": "string" }, "NextPageToken": "string", "Recommendations": [ { "AccountScope": "string", "LookbackPeriodInDays": "string", "PaymentOption": "string", "RecommendationDetails": [ { "AverageNormalizedUnitsUsedPerHour": "string", "AverageNumberOfInstancesUsedPerHour": "string", "AverageUtilization": "string", "CurrencyCode": "string", "EstimatedBreakEvenInMonths": "string", "EstimatedMonthlyOnDemandCost": "string", "EstimatedMonthlySavingsAmount": "string", "EstimatedMonthlySavingsPercentage": "string", "EstimatedReservationCostForLookbackPeriod": "string", "InstanceDetails": { "EC2InstanceDetails": { "AvailabilityZone": "string", "CurrentGeneration": boolean, "Family": "string", "InstanceType": "string", "Platform": "string", "Region": "string", "SizeFlexEligible": boolean, "Tenancy": "string" }, "ElastiCacheInstanceDetails": { "CurrentGeneration": boolean, "Family": "string", "NodeType": "string", "ProductDescription": "string", "Region": "string", "SizeFlexEligible": boolean }, "ESInstanceDetails": { "CurrentGeneration": boolean, "InstanceClass": "string", "InstanceSize": "string", "Region": "string", "SizeFlexEligible": boolean }, "RDSInstanceDetails": { "CurrentGeneration": boolean, "DatabaseEdition": "string", "DatabaseEngine": "string", "DeploymentOption": "string", "Family": "string", "InstanceType": "string", "LicenseModel": "string", "Region": "string", "SizeFlexEligible": boolean }, "RedshiftInstanceDetails": { "CurrentGeneration": boolean, "Family": "string", "NodeType": "string", "Region": "string", "SizeFlexEligible": boolean } }, "MaximumNormalizedUnitsUsedPerHour": "string", "MaximumNumberOfInstancesUsedPerHour": "string", "MinimumNormalizedUnitsUsedPerHour": "string", "MinimumNumberOfInstancesUsedPerHour": "string", "RecommendedNormalizedUnitsToPurchase": "string", "RecommendedNumberOfInstancesToPurchase": "string", "RecurringStandardMonthlyCost": "string", "UpfrontCost": "string" } ], "RecommendationSummary": { "CurrencyCode": "string", "TotalEstimatedMonthlySavingsAmount": "string", "TotalEstimatedMonthlySavingsPercentage": "string" }, "ServiceSpecification": { "EC2Specification": { "OfferingClass": "string" } }, "TermInYears": "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.

Metadata

Information about this specific recommendation call, such as the time stamp for when Cost Explorer generated this recommendation.

Type: ReservationPurchaseRecommendationMetadata object

NextPageToken

The pagination token for the next set of retrievable results.

Type: String

Recommendations

Recommendations for reservations to purchase.

Type: Array of ReservationPurchaseRecommendation objects

Errors

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

DataUnavailableException

The requested data is unavailable.

HTTP Status Code: 400

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: