Get Commitment Purchase Analysis

costexplorer_get_commitment_purchase_analysis

R Documentation

Retrieves a commitment purchase analysis result based on the AnalysisId

Description

Retrieves a commitment purchase analysis result based on the AnalysisId.

Usage

costexplorer_get_commitment_purchase_analysis(AnalysisId)

Arguments

AnalysisId

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

Value

A list with the following syntax:

list(
  EstimatedCompletionTime = "string",
  AnalysisCompletionTime = "string",
  AnalysisStartedTime = "string",
  AnalysisId = "string",
  AnalysisStatus = "SUCCEEDED"|"PROCESSING"|"FAILED",
  ErrorCode = "NO_USAGE_FOUND"|"INTERNAL_FAILURE"|"INVALID_SAVINGS_PLANS_TO_ADD"|"INVALID_SAVINGS_PLANS_TO_EXCLUDE"|"INVALID_ACCOUNT_ID",
  AnalysisDetails = list(
    SavingsPlansPurchaseAnalysisDetails = list(
      CurrencyCode = "string",
      LookbackPeriodInHours = "string",
      CurrentAverageCoverage = "string",
      CurrentAverageHourlyOnDemandSpend = "string",
      CurrentMaximumHourlyOnDemandSpend = "string",
      CurrentMinimumHourlyOnDemandSpend = "string",
      CurrentOnDemandSpend = "string",
      ExistingHourlyCommitment = "string",
      HourlyCommitmentToPurchase = "string",
      EstimatedAverageCoverage = "string",
      EstimatedAverageUtilization = "string",
      EstimatedMonthlySavingsAmount = "string",
      EstimatedOnDemandCost = "string",
      EstimatedOnDemandCostWithCurrentCommitment = "string",
      EstimatedROI = "string",
      EstimatedSavingsAmount = "string",
      EstimatedSavingsPercentage = "string",
      EstimatedCommitmentCost = "string",
      LatestUsageTimestamp = "string",
      UpfrontCost = "string",
      AdditionalMetadata = "string",
      MetricsOverLookbackPeriod = list(
        list(
          StartTime = "string",
          EstimatedOnDemandCost = "string",
          CurrentCoverage = "string",
          EstimatedCoverage = "string",
          EstimatedNewCommitmentUtilization = "string"
        )
      )
    )
  ),
  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"
      )
    )
  )
)

Request syntax

svc$get_commitment_purchase_analysis(
  AnalysisId = "string"
)