NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $ce = Paws->service('CostExplorer');
    my $GetCostForecastResponse = $ce->GetCostForecast(
      Granularity => 'DAILY',
      Metric      => 'BLENDED_COST',
      TimePeriod  => {
        End   => 'MyYearMonthDay',    # max: 40
        Start => 'MyYearMonthDay',    # max: 40
      },
      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
      PredictionIntervalLevel => 1,    # OPTIONAL
    );
    # Results:
    my $ForecastResultsByTime = $GetCostForecastResponse->ForecastResultsByTime;
    my $Total                 = $GetCostForecastResponse->Total;
    # Returns a L<Paws::CostExplorer::GetCostForecastResponse> 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/GetCostForecast>

ATTRIBUTES

Filter => Paws::CostExplorer::Expression

The filters that you want to use to filter your forecast. The "GetCostForecast" API supports filtering by the following dimensions:

"AZ"
"INSTANCE_TYPE"
"LINKED_ACCOUNT"
"LINKED_ACCOUNT_NAME"
"OPERATION"
"PURCHASE_TYPE"
"REGION"
"SERVICE"
"USAGE_TYPE"
"USAGE_TYPE_GROUP"
"RECORD_TYPE"
"OPERATING_SYSTEM"
"TENANCY"
"SCOPE"
"PLATFORM"
"SUBSCRIPTION_ID"
"LEGAL_ENTITY_NAME"
"DEPLOYMENT_OPTION"
"DATABASE_ENGINE"
"INSTANCE_TYPE_FAMILY"
"BILLING_ENTITY"
"RESERVATION_ID"
"SAVINGS_PLAN_ARN"

REQUIRED Granularity => Str

How granular you want the forecast to be. You can get 3 months of "DAILY" forecasts or 12 months of "MONTHLY" forecasts.

The "GetCostForecast" operation supports only "DAILY" and "MONTHLY" granularities.

Valid values are: "DAILY", "MONTHLY", "HOURLY"

REQUIRED Metric => Str

Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill? (http://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/).

Valid values for a "GetCostForecast" call are the following:

AMORTIZED_COST
BLENDED_COST
NET_AMORTIZED_COST
NET_UNBLENDED_COST
UNBLENDED_COST

Valid values are: "BLENDED_COST", "UNBLENDED_COST", "AMORTIZED_COST", "NET_UNBLENDED_COST", "NET_AMORTIZED_COST", "USAGE_QUANTITY", "NORMALIZED_USAGE_AMOUNT"

PredictionIntervalLevel => Int

Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.

REQUIRED TimePeriod => Paws::CostExplorer::DateInterval

The period of time that you want the forecast to cover. The start date must be equal to or no later than the current date to avoid a validation error.

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>