Returns a list of forecasts created using the create_forecast
operation. For each forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, specify the ARN with the describe_forecast
operation. You can filter the list using an array of Filter objects.
See https://www.paws-r-sdk.com/docs/forecastservice_list_forecasts/ for full documentation.
forecastservice_list_forecasts(
NextToken = NULL,
MaxResults = NULL,
Filters = NULL
)
If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next request. Tokens expire after 24 hours.
The number of items to return in the response.
An array of filters. For each filter, you provide a condition and a
match statement. The condition is either IS
or IS_NOT
, which
specifies whether to include or exclude the forecasts that match the
statement from the list, respectively. The match statement consists of a
key and a value.
Filter properties
Condition
- The condition to apply. Valid values are IS
and
IS_NOT
. To include the forecasts that match the statement, specify
IS
. To exclude matching forecasts, specify IS_NOT
.
Key
- The name of the parameter to filter on. Valid values are
DatasetGroupArn
, PredictorArn
, and Status
.
Value
- The value to match.
For example, to list all forecasts whose status is not ACTIVE, you would specify:
"Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]