Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1463278347.3 KB

Describes a forecast created using the CreateForecast operation.

In addition to listing the properties provided in the CreateForecast request, this operation lists the following properties:

  • DatasetGroupArn - The dataset group that provided the training data.

  • CreationTime

  • LastModificationTime

  • Status

  • Message - If an error occurred, information about the error.

post/#X-Amz-Target=AmazonForecast.DescribeForecast

Headers

X-Amz-Target'AmazonForecast.DescribeForecast' required

Request body

ForecastArnstring required

The Amazon Resource Name (ARN) of the forecast.

Response

Success

ForecastArnstring

The forecast ARN as specified in the request.

ForecastNamestring

The name of the forecast.

ForecastTypesForecastType[]

The quantiles at which probabilistic forecasts were generated.

PredictorArnstring

The ARN of the predictor used to generate the forecast.

DatasetGroupArnstring

The ARN of the dataset group that provided the data used to train the predictor.

EstimatedTimeRemainingInMinutesinteger

The estimated time remaining in minutes for the forecast job to complete.

Statusstring
<p>The status of the forecast. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> </ul> <note> <p>The <code>Status</code> of the forecast must be <code>ACTIVE</code> before you can query or export the forecast.</p> </note>
Messagestring

If an error occurred, an informational message about the error.

CreationTimestring date-time

When the forecast creation task was created.

LastModificationTimestring date-time
<p>The last time the resource was modified. The timestamp depends on the status of the job:</p> <ul> <li> <p> <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPING</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPED</code> - When the job stopped.</p> </li> <li> <p> <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or failed.</p> </li> </ul>