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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb

Overview

Note:

When making an API call, you may pass GetSavingsPlansPurchaseRecommendationRequest data as a hash:

{
  savings_plans_type: "COMPUTE_SP", # required, accepts COMPUTE_SP, EC2_INSTANCE_SP, SAGEMAKER_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, AGREEMENT_END_DATE_TIME_AFTER, AGREEMENT_END_DATE_TIME_BEFORE
      values: ["Value"],
      match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
    },
    tags: {
      key: "TagKey",
      values: ["Value"],
      match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
    },
    cost_categories: {
      key: "CostCategoryName",
      values: ["Value"],
      match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
    },
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_scopeString

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.

Returns:

  • (String)


4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 4368

class GetSavingsPlansPurchaseRecommendationRequest < Struct.new(
  :savings_plans_type,
  :term_in_years,
  :payment_option,
  :account_scope,
  :next_page_token,
  :page_size,
  :lookback_period_in_days,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#filterTypes::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:



4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 4368

class GetSavingsPlansPurchaseRecommendationRequest < Struct.new(
  :savings_plans_type,
  :term_in_years,
  :payment_option,
  :account_scope,
  :next_page_token,
  :page_size,
  :lookback_period_in_days,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#lookback_period_in_daysString

The lookback period used to generate the recommendation.

Returns:

  • (String)


4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 4368

class GetSavingsPlansPurchaseRecommendationRequest < Struct.new(
  :savings_plans_type,
  :term_in_years,
  :payment_option,
  :account_scope,
  :next_page_token,
  :page_size,
  :lookback_period_in_days,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#next_page_tokenString

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)


4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 4368

class GetSavingsPlansPurchaseRecommendationRequest < Struct.new(
  :savings_plans_type,
  :term_in_years,
  :payment_option,
  :account_scope,
  :next_page_token,
  :page_size,
  :lookback_period_in_days,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#page_sizeInteger

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

Returns:

  • (Integer)


4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 4368

class GetSavingsPlansPurchaseRecommendationRequest < Struct.new(
  :savings_plans_type,
  :term_in_years,
  :payment_option,
  :account_scope,
  :next_page_token,
  :page_size,
  :lookback_period_in_days,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#payment_optionString

The payment option used to generate these recommendations.

Returns:

  • (String)


4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 4368

class GetSavingsPlansPurchaseRecommendationRequest < Struct.new(
  :savings_plans_type,
  :term_in_years,
  :payment_option,
  :account_scope,
  :next_page_token,
  :page_size,
  :lookback_period_in_days,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#savings_plans_typeString

The Savings Plans recommendation type requested.

Returns:

  • (String)


4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 4368

class GetSavingsPlansPurchaseRecommendationRequest < Struct.new(
  :savings_plans_type,
  :term_in_years,
  :payment_option,
  :account_scope,
  :next_page_token,
  :page_size,
  :lookback_period_in_days,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#term_in_yearsString

The savings plan recommendation term used to generate these recommendations.

Returns:

  • (String)


4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 4368

class GetSavingsPlansPurchaseRecommendationRequest < Struct.new(
  :savings_plans_type,
  :term_in_years,
  :payment_option,
  :account_scope,
  :next_page_token,
  :page_size,
  :lookback_period_in_days,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end