# GetUsageForecast Retrieves a forecast for how much Amazon Web Services predicts that you will use over the forecast time period that you select, based on your past usage. ## Request Syntax ``` { "BillingViewArn": "string", "Filter": { "And": [ "Expression" ], "CostCategories": { "Key": "string", "MatchOptions": [ "string" ], "Values": [ "string" ] }, "Dimensions": { "Key": "string", "MatchOptions": [ "string" ], "Values": [ "string" ] }, "Not": "Expression", "Or": [ "Expression" ], "Tags": { "Key": "string", "MatchOptions": [ "string" ], "Values": [ "string" ] } }, "Granularity": "string", "Metric": "string", "PredictionIntervalLevel": number, "TimePeriod": { "End": "string", "Start": "string" } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [BillingViewArn](#API_GetUsageForecast_RequestSyntax) ** The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is used to specify which particular billing view you want to interact with or retrieve information from when making API calls related to AWS Billing and Cost Management features. The BillingViewArn can be retrieved by calling the ListBillingViews API. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `^arn:aws[a-z-]*:(billing)::[0-9]{12}:billingview/[-a-zA-Z0-9/:_+=.-@]{1,43}$` Required: No ** [Filter](#API_GetUsageForecast_RequestSyntax) ** 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` Type: [Expression](API_Expression.md) object Required: No ** [Granularity](#API_GetUsageForecast_RequestSyntax) ** How granular you want the forecast to be. You can get 3 months of `DAILY` forecasts or 18 months of `MONTHLY` forecasts. The `GetUsageForecast` operation supports only `DAILY` and `MONTHLY` granularities. Type: String Valid Values: `DAILY | MONTHLY | HOURLY` Required: Yes ** [Metric](#API_GetUsageForecast_RequestSyntax) ** Which metric Cost Explorer uses to create your forecast. Valid values for a `GetUsageForecast` call are the following: + USAGE\$1QUANTITY + NORMALIZED\$1USAGE\$1AMOUNT Type: String Valid Values: `BLENDED_COST | UNBLENDED_COST | AMORTIZED_COST | NET_UNBLENDED_COST | NET_AMORTIZED_COST | USAGE_QUANTITY | NORMALIZED_USAGE_AMOUNT` Required: Yes ** [PredictionIntervalLevel](#API_GetUsageForecast_RequestSyntax) ** AWS 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. Type: Integer Valid Range: Minimum value of 51. Maximum value of 99. Required: No ** [TimePeriod](#API_GetUsageForecast_RequestSyntax) ** The start and end dates of the period that you want to retrieve usage forecast for. The start date is included in the period, but the end date isn't included in the period. 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. Type: [DateInterval](API_DateInterval.md) object Required: Yes ## Response Syntax ``` { "ForecastResultsByTime": [ { "MeanValue": "string", "PredictionIntervalLowerBound": "string", "PredictionIntervalUpperBound": "string", "TimePeriod": { "End": "string", "Start": "string" } } ], "Total": { "Amount": "string", "Unit": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ForecastResultsByTime](#API_GetUsageForecast_ResponseSyntax) ** The forecasts for your query, in order. For `DAILY` forecasts, this is a list of days. For `MONTHLY` forecasts, this is a list of months. Type: Array of [ForecastResult](API_ForecastResult.md) objects ** [Total](#API_GetUsageForecast_ResponseSyntax) ** How much you're forecasted to use over the forecast period. Type: [MetricValue](API_MetricValue.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BillingViewHealthStatusException ** The billing view status must be `HEALTHY` to perform this action. Try again when the status is `HEALTHY`. HTTP Status Code: 400 ** DataUnavailableException ** The requested data is unavailable. HTTP Status Code: 400 ** LimitExceededException ** You made too many calls in a short period of time. Try again later. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified ARN in the request doesn't exist. HTTP Status Code: 400 ** UnresolvableUsageUnitException ** Cost Explorer was unable to identify the usage unit. Provide `UsageType/UsageTypeGroup` filter selections that contain matching units, for example: `hours`. HTTP Status Code: 400 ## Examples ### Example The following example shows how to retrieve a forecast using the `GetUsageForecast` operation. #### Sample Request ``` POST / HTTP/1.1 Host: ce.us-east-1.amazonaws.com x-amz-Date: Authorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=contenttype;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid,Signature= User-Agent: Content-Type: application/x-amz-json-1.1 Content-Length: Connection: Keep-Alive X-Amz-Target: AWSInsightsIndexService.GetUsageForecast { "TimePeriod": { "Start":"2018-10-25", "End": "2018-10-27" }, "Granularity": "DAILY", "Filter": { "Dimensions": { "Key": "SERVICE", "Values": [ "Amazon Simple Storage Service" ] } }, "Metric":"USAGE_QUANTITY", "PredictionIntervalLevel":85 } ``` #### Sample Response ``` HTTP/1.1 200 OK x-amzn-RequestId: Content-Type: application/x-amz-json-1.1 Content-Length: Date: { "ForecastResultsByTime": [ { "MeanValue": "37.0786663399", "PredictionIntervalLowerBound": "34.9970026341", "PredictionIntervalUpperBound": "39.1603300457", "TimePeriod": { "End": "2019-10-26", "Start": "2019-10-25" } }, { "MeanValue": "37.0786663399", "PredictionIntervalLowerBound": "34.9970026341", "PredictionIntervalUpperBound": "39.1603300457", "TimePeriod": { "End": "2019-10-27", "Start": "2019-10-26" } } ], "Total": { "Amount": "74.1573326798", "Unit": "Hrs" } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ce-2017-10-25/GetUsageForecast) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ce-2017-10-25/GetUsageForecast) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ce-2017-10-25/GetUsageForecast) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ce-2017-10-25/GetUsageForecast) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ce-2017-10-25/GetUsageForecast) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ce-2017-10-25/GetUsageForecast) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ce-2017-10-25/GetUsageForecast) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ce-2017-10-25/GetUsageForecast) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ce-2017-10-25/GetUsageForecast) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ce-2017-10-25/GetUsageForecast)