Amazon Forecast is no longer available to new customers. Existing customers of
Amazon Forecast can continue to use the service as normal.
Learn more"
QueryForecast
Retrieves a forecast for a single item, filtered by the supplied criteria.
The criteria is a key-value pair. The key is either item_id (or the
equivalent non-timestamp, non-target field) from the TARGET_TIME_SERIES dataset,
or one of the forecast dimensions specified as part of the FeaturizationConfig
object.
By default, QueryForecast returns the complete date range for the filtered
forecast. You can request a specific date range.
To get the full forecast, use the CreateForecastExportJob operation.
Note
The forecasts generated by Amazon Forecast are in the same timezone as the dataset that was used to create the predictor.
Request Syntax
{
"EndDate": "string",
"Filters": {
"string" : "string"
},
"ForecastArn": "string",
"NextToken": "string",
"StartDate": "string"
}Request Parameters
The request accepts the following data in JSON format.
- EndDate
-
The end date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T20:00:00.
Type: String
Required: No
- Filters
-
The filtering criteria to apply when retrieving the forecast. For example, to get the forecast for
client_21in the electricity usage dataset, specify the following:{"item_id" : "client_21"}To get the full forecast, use the CreateForecastExportJob operation.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Maximum length of 256.
Key Pattern:
^[a-zA-Z0-9\_\-]+$Value Length Constraints: Maximum length of 256.
Required: Yes
- ForecastArn
-
The Amazon Resource Name (ARN) of the forecast to query.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):forecast:.*:.*:.+Required: Yes
- NextToken
-
If the result of the previous request was truncated, the response includes a
NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.Type: String
Length Constraints: Minimum length of 1. Maximum length of 3000.
Required: No
- StartDate
-
The start date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T08:00:00.
Type: String
Required: No
Response Syntax
{
"Forecast": {
"Predictions": {
"string" : [
{
"Timestamp": "string",
"Value": number
}
]
}
}
}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.
Errors
- InvalidInputException
-
The value is invalid or is too long.
HTTP Status Code: 400
- InvalidNextTokenException
-
The token is not valid. Tokens expire after 24 hours.
HTTP Status Code: 400
- LimitExceededException
-
The limit on the number of requests per second has been exceeded.
HTTP Status Code: 400
- ResourceInUseException
-
The specified resource is in use.
HTTP Status Code: 400
- ResourceNotFoundException
-
We can't find that resource. Check the information that you've provided and try again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
