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

Class: Aws::CostExplorer::Types::GetUsageForecastRequest

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

Overview

Note:

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

{
  time_period: { # required
    start: "YearMonthDay", # required
    end: "YearMonthDay", # required
  },
  metric: "BLENDED_COST", # required, accepts BLENDED_COST, UNBLENDED_COST, AMORTIZED_COST, NET_UNBLENDED_COST, NET_AMORTIZED_COST, USAGE_QUANTITY, NORMALIZED_USAGE_AMOUNT
  granularity: "DAILY", # required, accepts DAILY, MONTHLY, HOURLY
  filter: {
    or: [
      {
        # recursive Expression
      },
    ],
    and: [
      {
        # recursive Expression
      },
    ],
    not: {
      # recursive Expression
    },
    dimensions: {
      key: "AZ", # accepts AZ, INSTANCE_TYPE, LINKED_ACCOUNT, 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, CACHE_ENGINE, INSTANCE_TYPE_FAMILY, BILLING_ENTITY, RESERVATION_ID, RESOURCE_ID, RIGHTSIZING_TYPE, SAVINGS_PLANS_TYPE, SAVINGS_PLAN_ARN, PAYMENT_OPTION
      values: ["Value"],
    },
    tags: {
      key: "TagKey",
      values: ["Value"],
    },
  },
  prediction_interval_level: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#filterTypes::Expression

The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.

Returns:

#granularityString

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

The GetUsageForecast operation supports only DAILY and MONTHLY granularities.

Possible values:

  • DAILY
  • MONTHLY
  • HOURLY

Returns:

  • (String)

    How granular you want the forecast to be.

#metricString

Which metric Cost Explorer uses to create your forecast.

Valid values for a GetUsageForecast call are the following:

  • USAGE_QUANTITY

  • NORMALIZED_USAGE_AMOUNT

    Possible values:

    • BLENDED_COST
    • UNBLENDED_COST
    • AMORTIZED_COST
    • NET_UNBLENDED_COST
    • NET_AMORTIZED_COST
    • USAGE_QUANTITY
    • NORMALIZED_USAGE_AMOUNT

Returns:

  • (String)

    Which metric Cost Explorer uses to create your forecast.

#prediction_interval_levelInteger

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.

Returns:

  • (Integer)

    Cost Explorer always returns the mean forecast as a single point.

#time_periodTypes::DateInterval

The start and end dates of the period that you want to retrieve usage forecast for. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

Returns:

  • (Types::DateInterval)

    The start and end dates of the period that you want to retrieve usage forecast for.