Start Commitment Purchase Analysis

costexplorer_start_commitment_purchase_analysis

R Documentation

Specifies the parameters of a planned commitment purchase and starts the generation of the analysis¶

Description¶

Specifies the parameters of a planned commitment purchase and starts the generation of the analysis. This enables you to estimate the cost, coverage, and utilization impact of your planned commitment purchases.

Usage¶

costexplorer_start_commitment_purchase_analysis(
  CommitmentPurchaseAnalysisConfiguration)

Arguments¶

CommitmentPurchaseAnalysisConfiguration: [required] The configuration for the commitment purchase analysis.

Value¶

A list with the following syntax:

list(
  AnalysisId = "string",
  AnalysisStartedTime = "string",
  EstimatedCompletionTime = "string"
)

Request syntax¶

svc$start_commitment_purchase_analysis(
  CommitmentPurchaseAnalysisConfiguration = list(
    SavingsPlansPurchaseAnalysisConfiguration = list(
      AccountScope = "PAYER"|"LINKED",
      AccountId = "string",
      AnalysisType = "MAX_SAVINGS"|"CUSTOM_COMMITMENT",
      SavingsPlansToAdd = list(
        list(
          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 = list(
        "string"
      ),
      LookBackTimePeriod = list(
        Start = "string",
        End = "string"
      )
    )
  )
)