class Aws::CostExplorer::Types::GetUsageForecastRequest
@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, }
@!attribute [rw] time_period
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. @return [Types::DateInterval]
@!attribute [rw] metric
Which metric Cost Explorer uses to create your forecast. Valid values for a `GetUsageForecast` call are the following: * USAGE\_QUANTITY * NORMALIZED\_USAGE\_AMOUNT @return [String]
@!attribute [rw] granularity
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. @return [String]
@!attribute [rw] filter
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` @return [Types::Expression]
@!attribute [rw] prediction_interval_level
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. @return [Integer]
@see docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetUsageForecastRequest AWS API Documentation
Constants
- SENSITIVE