Amazonka.Forecast.ListExplainabilities

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

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

This operation returns paginated results.

Creating a Request

data ListExplainabilities

See: newListExplainabilities smart constructor.

Constructors

ListExplainabilities'

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 the 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 returned 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 ListExplainabilities

Defined in Amazonka.Forecast.ListExplainabilities

Methods

toJSON :: ListExplainabilities -> Value

toEncoding :: ListExplainabilities -> Encoding

toJSONList :: [ListExplainabilities] -> Value

toEncodingList :: [ListExplainabilities] -> Encoding

ToHeaders ListExplainabilities

Defined in Amazonka.Forecast.ListExplainabilities

Methods

toHeaders :: ListExplainabilities -> [Header]

ToPath ListExplainabilities

Defined in Amazonka.Forecast.ListExplainabilities

Methods

toPath :: ListExplainabilities -> ByteString

ToQuery ListExplainabilities

Defined in Amazonka.Forecast.ListExplainabilities

Methods

toQuery :: ListExplainabilities -> QueryString

AWSPager ListExplainabilities

Defined in Amazonka.Forecast.ListExplainabilities

Methods

page :: ListExplainabilities -> AWSResponse ListExplainabilities -> Maybe ListExplainabilities

AWSRequest ListExplainabilities

Defined in Amazonka.Forecast.ListExplainabilities

Associated Types

type AWSResponse ListExplainabilities

Methods

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

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

Generic ListExplainabilities

Defined in Amazonka.Forecast.ListExplainabilities

Associated Types

type Rep ListExplainabilities :: Type -> Type

Methods

from :: ListExplainabilities -> Rep ListExplainabilities x

to :: Rep ListExplainabilities x -> ListExplainabilities

Read ListExplainabilities

Defined in Amazonka.Forecast.ListExplainabilities

Methods

readsPrec :: Int -> ReadS ListExplainabilities

readList :: ReadS [ListExplainabilities]

readPrec :: ReadPrec ListExplainabilities

readListPrec :: ReadPrec [ListExplainabilities]

Show ListExplainabilities

Defined in Amazonka.Forecast.ListExplainabilities

Methods

showsPrec :: Int -> ListExplainabilities -> ShowS

show :: ListExplainabilities -> String

showList :: [ListExplainabilities] -> ShowS

NFData ListExplainabilities

Defined in Amazonka.Forecast.ListExplainabilities

Methods

rnf :: ListExplainabilities -> ()

Eq ListExplainabilities

Defined in Amazonka.Forecast.ListExplainabilities

Methods

(==) :: ListExplainabilities -> ListExplainabilities -> Bool

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

Hashable ListExplainabilities

Defined in Amazonka.Forecast.ListExplainabilities

Methods

hashWithSalt :: Int -> ListExplainabilities -> Int

hash :: ListExplainabilities -> Int

type AWSResponse ListExplainabilities

Defined in Amazonka.Forecast.ListExplainabilities

type AWSResponse ListExplainabilities = ListExplainabilitiesResponse

type Rep ListExplainabilities

Defined in Amazonka.Forecast.ListExplainabilities

type Rep ListExplainabilities = D1 ('MetaData "ListExplainabilities" "Amazonka.Forecast.ListExplainabilities" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "ListExplainabilities'" '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)))))

newListExplainabilities :: ListExplainabilities

Create a value of ListExplainabilities 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:ListExplainabilities', listExplainabilities_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 the 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:ListExplainabilities', listExplainabilities_maxResults - The number of items returned in the response.

ListExplainabilities, listExplainabilities_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

listExplainabilities_filters :: Lens' ListExplainabilities (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 the 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.

listExplainabilities_maxResults :: Lens' ListExplainabilities (Maybe Natural)

The number of items returned in the response.

listExplainabilities_nextToken :: Lens' ListExplainabilities (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 ListExplainabilitiesResponse

See: newListExplainabilitiesResponse smart constructor.

Constructors

ListExplainabilitiesResponse'

Fields

• explainabilities :: Maybe [ExplainabilitySummary]

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

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

Defined in Amazonka.Forecast.ListExplainabilities

Associated Types

type Rep ListExplainabilitiesResponse :: Type -> Type

Methods

from :: ListExplainabilitiesResponse -> Rep ListExplainabilitiesResponse x

to :: Rep ListExplainabilitiesResponse x -> ListExplainabilitiesResponse

Read ListExplainabilitiesResponse

Defined in Amazonka.Forecast.ListExplainabilities

Methods

readsPrec :: Int -> ReadS ListExplainabilitiesResponse

readList :: ReadS [ListExplainabilitiesResponse]

readPrec :: ReadPrec ListExplainabilitiesResponse

readListPrec :: ReadPrec [ListExplainabilitiesResponse]

Show ListExplainabilitiesResponse

Defined in Amazonka.Forecast.ListExplainabilities

Methods

showsPrec :: Int -> ListExplainabilitiesResponse -> ShowS

show :: ListExplainabilitiesResponse -> String

showList :: [ListExplainabilitiesResponse] -> ShowS

NFData ListExplainabilitiesResponse

Defined in Amazonka.Forecast.ListExplainabilities

Methods

rnf :: ListExplainabilitiesResponse -> ()

Eq ListExplainabilitiesResponse

Defined in Amazonka.Forecast.ListExplainabilities

Methods

(==) :: ListExplainabilitiesResponse -> ListExplainabilitiesResponse -> Bool

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

type Rep ListExplainabilitiesResponse

Defined in Amazonka.Forecast.ListExplainabilities

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

newListExplainabilitiesResponse

Arguments

:: Int

$sel:httpStatus:ListExplainabilitiesResponse'

-> ListExplainabilitiesResponse

Create a value of ListExplainabilitiesResponse 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:explainabilities:ListExplainabilitiesResponse', listExplainabilitiesResponse_explainabilities - An array of objects that summarize the properties of each Explainability resource.

ListExplainabilities, listExplainabilitiesResponse_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:ListExplainabilitiesResponse', listExplainabilitiesResponse_httpStatus - The response's http status code.

Response Lenses

listExplainabilitiesResponse_explainabilities :: Lens' ListExplainabilitiesResponse (Maybe [ExplainabilitySummary])

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

listExplainabilitiesResponse_nextToken :: Lens' ListExplainabilitiesResponse (Maybe Text)

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

listExplainabilitiesResponse_httpStatus :: Lens' ListExplainabilitiesResponse Int

The response's http status code.