List Commitment Purchase Analyses

costexplorer_list_commitment_purchase_analyses

R Documentation

Lists the commitment purchase analyses for your account

Description

Lists the commitment purchase analyses for your account.

Usage

costexplorer_list_commitment_purchase_analyses(AnalysisStatus,
  NextPageToken, PageSize, AnalysisIds)

Arguments

AnalysisStatus

The status of the analysis.

NextPageToken

The token to retrieve the next set of results.

PageSize

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

AnalysisIds

The analysis IDs associated with the commitment purchase analyses.

Value

A list with the following syntax:

list(
  AnalysisSummaryList = list(
    list(
      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 = 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"
          )
        )
      )
    )
  ),
  NextPageToken = "string"
)

Request syntax

svc$list_commitment_purchase_analyses(
  AnalysisStatus = "SUCCEEDED"|"PROCESSING"|"FAILED",
  NextPageToken = "string",
  PageSize = 123,
  AnalysisIds = list(
    "string"
  )
)