POST

/#X-Amz-Target=AmazonForecastRuntime.QueryForecast

http://forecastquery.{region}.amazonaws.com/#X-Amz-Target=AmazonForecastRuntime.QueryForecast

Retrieves a forecast for a single item, filtered by the supplied criteria. The criteria is a key-value pair. The key is either <code>item_id</code> (or the equivalent non-timestamp, non-target field) from the <code>TARGET_TIME_SERIES</code> dataset, or one of the forecast dimensions specified as part of the <code>FeaturizationConfig</code> object. By default, <code>QueryForecast</code> returns the complete date range for the filtered forecast. You can request a specific date range. To get the full forecast, use the <a href="https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html">CreateForecastExportJob</a> operation. <note> The forecasts generated by Amazon Forecast are in the same timezone as the dataset that was used to create the predictor. </note>

Access Token Required: API Key

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://forecastquery.{region}.amazonaws.com/#X-Amz-Target=AmazonForecastRuntime.QueryForecast' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}