Amazonka.Forecast.ListExplainabilityExports

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.

Creating a Request

data ListExplainabilityExports

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

ToJSON ListExplainabilityExports

Defined in Amazonka.Forecast.ListExplainabilityExports

Methods

toJSON :: ListExplainabilityExports -> Value

toEncoding :: ListExplainabilityExports -> Encoding

toJSONList :: [ListExplainabilityExports] -> Value

toEncodingList :: [ListExplainabilityExports] -> Encoding

ToHeaders ListExplainabilityExports

Defined in Amazonka.Forecast.ListExplainabilityExports

Methods

toHeaders :: ListExplainabilityExports -> [Header]

ToPath ListExplainabilityExports

Defined in Amazonka.Forecast.ListExplainabilityExports

Methods

toPath :: ListExplainabilityExports -> ByteString

ToQuery ListExplainabilityExports

Defined in Amazonka.Forecast.ListExplainabilityExports

Methods

toQuery :: ListExplainabilityExports -> QueryString

AWSPager ListExplainabilityExports

Defined in Amazonka.Forecast.ListExplainabilityExports

Methods

page :: ListExplainabilityExports -> AWSResponse ListExplainabilityExports -> Maybe ListExplainabilityExports

AWSRequest ListExplainabilityExports

Defined in Amazonka.Forecast.ListExplainabilityExports

Associated Types

type AWSResponse ListExplainabilityExports

Methods

request :: (Service -> Service) -> ListExplainabilityExports -> Request ListExplainabilityExports

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListExplainabilityExports -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListExplainabilityExports)))

Generic ListExplainabilityExports

Defined in Amazonka.Forecast.ListExplainabilityExports

Associated Types

type Rep ListExplainabilityExports :: Type -> Type

Methods

from :: ListExplainabilityExports -> Rep ListExplainabilityExports x

to :: Rep ListExplainabilityExports x -> ListExplainabilityExports

Read ListExplainabilityExports

Defined in Amazonka.Forecast.ListExplainabilityExports

Methods

readsPrec :: Int -> ReadS ListExplainabilityExports

readList :: ReadS [ListExplainabilityExports]

readPrec :: ReadPrec ListExplainabilityExports

readListPrec :: ReadPrec [ListExplainabilityExports]

Show ListExplainabilityExports

Defined in Amazonka.Forecast.ListExplainabilityExports

Methods

showsPrec :: Int -> ListExplainabilityExports -> ShowS

show :: ListExplainabilityExports -> String

showList :: [ListExplainabilityExports] -> ShowS

NFData ListExplainabilityExports

Defined in Amazonka.Forecast.ListExplainabilityExports

Methods

rnf :: ListExplainabilityExports -> ()

Eq ListExplainabilityExports

Defined in Amazonka.Forecast.ListExplainabilityExports

Methods

(==) :: ListExplainabilityExports -> ListExplainabilityExports -> Bool

(/=) :: ListExplainabilityExports -> ListExplainabilityExports -> Bool

Hashable ListExplainabilityExports

Defined in Amazonka.Forecast.ListExplainabilityExports

Methods

hashWithSalt :: Int -> ListExplainabilityExports -> Int

hash :: ListExplainabilityExports -> Int

type AWSResponse ListExplainabilityExports

Defined in Amazonka.Forecast.ListExplainabilityExports

type AWSResponse ListExplainabilityExports = ListExplainabilityExportsResponse

type Rep ListExplainabilityExports

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

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])

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)

The number of items to return in the response.

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

Destructuring the Response

data ListExplainabilityExportsResponse

See: newListExplainabilityExportsResponse smart constructor.

Constructors

ListExplainabilityExportsResponse'

Fields

• explainabilityExports :: Maybe [ExplainabilityExportSummary]

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

• nextToken :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListExplainabilityExportsResponse

Defined in Amazonka.Forecast.ListExplainabilityExports

Associated Types

type Rep ListExplainabilityExportsResponse :: Type -> Type

Methods

from :: ListExplainabilityExportsResponse -> Rep ListExplainabilityExportsResponse x

to :: Rep ListExplainabilityExportsResponse x -> ListExplainabilityExportsResponse

Read ListExplainabilityExportsResponse

Defined in Amazonka.Forecast.ListExplainabilityExports

Methods

readsPrec :: Int -> ReadS ListExplainabilityExportsResponse

readList :: ReadS [ListExplainabilityExportsResponse]

readPrec :: ReadPrec ListExplainabilityExportsResponse

readListPrec :: ReadPrec [ListExplainabilityExportsResponse]

Show ListExplainabilityExportsResponse

Defined in Amazonka.Forecast.ListExplainabilityExports

Methods

showsPrec :: Int -> ListExplainabilityExportsResponse -> ShowS

show :: ListExplainabilityExportsResponse -> String

showList :: [ListExplainabilityExportsResponse] -> ShowS

NFData ListExplainabilityExportsResponse

Defined in Amazonka.Forecast.ListExplainabilityExports

Methods

rnf :: ListExplainabilityExportsResponse -> ()

Eq ListExplainabilityExportsResponse

Defined in Amazonka.Forecast.ListExplainabilityExports

Methods

(==) :: ListExplainabilityExportsResponse -> ListExplainabilityExportsResponse -> Bool

(/=) :: ListExplainabilityExportsResponse -> ListExplainabilityExportsResponse -> Bool

type Rep ListExplainabilityExportsResponse

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

Arguments

:: Int

$sel:httpStatus:ListExplainabilityExportsResponse'

-> ListExplainabilityExportsResponse

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])

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

listExplainabilityExportsResponse_nextToken :: Lens' ListExplainabilityExportsResponse (Maybe Text)

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

listExplainabilityExportsResponse_httpStatus :: Lens' ListExplainabilityExportsResponse Int

The response's http status code.