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 ]

list-commitment-purchase-analyses¶

Description¶

Lists the commitment purchase analyses for your account.

Synopsis¶

  list-commitment-purchase-analyses
[--analysis-status <value>]
[--next-page-token <value>]
[--page-size <value>]
[--analysis-ids <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-status (string)

The status of the analysis.

Possible values:

SUCCEEDED

PROCESSING

FAILED

--next-page-token (string)

The token to retrieve the next set of results.

--page-size (integer)

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

--analysis-ids (list)

The analysis IDs associated with the commitment purchase analyses.

(string)

Syntax:

"string" "string" ...

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

AnalysisSummaryList -> (list)

The list of analyses.

(structure)

A summary of the analysis.

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.

AnalysisStatus -> (string)

The status of the analysis.

ErrorCode -> (string)

The error code used for the analysis.

AnalysisId -> (string)

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

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 .

NextPageToken -> (string)