NAME

Paws::CostExplorer::GetSavingsPlansPurchaseRecommendation - Arguments for method GetSavingsPlansPurchaseRecommendation on Paws::CostExplorer

DESCRIPTION

This class represents the parameters used for calling the method GetSavingsPlansPurchaseRecommendation on the AWS Cost Explorer Service service. Use the attributes of this class as arguments to method GetSavingsPlansPurchaseRecommendation.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetSavingsPlansPurchaseRecommendation.

SYNOPSIS

    my $ce = Paws->service('CostExplorer');
    my $GetSavingsPlansPurchaseRecommendationResponse =
      $ce->GetSavingsPlansPurchaseRecommendation(
      LookbackPeriodInDays => 'SEVEN_DAYS',
      PaymentOption        => 'NO_UPFRONT',
      SavingsPlansType     => 'COMPUTE_SP',
      TermInYears          => 'ONE_YEAR',
      AccountScope         => 'PAYER',        # OPTIONAL
      Filter               => {
        And            => [ <Expression>, ... ],    # OPTIONAL
        CostCategories => {
          Key          => 'MyCostCategoryName',     # min: 1, max: 50; OPTIONAL
          MatchOptions => [
            'EQUALS',
            ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
          ],    # OPTIONAL
          Values => [
            'MyValue', ...    # max: 1024
          ],    # OPTIONAL
        },    # OPTIONAL
        Dimensions => {
          Key => 'AZ'
          , # values: 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; OPTIONAL
          MatchOptions => [
            'EQUALS',
            ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
          ],    # OPTIONAL
          Values => [
            'MyValue', ...    # max: 1024
          ],    # OPTIONAL
        },    # OPTIONAL
        Not  => <Expression>,
        Or   => [ <Expression>, ... ],    # OPTIONAL
        Tags => {
          Key          => 'MyTagKey',     # max: 1024; OPTIONAL
          MatchOptions => [
            'EQUALS',
            ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
          ],    # OPTIONAL
          Values => [
            'MyValue', ...    # max: 1024
          ],    # OPTIONAL
        },    # OPTIONAL
      },    # OPTIONAL
      NextPageToken => 'MyNextPageToken',    # OPTIONAL
      PageSize      => 1,                    # OPTIONAL
      );
    # Results:
    my $Metadata = $GetSavingsPlansPurchaseRecommendationResponse->Metadata;
    my $NextPageToken =
      $GetSavingsPlansPurchaseRecommendationResponse->NextPageToken;
    my $SavingsPlansPurchaseRecommendation =
      $GetSavingsPlansPurchaseRecommendationResponse
      ->SavingsPlansPurchaseRecommendation;

# Returns a Paws::CostExplorer::GetSavingsPlansPurchaseRecommendationResponse object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/ce/GetSavingsPlansPurchaseRecommendation>

ATTRIBUTES

AccountScope => Str

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.

Valid values are: "PAYER", "LINKED"

Filter => Paws::CostExplorer::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.

REQUIRED LookbackPeriodInDays => Str

The lookback period used to generate the recommendation.

Valid values are: "SEVEN_DAYS", "THIRTY_DAYS", "SIXTY_DAYS"

NextPageToken => Str

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 => Int

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

REQUIRED PaymentOption => Str

The payment option used to generate these recommendations.

Valid values are: "NO_UPFRONT", "PARTIAL_UPFRONT", "ALL_UPFRONT", "LIGHT_UTILIZATION", "MEDIUM_UTILIZATION", "HEAVY_UTILIZATION"

REQUIRED SavingsPlansType => Str

The Savings Plans recommendation type requested.

Valid values are: "COMPUTE_SP", "EC2_INSTANCE_SP", "SAGEMAKER_SP"

REQUIRED TermInYears => Str

The savings plan recommendation term used to generate these recommendations.

Valid values are: "ONE_YEAR", "THREE_YEARS"

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>