AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ce ]

get-savings-plan-purchase-recommendation-details

Description

Retrieves the details for a Savings Plan recommendation. These details include the hourly data-points that construct the cost, coverage, and utilization charts.

See also: AWS API Documentation

Synopsis

  get-savings-plan-purchase-recommendation-details
--recommendation-detail-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--recommendation-detail-id (string)

The ID that is associated with the Savings Plan recommendation.

--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. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--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.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

RecommendationDetailId -> (string)

The ID that is associated with the Savings Plan recommendation.

RecommendationDetailData -> (structure)

Contains detailed information about a specific Savings Plan recommendation.

AccountScope -> (string)

The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only.

LookbackPeriodInDays -> (string)

How many days of previous usage that Amazon Web Services considers when making this recommendation.

SavingsPlansType -> (string)

The requested Savings Plan recommendation type.

TermInYears -> (string)

The term of the commitment in years.

PaymentOption -> (string)

The payment option for the commitment (for example, All Upfront or No Upfront).

AccountId -> (string)

The AccountID that the recommendation is generated for.

CurrencyCode -> (string)

The currency code that Amazon Web Services used to generate the recommendation and present potential savings.

InstanceFamily -> (string)

The instance family of the recommended Savings Plan.

Region -> (string)

The region the recommendation is generated for.

OfferingId -> (string)

The unique ID that's used to distinguish Savings Plans from one another.

GenerationTimestamp -> (string)

The period of time that you want the usage and costs for.

LatestUsageTimestamp -> (string)

The period of time that you want the usage and costs for.

CurrentAverageHourlyOnDemandSpend -> (string)

The average value of hourly On-Demand spend over the lookback period of the applicable usage type.

CurrentMaximumHourlyOnDemandSpend -> (string)

The highest value of hourly On-Demand spend over the lookback period of the applicable usage type.

CurrentMinimumHourlyOnDemandSpend -> (string)

The lowest value of hourly On-Demand spend over the lookback period of the applicable usage type.

EstimatedAverageUtilization -> (string)

The estimated utilization of the recommended Savings Plan.

EstimatedMonthlySavingsAmount -> (string)

The estimated monthly savings amount based on the recommended Savings Plan.

EstimatedOnDemandCost -> (string)

The remaining On-Demand cost estimated to not be covered by the recommended Savings Plan, over the length of the lookback period.

EstimatedOnDemandCostWithCurrentCommitment -> (string)

The estimated On-Demand costs you expect with no additional commitment, based on your usage of the selected time period and the Savings Plan you own.

EstimatedROI -> (string)

The estimated return on investment that's based on the recommended Savings Plan that you purchased. This is calculated as estimatedSavingsAmount/estimatedSPCost*100.

EstimatedSPCost -> (string)

The cost of the recommended Savings Plan over the length of the lookback period.

EstimatedSavingsAmount -> (string)

The estimated savings amount that's based on the recommended Savings Plan over the length of the lookback period.

EstimatedSavingsPercentage -> (string)

The estimated savings percentage relative to the total cost of applicable On-Demand usage over the lookback period.

ExistingHourlyCommitment -> (string)

The existing hourly commitment for the Savings Plan type.

HourlyCommitmentToPurchase -> (string)

The recommended hourly commitment level for the Savings Plan type and the configuration that's based on the usage during the lookback period.

UpfrontCost -> (string)

The upfront cost of the recommended Savings Plan, based on the selected payment option.

CurrentAverageCoverage -> (string)

The average value of hourly coverage over the lookback period.

EstimatedAverageCoverage -> (string)

The estimated coverage of the recommended Savings Plan.

MetricsOverLookbackPeriod -> (list)

The related hourly cost, coverage, and utilization metrics over the lookback period.

(structure)

Contains the hourly metrics for the given recommendation over the lookback period.

StartTime -> (string)

The period of time that you want the usage and costs for.

EstimatedOnDemandCost -> (string)

The remaining On-Demand cost estimated to not be covered by the recommended Savings Plan, over the length of the lookback period.

CurrentCoverage -> (string)

The current amount of Savings Plans eligible usage that the Savings Plan covered.

EstimatedCoverage -> (string)

The estimated coverage amount based on the recommended Savings Plan.

EstimatedNewCommitmentUtilization -> (string)

The estimated utilization for the recommended Savings Plan.