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

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

Overview

Note:

When making an API call, you may pass GetUsageForecastRequest data as a 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, 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
    },
  },
  prediction_interval_level: 1,
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ Types::Expression

The filters that you want to use to filter your forecast. The ‘GetUsageForecast` 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`

Returns:



4869
4870
4871
4872
4873
4874
4875
4876
4877
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 4869

class GetUsageForecastRequest < Struct.new(
  :time_period,
  :metric,
  :granularity,
  :filter,
  :prediction_interval_level)
  SENSITIVE = []
  include Aws::Structure
end

#granularity ⇒ String

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.

Returns:

  • (String) 


4869
4870
4871
4872
4873
4874
4875
4876
4877
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 4869

class GetUsageForecastRequest < Struct.new(
  :time_period,
  :metric,
  :granularity,
  :filter,
  :prediction_interval_level)
  SENSITIVE = []
  include Aws::Structure
end

#metric ⇒ String

Which metric Cost Explorer uses to create your forecast.

Valid values for a ‘GetUsageForecast` call are the following:

  • USAGE_QUANTITY

  • NORMALIZED_USAGE_AMOUNT

Returns:

  • (String) 


4869
4870
4871
4872
4873
4874
4875
4876
4877
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 4869

class GetUsageForecastRequest < Struct.new(
  :time_period,
  :metric,
  :granularity,
  :filter,
  :prediction_interval_level)
  SENSITIVE = []
  include Aws::Structure
end

#prediction_interval_level ⇒ Integer

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) 


4869
4870
4871
4872
4873
4874
4875
4876
4877
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 4869

class GetUsageForecastRequest < Struct.new(
  :time_period,
  :metric,
  :granularity,
  :filter,
  :prediction_interval_level)
  SENSITIVE = []
  include Aws::Structure
end

#time_period ⇒ Types::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`. The start date must be equal to or later than the current date to avoid a validation error.

Returns:



4869
4870
4871
4872
4873
4874
4875
4876
4877
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 4869

class GetUsageForecastRequest < Struct.new(
  :time_period,
  :metric,
  :granularity,
  :filter,
  :prediction_interval_level)
  SENSITIVE = []
  include Aws::Structure
end