Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
Synopsis
- data ListExplainabilities = ListExplainabilities' {}
- newListExplainabilities :: ListExplainabilities
- listExplainabilities_filters :: Lens' ListExplainabilities (Maybe [Filter])
- listExplainabilities_maxResults :: Lens' ListExplainabilities (Maybe Natural)
- listExplainabilities_nextToken :: Lens' ListExplainabilities (Maybe Text)
- data ListExplainabilitiesResponse = ListExplainabilitiesResponse' {}
- newListExplainabilitiesResponse :: Int -> ListExplainabilitiesResponse
- listExplainabilitiesResponse_explainabilities :: Lens' ListExplainabilitiesResponse (Maybe [ExplainabilitySummary])
- listExplainabilitiesResponse_nextToken :: Lens' ListExplainabilitiesResponse (Maybe Text)
- listExplainabilitiesResponse_httpStatus :: Lens' ListExplainabilitiesResponse Int
Creating a Request
data ListExplainabilities Source #
See: newListExplainabilities
smart constructor.
ListExplainabilities' | |
|
Instances
newListExplainabilities :: ListExplainabilities Source #
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 areIS
andIS_NOT
.Key
- The name of the parameter to filter on. Valid values areResourceArn
andStatus
.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]) 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 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 areIS
andIS_NOT
.Key
- The name of the parameter to filter on. Valid values areResourceArn
andStatus
.Value
- The value to match.
listExplainabilities_maxResults :: Lens' ListExplainabilities (Maybe Natural) Source #
The number of items returned in the response.
listExplainabilities_nextToken :: Lens' ListExplainabilities (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 ListExplainabilitiesResponse Source #
See: newListExplainabilitiesResponse
smart constructor.
ListExplainabilitiesResponse' | |
|
Instances
newListExplainabilitiesResponse Source #
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]) Source #
An array of objects that summarize the properties of each Explainability resource.
listExplainabilitiesResponse_nextToken :: Lens' ListExplainabilitiesResponse (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.
listExplainabilitiesResponse_httpStatus :: Lens' ListExplainabilitiesResponse Int Source #
The response's http status code.