Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1463278347.3 KB

<note> <p> This operation is only valid for legacy predictors created with CreatePredictor. If you are not using a legacy predictor, use <a>DescribeAutoPredictor</a>.</p> </note> <p>Describes a predictor created using the <a>CreatePredictor</a> operation.</p> <p>In addition to listing the properties provided in the <code>CreatePredictor</code> request, this operation lists the following properties:</p> <ul> <li> <p> <code>DatasetImportJobArns</code> - The dataset import jobs used to import training data.</p> </li> <li> <p> <code>AutoMLAlgorithmArns</code> - If AutoML is performed, the algorithms that were evaluated.</p> </li> <li> <p> <code>CreationTime</code> </p> </li> <li> <p> <code>LastModificationTime</code> </p> </li> <li> <p> <code>Status</code> </p> </li> <li> <p> <code>Message</code> - If an error occurred, information about the error.</p> </li> </ul>

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

Headers

X-Amz-Target'AmazonForecast.DescribePredictor' required

Request body

PredictorArnstring required

The Amazon Resource Name (ARN) of the predictor that you want information about.

Response

Success

PredictorArnstring

The ARN of the predictor.

PredictorNamestring

The name of the predictor.

AlgorithmArnstring

The Amazon Resource Name (ARN) of the algorithm used for model training.

AutoMLAlgorithmArnsArn[]

When <code>PerformAutoML</code> is specified, the ARN of the chosen algorithm.

ForecastHorizoninteger

The number of time-steps of the forecast. The forecast horizon is also called the prediction length.

ForecastTypesForecastType[]

The forecast types used during predictor training. Default value is <code>["0.1","0.5","0.9"]</code>

PerformAutoMLboolean

Whether the predictor is set to perform AutoML.

AutoMLOverrideStrategy'LatencyOptimized' | 'AccuracyOptimized'

<note> <p> The <code>LatencyOptimized</code> AutoML override strategy is only available in private beta. Contact Amazon Web Services Support or your account manager to learn more about access privileges. </p> </note> <p>The AutoML strategy used to train the predictor. Unless <code>LatencyOptimized</code> is specified, the AutoML strategy optimizes predictor accuracy.</p> <p>This parameter is only valid for predictors trained using AutoML.</p>

PerformHPOboolean

Whether the predictor is set to perform hyperparameter optimization (HPO).

TrainingParametersobject

The default training parameters or overrides selected during model training. When running AutoML or choosing HPO with CNN-QR or DeepAR+, the optimized values for the chosen hyperparameters are returned. For more information, see <a>aws-forecast-choosing-recipes</a>.

EstimatedTimeRemainingInMinutesinteger

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

IsAutoPredictorboolean

Whether the predictor was created with <a>CreateAutoPredictor</a>.

DatasetImportJobArnsArn[]

An array of the ARNs of the dataset import jobs used to import training data for the predictor.

Statusstring
<p>The status of the predictor. 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>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> <li> <p> <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code> </p> </li> </ul> <note> <p>The <code>Status</code> of the predictor must be <code>ACTIVE</code> before you can use the predictor to create a forecast.</p> </note>
Messagestring

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

CreationTimestring date-time

When the model training 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>
OptimizationMetric'WAPE' | 'RMSE' | 'AverageWeightedQuantileLoss' | 'MASE' | 'MAPE'

The accuracy metric used to optimize the predictor.