Get Savings Plans Purchase Recommendation

costexplorer_get_savings_plans_purchase_recommendation

R Documentation

Retrieves the Savings Plans recommendations for your account

Description

Retrieves the Savings Plans recommendations for your account. First use start_savings_plans_purchase_recommendation_generation to generate a new set of recommendations, and then use get_savings_plans_purchase_recommendation to retrieve them.

Usage

costexplorer_get_savings_plans_purchase_recommendation(SavingsPlansType,
  TermInYears, PaymentOption, AccountScope, NextPageToken, PageSize,
  LookbackPeriodInDays, Filter)

Arguments

SavingsPlansType

[required] The Savings Plans recommendation type that's requested.

TermInYears

[required] The savings plan recommendation term that's used to generate these recommendations.

PaymentOption

[required] The payment option that's used to generate these recommendations.

AccountScope

The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only.

NextPageToken

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

PageSize

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

LookbackPeriodInDays

[required] The lookback period that's used to generate the recommendation.

Filter

You can filter your recommendations by Account ID with the LINKED_ACCOUNT dimension. To filter your recommendations by Account ID, specify Key as LINKED_ACCOUNT and Value as the comma-separated Acount ID(s) that you want to see Savings Plans purchase recommendations for.

For GetSavingsPlansPurchaseRecommendation, the Filter doesn't include CostCategories or Tags. It only includes Dimensions. With Dimensions, Key must be LINKED_ACCOUNT and Value can be a single Account ID or multiple comma-separated Account IDs that you want to see Savings Plans Purchase Recommendations for. AND and OR operators are not supported.

Value

A list with the following syntax:

list(
  Metadata = list(
    RecommendationId = "string",
    GenerationTimestamp = "string",
    AdditionalMetadata = "string"
  ),
  SavingsPlansPurchaseRecommendation = list(
    AccountScope = "PAYER"|"LINKED",
    SavingsPlansType = "COMPUTE_SP"|"EC2_INSTANCE_SP"|"SAGEMAKER_SP",
    TermInYears = "ONE_YEAR"|"THREE_YEARS",
    PaymentOption = "NO_UPFRONT"|"PARTIAL_UPFRONT"|"ALL_UPFRONT"|"LIGHT_UTILIZATION"|"MEDIUM_UTILIZATION"|"HEAVY_UTILIZATION",
    LookbackPeriodInDays = "SEVEN_DAYS"|"THIRTY_DAYS"|"SIXTY_DAYS",
    SavingsPlansPurchaseRecommendationDetails = list(
      list(
        SavingsPlansDetails = list(
          Region = "string",
          InstanceFamily = "string",
          OfferingId = "string"
        ),
        AccountId = "string",
        UpfrontCost = "string",
        EstimatedROI = "string",
        CurrencyCode = "string",
        EstimatedSPCost = "string",
        EstimatedOnDemandCost = "string",
        EstimatedOnDemandCostWithCurrentCommitment = "string",
        EstimatedSavingsAmount = "string",
        EstimatedSavingsPercentage = "string",
        HourlyCommitmentToPurchase = "string",
        EstimatedAverageUtilization = "string",
        EstimatedMonthlySavingsAmount = "string",
        CurrentMinimumHourlyOnDemandSpend = "string",
        CurrentMaximumHourlyOnDemandSpend = "string",
        CurrentAverageHourlyOnDemandSpend = "string",
        RecommendationDetailId = "string"
      )
    ),
    SavingsPlansPurchaseRecommendationSummary = list(
      EstimatedROI = "string",
      CurrencyCode = "string",
      EstimatedTotalCost = "string",
      CurrentOnDemandSpend = "string",
      EstimatedSavingsAmount = "string",
      TotalRecommendationCount = "string",
      DailyCommitmentToPurchase = "string",
      HourlyCommitmentToPurchase = "string",
      EstimatedSavingsPercentage = "string",
      EstimatedMonthlySavingsAmount = "string",
      EstimatedOnDemandCostWithCurrentCommitment = "string"
    )
  ),
  NextPageToken = "string"
)

Request syntax

svc$get_savings_plans_purchase_recommendation(
  SavingsPlansType = "COMPUTE_SP"|"EC2_INSTANCE_SP"|"SAGEMAKER_SP",
  TermInYears = "ONE_YEAR"|"THREE_YEARS",
  PaymentOption = "NO_UPFRONT"|"PARTIAL_UPFRONT"|"ALL_UPFRONT"|"LIGHT_UTILIZATION"|"MEDIUM_UTILIZATION"|"HEAVY_UTILIZATION",
  AccountScope = "PAYER"|"LINKED",
  NextPageToken = "string",
  PageSize = 123,
  LookbackPeriodInDays = "SEVEN_DAYS"|"THIRTY_DAYS"|"SIXTY_DAYS",
  Filter = list(
    Or = list(
      list()
    ),
    And = list(
      list()
    ),
    Not = list(),
    Dimensions = list(
      Key = "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"LINKED_ACCOUNT_NAME"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"SERVICE_CODE"|"USAGE_TYPE"|"USAGE_TYPE_GROUP"|"RECORD_TYPE"|"OPERATING_SYSTEM"|"TENANCY"|"SCOPE"|"PLATFORM"|"SUBSCRIPTION_ID"|"LEGAL_ENTITY_NAME"|"DEPLOYMENT_OPTION"|"DATABASE_ENGINE"|"CACHE_ENGINE"|"INSTANCE_TYPE_FAMILY"|"BILLING_ENTITY"|"RESERVATION_ID"|"RESOURCE_ID"|"RIGHTSIZING_TYPE"|"SAVINGS_PLANS_TYPE"|"SAVINGS_PLAN_ARN"|"PAYMENT_OPTION"|"AGREEMENT_END_DATE_TIME_AFTER"|"AGREEMENT_END_DATE_TIME_BEFORE"|"INVOICING_ENTITY"|"ANOMALY_TOTAL_IMPACT_ABSOLUTE"|"ANOMALY_TOTAL_IMPACT_PERCENTAGE",
      Values = list(
        "string"
      ),
      MatchOptions = list(
        "EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL"
      )
    ),
    Tags = list(
      Key = "string",
      Values = list(
        "string"
      ),
      MatchOptions = list(
        "EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL"
      )
    ),
    CostCategories = list(
      Key = "string",
      Values = list(
        "string"
      ),
      MatchOptions = list(
        "EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL"
      )
    )
  )
)