CostExplorer / Client / list_commitment_purchase_analyses

list_commitment_purchase_analyses#

CostExplorer.Client.list_commitment_purchase_analyses(**kwargs)#

Lists the commitment purchase analyses for your account.

See also: AWS API Documentation

Request Syntax

response = client.list_commitment_purchase_analyses(
    AnalysisStatus='SUCCEEDED'|'PROCESSING'|'FAILED',
    NextPageToken='string',
    PageSize=123,
    AnalysisIds=[
        'string',
    ]
)
Parameters:

  • AnalysisStatus (string) – The status of the analysis.

  • NextPageToken (string) – The token to retrieve the next set of results.

  • PageSize (integer) – The number of analyses that you want returned in a single response object.

  • AnalysisIds (list) –

    The analysis IDs associated with the commitment purchase analyses.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'AnalysisSummaryList': [
        {
            'EstimatedCompletionTime': 'string',
            'AnalysisCompletionTime': 'string',
            'AnalysisStartedTime': 'string',
            'AnalysisStatus': 'SUCCEEDED'|'PROCESSING'|'FAILED',
            'ErrorCode': 'NO_USAGE_FOUND'|'INTERNAL_FAILURE'|'INVALID_SAVINGS_PLANS_TO_ADD'|'INVALID_SAVINGS_PLANS_TO_EXCLUDE'|'INVALID_ACCOUNT_ID',
            'AnalysisId': 'string',
            'CommitmentPurchaseAnalysisConfiguration': {
                'SavingsPlansPurchaseAnalysisConfiguration': {
                    'AccountScope': 'PAYER'|'LINKED',
                    'AccountId': 'string',
                    'AnalysisType': 'MAX_SAVINGS'|'CUSTOM_COMMITMENT',
                    'SavingsPlansToAdd': [
                        {
                            'PaymentOption': 'NO_UPFRONT'|'PARTIAL_UPFRONT'|'ALL_UPFRONT'|'LIGHT_UTILIZATION'|'MEDIUM_UTILIZATION'|'HEAVY_UTILIZATION',
                            'SavingsPlansType': 'COMPUTE_SP'|'EC2_INSTANCE_SP'|'SAGEMAKER_SP',
                            'Region': 'string',
                            'InstanceFamily': 'string',
                            'TermInYears': 'ONE_YEAR'|'THREE_YEARS',
                            'SavingsPlansCommitment': 123.0,
                            'OfferingId': 'string'
                        },
                    ],
                    'SavingsPlansToExclude': [
                        'string',
                    ],
                    'LookBackTimePeriod': {
                        'Start': 'string',
                        'End': 'string'
                    }
                }
            }
        },
    ],
    'NextPageToken': 'string'
}

Response Structure

  • (dict) –

    • AnalysisSummaryList (list) –

      The list of analyses.

      • (dict) –

        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 (dict) –

          The configuration for the commitment purchase analysis.

          • SavingsPlansPurchaseAnalysisConfiguration (dict) –

            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.

              • (dict) –

                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 (float) –

                  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 (dict) –

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

      The token to retrieve the next set of results.

Exceptions