POST

/#X-Amz-Target=AmazonForecast.DescribePredictor

http://forecast.{region}.amazonaws.com/#X-Amz-Target=AmazonForecast.DescribePredictor

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

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://forecast.{region}.amazonaws.com/#X-Amz-Target=AmazonForecast.DescribePredictor' \
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}