You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CostExplorer::Types::GetSavingsPlansPurchaseRecommendationRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetSavingsPlansPurchaseRecommendationRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  savings_plans_type: "COMPUTE_SP", # required, accepts COMPUTE_SP, EC2_INSTANCE_SP
  term_in_years: "ONE_YEAR", # required, accepts ONE_YEAR, THREE_YEARS
  payment_option: "NO_UPFRONT", # required, accepts NO_UPFRONT, PARTIAL_UPFRONT, ALL_UPFRONT, LIGHT_UTILIZATION, MEDIUM_UTILIZATION, HEAVY_UTILIZATION
  account_scope: "PAYER", # accepts PAYER, LINKED
  next_page_token: "NextPageToken",
  page_size: 1,
  lookback_period_in_days: "SEVEN_DAYS", # required, accepts SEVEN_DAYS, THIRTY_DAYS, SIXTY_DAYS
  filter: {
    or: [
      {
        # recursive Expression
      },
    ],
    and: [
      {
        # recursive Expression
      },
    ],
    not: {
      # recursive Expression
    },
    dimensions: {
      key: "AZ", # accepts 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
      values: ["Value"],
      match_options: ["EQUALS"], # accepts EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
    },
    tags: {
      key: "TagKey",
      values: ["Value"],
      match_options: ["EQUALS"], # accepts EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
    },
    cost_categories: {
      key: "CostCategoryName",
      values: ["Value"],
      match_options: ["EQUALS"], # accepts EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
    },
  },
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#account_scope ⇒ String

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.

Possible values:

  • PAYER
  • LINKED

Returns:

  • (String) —

    The account scope that you want your recommendations for.

#filter ⇒ Types::Expression

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) for which you want to see Savings Plans purchase recommendations.

For GetSavingsPlansPurchaseRecommendation, the Filter does not 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 for which you want to see Savings Plans Purchase Recommendations. AND and OR operators are not supported.

Returns:

  • (Types::Expression) —

    You can filter your recommendations by Account ID with the LINKED_ACCOUNT dimension.

#lookback_period_in_days ⇒ String

The lookback period used to generate the recommendation.

Possible values:

  • SEVEN_DAYS
  • THIRTY_DAYS
  • SIXTY_DAYS

Returns:

  • (String) —

    The lookback period used to generate the recommendation.

#next_page_token ⇒ String

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.

Returns:

  • (String) —

    The token to retrieve the next set of results.

#page_size ⇒ Integer

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

Returns:

  • (Integer) —

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

#payment_option ⇒ String

The payment option used to generate these recommendations.

Possible values:

  • NO_UPFRONT
  • PARTIAL_UPFRONT
  • ALL_UPFRONT
  • LIGHT_UTILIZATION
  • MEDIUM_UTILIZATION
  • HEAVY_UTILIZATION

Returns:

  • (String) —

    The payment option used to generate these recommendations.

#savings_plans_type ⇒ String

The Savings Plans recommendation type requested.

Possible values:

  • COMPUTE_SP
  • EC2_INSTANCE_SP

Returns:

  • (String) —

    The Savings Plans recommendation type requested.

#term_in_years ⇒ String

The savings plan recommendation term used to generate these recommendations.

Possible values:

  • ONE_YEAR
  • THREE_YEARS

Returns:

  • (String) —

    The savings plan recommendation term used to generate these recommendations.