---
title: "POST /#X-Amz-Target=AmazonForecast.ListPredictors"
method: POST
path: "/#X-Amz-Target=AmazonForecast.ListPredictors"
---

# POST /#X-Amz-Target=AmazonForecast.ListPredictors

`POST /#X-Amz-Target=AmazonForecast.ListPredictors`

Returns a list of predictors created using the CreateAutoPredictor or CreatePredictor operations. For each predictor, this operation returns a summary of its properties, including its Amazon Resource Name (ARN).

You can retrieve the complete set of properties by using the ARN with the DescribeAutoPredictor and DescribePredictor operations. You can filter the list using an array of Filter objects.

## Query parameters

- `MaxResults` string
- `NextToken` string

## Headers

- `X-Amz-Target` 'AmazonForecast.ListPredictors', required

## Request body

- ListPredictorsRequest
  - `NextToken` string — If the result of the previous request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.
  - `MaxResults` integer — The number of items to return in the response.
  - `Filters` Filter[] — <p>An array of filters. For each filter, you provide a condition and a match statement. The condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include or exclude the predictors that match the statement from the list, respectively. The match statement consists of a key and a value.</p> <p> <b>Filter properties</b> </p> <ul> <li> <p> <code>Condition</code> - The condition to apply. Valid values are <code>IS</code> and <code>IS_NOT</code>. To include the predictors that match the statement, specify <code>IS</code>. To exclude matching predictors, specify <code>IS_NOT</code>.</p> </li> <li> <p> <code>Key</code> - The name of the parameter to filter on. Valid values are <code>DatasetGroupArn</code> and <code>Status</code>.</p> </li> <li> <p> <code>Value</code> - The value to match.</p> </li> </ul> <p>For example, to list all predictors whose status is ACTIVE, you would specify:</p> <p> <code>"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]</code> </p>
    - `Key` string, required — The name of the parameter to filter on.
    - `Value` string, required — The value to match.
    - `Condition` 'IS' | 'IS_NOT', required — The condition to apply. To include the objects that match the statement, specify <code>IS</code>. To exclude matching objects, specify <code>IS_NOT</code>.

## Response `200`

Success

- ListPredictorsResponse
  - `Predictors` PredictorSummary[] — An array of objects that summarize each predictor's properties.
    - `PredictorArn` string — The ARN of the predictor.
    - `PredictorName` string — The name of the predictor.
    - `DatasetGroupArn` string — The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.
    - `IsAutoPredictor` boolean — Whether AutoPredictor was used to create the predictor.
    - `ReferencePredictorSummary` object — A summary of the reference predictor used if the predictor was retrained or upgraded.
      - `Arn` string — The ARN of the reference predictor.
      - `State` 'Active' | 'Deleted' — Whether the reference predictor is <code>Active</code> or <code>Deleted</code>.
    - `Status` string — <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>
    - `Message` string — If an error occurred, an informational message about the error.
    - `CreationTime` string, date-time — When the model training task was created.
    - `LastModificationTime` string, 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>
  - `NextToken` string — If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

## Other responses

- `480` — InvalidNextTokenException
- `481` — InvalidInputException

---

[API](https://skmtc.net/aws/apis/forecast.md) · [All operations](https://skmtc.net/aws/apis/forecast/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/forecast/versions/3d1c872d2ac9/schema)