Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . ce ]

get-reservation-purchase-recommendation

Description

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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-reservation-purchase-recommendation
[--account-id <value>]
--service <value>
[--account-scope <value>]
[--lookback-period-in-days <value>]
[--term-in-years <value>]
[--payment-option <value>]
[--service-specification <value>]
[--page-size <value>]
[--next-page-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--account-id (string)

The account ID that is associated with the recommendation.

--service (string)

The specific service that you want recommendations for.

--account-scope (string)

The account scope that you want recommendations for. The only valid value is Payer . This means that AWS includes the master account and any member accounts when it calculates its recommendations.

Possible values:

  • PAYER

--lookback-period-in-days (string)

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

Possible values:

  • SEVEN_DAYS
  • THIRTY_DAYS
  • SIXTY_DAYS

--term-in-years (string)

The reservation term that you want recommendations for.

Possible values:

  • ONE_YEAR
  • THREE_YEARS

--payment-option (string)

The reservation purchase option that you want recommendations for.

Possible values:

  • NO_UPFRONT
  • PARTIAL_UPFRONT
  • ALL_UPFRONT

--service-specification (structure)

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

Shorthand Syntax:

EC2Specification={OfferingClass=string}

JSON Syntax:

{
  "EC2Specification": {
    "OfferingClass": "STANDARD"|"CONVERTIBLE"
  }
}

--page-size (integer)

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

--next-page-token (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Metadata -> (structure)

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

RecommendationId -> (string)

The ID for this specific recommendation.

GenerationTimestamp -> (string)

The time stamp for when AWS made this recommendation.

Recommendations -> (list)

Recommendations for reservations to purchase.

(structure)

A specific reservation that AWS recommends for purchase.

AccountScope -> (string)

The account scope that AWS recommends that you purchase this instance for. For example, you can purchase this reservation for an entire organization in AWS Organizations.

LookbackPeriodInDays -> (string)

How many days of previous usage that AWS takes into consideration when making this recommendation.

TermInYears -> (string)

The term of the reservation that you want recommendations for, in years.

PaymentOption -> (string)

The payment option for the reservation. For example, AllUpfront or NoUpfront .

ServiceSpecification -> (structure)

Hardware specifications for the service that you want recommendations for.

EC2Specification -> (structure)

The EC2 hardware specifications that you want AWS to provide recommendations for.

OfferingClass -> (string)

Whether you want a recommendation for standard or convertible reservations.

RecommendationDetails -> (list)

Details about the recommended purchases.

(structure)

Details about your recommended reservation purchase.

InstanceDetails -> (structure)

Details about the instances that AWS recommends that you purchase.

EC2InstanceDetails -> (structure)

The EC2 instances that AWS recommends that you purchase.

Family -> (string)

The instance family of the recommended reservation.

InstanceType -> (string)

The type of instance that AWS recommends.

Region -> (string)

The AWS Region of the recommended reservation.

AvailabilityZone -> (string)

The Availability Zone of the recommended reservation.

Platform -> (string)

The platform of the recommended reservation. The platform is the specific combination of operating system, license model, and software on an instance.

Tenancy -> (string)

Whether the recommended reservation is dedicated or shared.

CurrentGeneration -> (boolean)

Whether the recommendation is for a current generation instance.

SizeFlexEligible -> (boolean)

Whether the recommended reservation is size flexible.

RDSInstanceDetails -> (structure)

The RDS instances that AWS recommends that you purchase.

Family -> (string)

The instance family of the recommended reservation.

InstanceType -> (string)

The type of instance that AWS recommends.

Region -> (string)

The AWS Region of the recommended reservation.

DatabaseEngine -> (string)

The database engine that the recommended reservation supports.

DeploymentOption -> (string)

Whether the recommendation is for a reservation in a single availability zone or a reservation with a backup in a second availability zone.

LicenseModel -> (string)

The license model that the recommended reservation supports.

CurrentGeneration -> (boolean)

Whether the recommendation is for a current generation instance.

SizeFlexEligible -> (boolean)

Whether the recommended reservation is size flexible.

RecommendedNumberOfInstancesToPurchase -> (string)

The number of instances that AWS recommends that you purchase.

RecommendedNormalizedUnitsToPurchase -> (string)

The number of normalized units that AWS recommends that you purchase.

MinimumNumberOfInstancesUsedPerHour -> (string)

The minimum number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.

MinimumNormalizedUnitsUsedPerHour -> (string)

The minimum number of hours that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.

MaximumNumberOfInstancesUsedPerHour -> (string)

The maximum number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.

MaximumNormalizedUnitsUsedPerHour -> (string)

The maximum number of normalized units that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.

AverageNumberOfInstancesUsedPerHour -> (string)

The average number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.

AverageNormalizedUnitsUsedPerHour -> (string)

The average number of normalized units that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.

AverageUtilization -> (string)

The average utilization of your instances. AWS uses this to calculate your recommended reservation purchases.

EstimatedBreakEvenInMonths -> (string)

How long AWS estimates that it takes for this instance to start saving you money, in months.

CurrencyCode -> (string)

The currency code that AWS used to calculate the costs for this instance.

EstimatedMonthlySavingsAmount -> (string)

How much AWS estimates that this specific recommendation could save you in a month.

EstimatedMonthlySavingsPercentage -> (string)

How much AWS estimates that this specific recommendation could save you in a month, as a percentage of your overall costs.

EstimatedMonthlyOnDemandCost -> (string)

How much AWS estimates that you spend on On-Demand Instances in a month.

EstimatedReservationCostForLookbackPeriod -> (string)

How much AWS estimates that you would have spent for all usage during the specified historical period if you had had a reservation.

UpfrontCost -> (string)

How much purchasing this instance costs you upfront.

RecurringStandardMonthlyCost -> (string)

How much purchasing this instance costs you on a monthly basis.

RecommendationSummary -> (structure)

A summary about the recommended purchase.

TotalEstimatedMonthlySavingsAmount -> (string)

The total amount that AWS estimates that this recommendation could save you in a month.

TotalEstimatedMonthlySavingsPercentage -> (string)

The total amount that AWS estimates that this recommendation could save you in a month, as a percentage of your costs.

CurrencyCode -> (string)

The currency code used for this recommendation.

NextPageToken -> (string)

The pagination token for the next set of retrievable results.