Post x amz targetamazonforecast.describeautopredictor

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1463278347.3 KB

Describes a predictor created using the CreateAutoPredictor operation.

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

Headers

X-Amz-Target'AmazonForecast.DescribeAutoPredictor' required

Request body

PredictorArnstring required

The Amazon Resource Name (ARN) of the predictor.

Response

Success

PredictorArnstring

The Amazon Resource Name (ARN) of the predictor

PredictorNamestring

The name of the predictor.

ForecastHorizoninteger

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

ForecastTypesForecastType[]

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

ForecastFrequencystring

The frequency of predictions in a forecast. Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates every year and "5min" indicates every five minutes.

ForecastDimensionsName[]

An array of dimension (field) names that specify the attributes used to group your time series.

DatasetImportJobArnsArn[]

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

EstimatedTimeRemainingInMinutesinteger

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

Statusstring

The status of the predictor. States include: <ul> <li> <code>ACTIVE</code> </li> <li> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </li> <li> <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code> </li> <li> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </li> </ul>

Messagestring

In the event of an error, a message detailing the cause of the error.

CreationTimestring date-time

The timestamp of the CreateAutoPredictor request.

LastModificationTimestring date-time

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

OptimizationMetric'WAPE' | 'RMSE' | 'AverageWeightedQuantileLoss' | 'MASE' | 'MAPE'

The accuracy metric used to optimize the predictor.