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-commitment-purchase-analysis

Description

Retrieves a commitment purchase analysis result based on the AnalysisId .

See also: AWS API Documentation

Synopsis

  get-commitment-purchase-analysis
--analysis-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

--analysis-id (string)

The analysis ID that's associated with the commitment purchase analysis.

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

EstimatedCompletionTime -> (string)

The estimated time for when the analysis will complete.

AnalysisCompletionTime -> (string)

The completion time of the analysis.

AnalysisStartedTime -> (string)

The start time of the analysis.

AnalysisId -> (string)

The analysis ID that's associated with the commitment purchase analysis.

AnalysisStatus -> (string)

The status of the analysis.

ErrorCode -> (string)

The error code used for the analysis.

AnalysisDetails -> (structure)

Details about the analysis.

SavingsPlansPurchaseAnalysisDetails -> (structure)

Details about the Savings Plans purchase analysis.

CurrencyCode -> (string)

The currency code used for the analysis.

LookbackPeriodInHours -> (string)

The lookback period in hours that's used to generate the analysis.

CurrentAverageCoverage -> (string)

The average value of hourly coverage over the lookback period.

CurrentAverageHourlyOnDemandSpend -> (string)

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

CurrentMaximumHourlyOnDemandSpend -> (string)

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

CurrentMinimumHourlyOnDemandSpend -> (string)

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

CurrentOnDemandSpend -> (string)

The current total On-Demand spend over the lookback period.

ExistingHourlyCommitment -> (string)

The existing hourly commitment for the Savings Plan type.

HourlyCommitmentToPurchase -> (string)

The recommended or custom hourly commitment.

EstimatedAverageCoverage -> (string)

The estimated coverage of the Savings Plan.

EstimatedAverageUtilization -> (string)

The estimated utilization of the Savings Plan.

EstimatedMonthlySavingsAmount -> (string)

The estimated monthly savings amount based on the Savings Plan.

EstimatedOnDemandCost -> (string)

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

EstimatedOnDemandCostWithCurrentCommitment -> (string)

The estimated On-Demand cost 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 Savings Plan and estimated savings. This is calculated as estimatedSavingsAmount/estimatedSPCost*100.

EstimatedSavingsAmount -> (string)

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

EstimatedSavingsPercentage -> (string)

The estimated savings percentage relative to the total cost over the cost calculation lookback period.

EstimatedCommitmentCost -> (string)

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

LatestUsageTimestamp -> (string)

The date and time of the last hour that went into the analysis.

UpfrontCost -> (string)

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

AdditionalMetadata -> (string)

Additional metadata that might be applicable to the commitment.

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.

CommitmentPurchaseAnalysisConfiguration -> (structure)

The configuration for the commitment purchase analysis.

SavingsPlansPurchaseAnalysisConfiguration -> (structure)

The configuration for the Savings Plans purchase analysis.

AccountScope -> (string)

The account scope that you want your analysis for.

AccountId -> (string)

The account that the analysis is for.

AnalysisType -> (string)

The type of analysis.

SavingsPlansToAdd -> (list)

Savings Plans to include in the analysis.

(structure)

The Savings Plans commitment details.

PaymentOption -> (string)

The payment option for the Savings Plans commitment.

SavingsPlansType -> (string)

The Savings Plans type.

Region -> (string)

The Region associated with the Savings Plans commitment.

InstanceFamily -> (string)

The instance family of the Savings Plans commitment.

TermInYears -> (string)

The term that you want the Savings Plans commitment for.

SavingsPlansCommitment -> (double)

The Savings Plans commitment.

OfferingId -> (string)

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

SavingsPlansToExclude -> (list)

Savings Plans to exclude from the analysis.

(string)

LookBackTimePeriod -> (structure)

The time period associated with the analysis.

Start -> (string)

The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01 , Amazon Web Services retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.

End -> (string)

The end of the time period. The end date is exclusive. For example, if end is 2017-05-01 , Amazon Web Services retrieves cost and usage data from the start date up to, but not including, 2017-05-01 .