libZSservicesZSamazonka-forecastZSamazonka-forecast
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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

Creating a Request

data ListPredictors Source #

See: newListPredictors smart constructor.

Constructors

ListPredictors' 

Fields

  • filters :: Maybe [Filter]

    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 are IS and IS_NOT. To include the predictors that match the statement, specify IS. To exclude matching predictors, specify IS_NOT.
    • Key - The name of the parameter to filter on. Valid values are DatasetGroupArn and Status.
    • 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" } ]
  • nextToken :: Maybe Text

    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 :: Maybe Natural

    The number of items to return in the response.

Instances

Instances details
Eq ListPredictors Source # 
Instance details

Defined in Amazonka.Forecast.ListPredictors

Read ListPredictors Source # 
Instance details

Defined in Amazonka.Forecast.ListPredictors

Show ListPredictors Source # 
Instance details

Defined in Amazonka.Forecast.ListPredictors

Generic ListPredictors Source # 
Instance details

Defined in Amazonka.Forecast.ListPredictors

Associated Types

type Rep ListPredictors :: Type -> Type #

NFData ListPredictors Source # 
Instance details

Defined in Amazonka.Forecast.ListPredictors

Methods

rnf :: ListPredictors -> () #

Hashable ListPredictors Source # 
Instance details

Defined in Amazonka.Forecast.ListPredictors

ToJSON ListPredictors Source # 
Instance details

Defined in Amazonka.Forecast.ListPredictors

AWSPager ListPredictors Source # 
Instance details

Defined in Amazonka.Forecast.ListPredictors

AWSRequest ListPredictors Source # 
Instance details

Defined in Amazonka.Forecast.ListPredictors

Associated Types

type AWSResponse ListPredictors #

ToHeaders ListPredictors Source # 
Instance details

Defined in Amazonka.Forecast.ListPredictors

ToPath ListPredictors Source # 
Instance details

Defined in Amazonka.Forecast.ListPredictors

ToQuery ListPredictors Source # 
Instance details

Defined in Amazonka.Forecast.ListPredictors

type Rep ListPredictors Source # 
Instance details

Defined in Amazonka.Forecast.ListPredictors

type Rep ListPredictors = D1 ('MetaData "ListPredictors" "Amazonka.Forecast.ListPredictors" "libZSservicesZSamazonka-forecastZSamazonka-forecast" 'False) (C1 ('MetaCons "ListPredictors'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListPredictors Source # 
Instance details

Defined in Amazonka.Forecast.ListPredictors

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 are IS and IS_NOT. To include the predictors that match the statement, specify IS. To exclude matching predictors, specify IS_NOT.
  • Key - The name of the parameter to filter on. Valid values are DatasetGroupArn and Status.
  • 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 are IS and IS_NOT. To include the predictors that match the statement, specify IS. To exclude matching predictors, specify IS_NOT.
  • Key - The name of the parameter to filter on. Valid values are DatasetGroupArn and Status.
  • 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

  • nextToken :: Maybe Text

    If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

  • predictors :: Maybe [PredictorSummary]

    An array of objects that summarize each predictor's properties.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListPredictorsResponse Source # 
Instance details

Defined in Amazonka.Forecast.ListPredictors

Read ListPredictorsResponse Source # 
Instance details

Defined in Amazonka.Forecast.ListPredictors

Show ListPredictorsResponse Source # 
Instance details

Defined in Amazonka.Forecast.ListPredictors

Generic ListPredictorsResponse Source # 
Instance details

Defined in Amazonka.Forecast.ListPredictors

Associated Types

type Rep ListPredictorsResponse :: Type -> Type #

NFData ListPredictorsResponse Source # 
Instance details

Defined in Amazonka.Forecast.ListPredictors

Methods

rnf :: ListPredictorsResponse -> () #

type Rep ListPredictorsResponse Source # 
Instance details

Defined in Amazonka.Forecast.ListPredictors

type Rep ListPredictorsResponse = D1 ('MetaData "ListPredictorsResponse" "Amazonka.Forecast.ListPredictors" "libZSservicesZSamazonka-forecastZSamazonka-forecast" 'False) (C1 ('MetaCons "ListPredictorsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "predictors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PredictorSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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.