| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Forecast.ListPredictors
Description
Returns a list of predictors created using the CreatePredictor operation. 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 DescribePredictor operation. You can filter the list using an array of Filter objects.
This operation returns paginated results.
Synopsis
- data ListPredictors = ListPredictors' {}
- newListPredictors :: ListPredictors
- listPredictors_filters :: Lens' ListPredictors (Maybe [Filter])
- listPredictors_nextToken :: Lens' ListPredictors (Maybe Text)
- listPredictors_maxResults :: Lens' ListPredictors (Maybe Natural)
- data ListPredictorsResponse = ListPredictorsResponse' {
- nextToken :: Maybe Text
- predictors :: Maybe [PredictorSummary]
- httpStatus :: Int
- newListPredictorsResponse :: Int -> ListPredictorsResponse
- listPredictorsResponse_nextToken :: Lens' ListPredictorsResponse (Maybe Text)
- listPredictorsResponse_predictors :: Lens' ListPredictorsResponse (Maybe [PredictorSummary])
- listPredictorsResponse_httpStatus :: Lens' ListPredictorsResponse Int
Creating a Request
data ListPredictors Source #
See: newListPredictors smart constructor.
Constructors
| ListPredictors' | |
Fields
| |
Instances
newListPredictors :: ListPredictors Source #
Create a value of ListPredictors with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListPredictors', listPredictors_filters - 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 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 areISandIS_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 areDatasetGroupArnandStatus.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" } ]$sel:nextToken:ListPredictors', listPredictors_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.
$sel:maxResults:ListPredictors', listPredictors_maxResults - The number of items to return in the response.
Request Lenses
listPredictors_filters :: Lens' ListPredictors (Maybe [Filter]) Source #
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 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 areISandIS_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 areDatasetGroupArnandStatus.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" } ]listPredictors_nextToken :: Lens' ListPredictors (Maybe Text) Source #
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.
listPredictors_maxResults :: Lens' ListPredictors (Maybe Natural) Source #
The number of items to return in the response.
Destructuring the Response
data ListPredictorsResponse Source #
See: newListPredictorsResponse smart constructor.
Constructors
| ListPredictorsResponse' | |
Fields
| |
Instances
newListPredictorsResponse Source #
Create a value of ListPredictorsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListPredictors', listPredictorsResponse_nextToken - If the response is truncated, Amazon Forecast returns this token. To
retrieve the next set of results, use the token in the next request.
$sel:predictors:ListPredictorsResponse', listPredictorsResponse_predictors - An array of objects that summarize each predictor's properties.
$sel:httpStatus:ListPredictorsResponse', listPredictorsResponse_httpStatus - The response's http status code.
Response Lenses
listPredictorsResponse_nextToken :: Lens' ListPredictorsResponse (Maybe Text) Source #
If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.
listPredictorsResponse_predictors :: Lens' ListPredictorsResponse (Maybe [PredictorSummary]) Source #
An array of objects that summarize each predictor's properties.
listPredictorsResponse_httpStatus :: Lens' ListPredictorsResponse Int Source #
The response's http status code.