amazonka-forecast-2.0: Amazon Forecast Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Forecast.ListExplainabilityExports

Description

Returns a list of Explainability exports created using the CreateExplainabilityExport operation. This operation returns a summary for each Explainability export. You can filter the list using an array of Filter objects.

To retrieve the complete set of properties for a particular Explainability export, use the ARN with the DescribeExplainability operation.

This operation returns paginated results.

Synopsis

Creating a Request

data ListExplainabilityExports Source #

See: newListExplainabilityExports smart constructor.

Constructors

ListExplainabilityExports' 

Fields

  • filters :: Maybe [Filter]

    An array of filters. For each filter, provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude resources that match the statement from the list. The match statement consists of a key and a value.

    Filter properties

    • Condition - The condition to apply. Valid values are IS and IS_NOT.
    • Key - The name of the parameter to filter on. Valid values are ResourceArn and Status.
    • Value - The value to match.
  • maxResults :: Maybe Natural

    The number of items to return in the response.

  • 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.

Instances

Instances details
ToJSON ListExplainabilityExports Source # 
Instance details

Defined in Amazonka.Forecast.ListExplainabilityExports

ToHeaders ListExplainabilityExports Source # 
Instance details

Defined in Amazonka.Forecast.ListExplainabilityExports

ToPath ListExplainabilityExports Source # 
Instance details

Defined in Amazonka.Forecast.ListExplainabilityExports

ToQuery ListExplainabilityExports Source # 
Instance details

Defined in Amazonka.Forecast.ListExplainabilityExports

AWSPager ListExplainabilityExports Source # 
Instance details

Defined in Amazonka.Forecast.ListExplainabilityExports

AWSRequest ListExplainabilityExports Source # 
Instance details

Defined in Amazonka.Forecast.ListExplainabilityExports

Generic ListExplainabilityExports Source # 
Instance details

Defined in Amazonka.Forecast.ListExplainabilityExports

Associated Types

type Rep ListExplainabilityExports :: Type -> Type #

Read ListExplainabilityExports Source # 
Instance details

Defined in Amazonka.Forecast.ListExplainabilityExports

Show ListExplainabilityExports Source # 
Instance details

Defined in Amazonka.Forecast.ListExplainabilityExports

NFData ListExplainabilityExports Source # 
Instance details

Defined in Amazonka.Forecast.ListExplainabilityExports

Eq ListExplainabilityExports Source # 
Instance details

Defined in Amazonka.Forecast.ListExplainabilityExports

Hashable ListExplainabilityExports Source # 
Instance details

Defined in Amazonka.Forecast.ListExplainabilityExports

type AWSResponse ListExplainabilityExports Source # 
Instance details

Defined in Amazonka.Forecast.ListExplainabilityExports

type Rep ListExplainabilityExports Source # 
Instance details

Defined in Amazonka.Forecast.ListExplainabilityExports

type Rep ListExplainabilityExports = D1 ('MetaData "ListExplainabilityExports" "Amazonka.Forecast.ListExplainabilityExports" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "ListExplainabilityExports'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListExplainabilityExports :: ListExplainabilityExports Source #

Create a value of ListExplainabilityExports 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:ListExplainabilityExports', listExplainabilityExports_filters - An array of filters. For each filter, provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude resources that match the statement from the list. The match statement consists of a key and a value.

Filter properties

  • Condition - The condition to apply. Valid values are IS and IS_NOT.
  • Key - The name of the parameter to filter on. Valid values are ResourceArn and Status.
  • Value - The value to match.

$sel:maxResults:ListExplainabilityExports', listExplainabilityExports_maxResults - The number of items to return in the response.

ListExplainabilityExports, listExplainabilityExports_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.

Request Lenses

listExplainabilityExports_filters :: Lens' ListExplainabilityExports (Maybe [Filter]) Source #

An array of filters. For each filter, provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude resources that match the statement from the list. The match statement consists of a key and a value.

Filter properties

  • Condition - The condition to apply. Valid values are IS and IS_NOT.
  • Key - The name of the parameter to filter on. Valid values are ResourceArn and Status.
  • Value - The value to match.

listExplainabilityExports_maxResults :: Lens' ListExplainabilityExports (Maybe Natural) Source #

The number of items to return in the response.

listExplainabilityExports_nextToken :: Lens' ListExplainabilityExports (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.

Destructuring the Response

data ListExplainabilityExportsResponse Source #

See: newListExplainabilityExportsResponse smart constructor.

Constructors

ListExplainabilityExportsResponse' 

Fields

Instances

Instances details
Generic ListExplainabilityExportsResponse Source # 
Instance details

Defined in Amazonka.Forecast.ListExplainabilityExports

Associated Types

type Rep ListExplainabilityExportsResponse :: Type -> Type #

Read ListExplainabilityExportsResponse Source # 
Instance details

Defined in Amazonka.Forecast.ListExplainabilityExports

Show ListExplainabilityExportsResponse Source # 
Instance details

Defined in Amazonka.Forecast.ListExplainabilityExports

NFData ListExplainabilityExportsResponse Source # 
Instance details

Defined in Amazonka.Forecast.ListExplainabilityExports

Eq ListExplainabilityExportsResponse Source # 
Instance details

Defined in Amazonka.Forecast.ListExplainabilityExports

type Rep ListExplainabilityExportsResponse Source # 
Instance details

Defined in Amazonka.Forecast.ListExplainabilityExports

type Rep ListExplainabilityExportsResponse = D1 ('MetaData "ListExplainabilityExportsResponse" "Amazonka.Forecast.ListExplainabilityExports" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "ListExplainabilityExportsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "explainabilityExports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ExplainabilityExportSummary])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListExplainabilityExportsResponse Source #

Create a value of ListExplainabilityExportsResponse 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:explainabilityExports:ListExplainabilityExportsResponse', listExplainabilityExportsResponse_explainabilityExports - An array of objects that summarize the properties of each Explainability export.

ListExplainabilityExports, listExplainabilityExportsResponse_nextToken - Returns this token if the response is truncated. To retrieve the next set of results, use the token in the next request.

$sel:httpStatus:ListExplainabilityExportsResponse', listExplainabilityExportsResponse_httpStatus - The response's http status code.

Response Lenses

listExplainabilityExportsResponse_explainabilityExports :: Lens' ListExplainabilityExportsResponse (Maybe [ExplainabilityExportSummary]) Source #

An array of objects that summarize the properties of each Explainability export.

listExplainabilityExportsResponse_nextToken :: Lens' ListExplainabilityExportsResponse (Maybe Text) Source #

Returns this token if the response is truncated. To retrieve the next set of results, use the token in the next request.