List Predictors
forecastservice_list_predictors | R Documentation |
Returns a list of predictors created using the CreateAutoPredictor or CreatePredictor operations¶
Description¶
Returns a list of predictors created using the create_auto_predictor
or create_predictor
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 describe_auto_predictor
and describe_predictor
operations. You
can filter the list using an array of Filter objects.
Usage¶
Arguments¶
NextToken
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.MaxResults
The number of items to return in the response.
Filters
An array of filters. For each filter, you provide a condition and a match statement. The condition is either
IS
orIS_NOT
, 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.Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the predictors that match the statement, specifyIS
. To exclude matching predictors, specifyIS_NOT
.Key
- The name of the parameter to filter on. Valid values areDatasetGroupArn
andStatus
.Value
- The value to match.
For example, to list all predictors whose status is ACTIVE, you would specify:
"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]
Value¶
A list with the following syntax:
list(
Predictors = list(
list(
PredictorArn = "string",
PredictorName = "string",
DatasetGroupArn = "string",
IsAutoPredictor = TRUE|FALSE,
ReferencePredictorSummary = list(
Arn = "string",
State = "Active"|"Deleted"
),
Status = "string",
Message = "string",
CreationTime = as.POSIXct(
"2015-01-01"
),
LastModificationTime = as.POSIXct(
"2015-01-01"
)
)
),
NextToken = "string"
)