| 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 |
Amazonka.SageMaker.ListModelExplainabilityJobDefinitions
Description
Lists model explainability job definitions that satisfy various filters.
This operation returns paginated results.
Synopsis
- data ListModelExplainabilityJobDefinitions = ListModelExplainabilityJobDefinitions' {}
- newListModelExplainabilityJobDefinitions :: ListModelExplainabilityJobDefinitions
- listModelExplainabilityJobDefinitions_creationTimeAfter :: Lens' ListModelExplainabilityJobDefinitions (Maybe UTCTime)
- listModelExplainabilityJobDefinitions_creationTimeBefore :: Lens' ListModelExplainabilityJobDefinitions (Maybe UTCTime)
- listModelExplainabilityJobDefinitions_endpointName :: Lens' ListModelExplainabilityJobDefinitions (Maybe Text)
- listModelExplainabilityJobDefinitions_maxResults :: Lens' ListModelExplainabilityJobDefinitions (Maybe Natural)
- listModelExplainabilityJobDefinitions_nameContains :: Lens' ListModelExplainabilityJobDefinitions (Maybe Text)
- listModelExplainabilityJobDefinitions_nextToken :: Lens' ListModelExplainabilityJobDefinitions (Maybe Text)
- listModelExplainabilityJobDefinitions_sortBy :: Lens' ListModelExplainabilityJobDefinitions (Maybe MonitoringJobDefinitionSortKey)
- listModelExplainabilityJobDefinitions_sortOrder :: Lens' ListModelExplainabilityJobDefinitions (Maybe SortOrder)
- data ListModelExplainabilityJobDefinitionsResponse = ListModelExplainabilityJobDefinitionsResponse' {}
- newListModelExplainabilityJobDefinitionsResponse :: Int -> ListModelExplainabilityJobDefinitionsResponse
- listModelExplainabilityJobDefinitionsResponse_nextToken :: Lens' ListModelExplainabilityJobDefinitionsResponse (Maybe Text)
- listModelExplainabilityJobDefinitionsResponse_httpStatus :: Lens' ListModelExplainabilityJobDefinitionsResponse Int
- listModelExplainabilityJobDefinitionsResponse_jobDefinitionSummaries :: Lens' ListModelExplainabilityJobDefinitionsResponse [MonitoringJobDefinitionSummary]
Creating a Request
data ListModelExplainabilityJobDefinitions Source #
See: newListModelExplainabilityJobDefinitions smart constructor.
Constructors
| ListModelExplainabilityJobDefinitions' | |
Fields
| |
Instances
newListModelExplainabilityJobDefinitions :: ListModelExplainabilityJobDefinitions Source #
Create a value of ListModelExplainabilityJobDefinitions 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:creationTimeAfter:ListModelExplainabilityJobDefinitions', listModelExplainabilityJobDefinitions_creationTimeAfter - A filter that returns only model explainability jobs created after a
specified time.
$sel:creationTimeBefore:ListModelExplainabilityJobDefinitions', listModelExplainabilityJobDefinitions_creationTimeBefore - A filter that returns only model explainability jobs created before a
specified time.
ListModelExplainabilityJobDefinitions, listModelExplainabilityJobDefinitions_endpointName - Name of the endpoint to monitor for model explainability.
$sel:maxResults:ListModelExplainabilityJobDefinitions', listModelExplainabilityJobDefinitions_maxResults - The maximum number of jobs to return in the response. The default value
is 10.
$sel:nameContains:ListModelExplainabilityJobDefinitions', listModelExplainabilityJobDefinitions_nameContains - Filter for model explainability jobs whose name contains a specified
string.
ListModelExplainabilityJobDefinitions, listModelExplainabilityJobDefinitions_nextToken - The token returned if the response is truncated. To retrieve the next
set of job executions, use it in the next request.
$sel:sortBy:ListModelExplainabilityJobDefinitions', listModelExplainabilityJobDefinitions_sortBy - Whether to sort results by the Name or CreationTime field. The
default is CreationTime.
$sel:sortOrder:ListModelExplainabilityJobDefinitions', listModelExplainabilityJobDefinitions_sortOrder - Whether to sort the results in Ascending or Descending order. The
default is Descending.
Request Lenses
listModelExplainabilityJobDefinitions_creationTimeAfter :: Lens' ListModelExplainabilityJobDefinitions (Maybe UTCTime) Source #
A filter that returns only model explainability jobs created after a specified time.
listModelExplainabilityJobDefinitions_creationTimeBefore :: Lens' ListModelExplainabilityJobDefinitions (Maybe UTCTime) Source #
A filter that returns only model explainability jobs created before a specified time.
listModelExplainabilityJobDefinitions_endpointName :: Lens' ListModelExplainabilityJobDefinitions (Maybe Text) Source #
Name of the endpoint to monitor for model explainability.
listModelExplainabilityJobDefinitions_maxResults :: Lens' ListModelExplainabilityJobDefinitions (Maybe Natural) Source #
The maximum number of jobs to return in the response. The default value is 10.
listModelExplainabilityJobDefinitions_nameContains :: Lens' ListModelExplainabilityJobDefinitions (Maybe Text) Source #
Filter for model explainability jobs whose name contains a specified string.
listModelExplainabilityJobDefinitions_nextToken :: Lens' ListModelExplainabilityJobDefinitions (Maybe Text) Source #
The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
listModelExplainabilityJobDefinitions_sortBy :: Lens' ListModelExplainabilityJobDefinitions (Maybe MonitoringJobDefinitionSortKey) Source #
Whether to sort results by the Name or CreationTime field. The
default is CreationTime.
listModelExplainabilityJobDefinitions_sortOrder :: Lens' ListModelExplainabilityJobDefinitions (Maybe SortOrder) Source #
Whether to sort the results in Ascending or Descending order. The
default is Descending.
Destructuring the Response
data ListModelExplainabilityJobDefinitionsResponse Source #
See: newListModelExplainabilityJobDefinitionsResponse smart constructor.
Constructors
| ListModelExplainabilityJobDefinitionsResponse' | |
Fields
| |
Instances
newListModelExplainabilityJobDefinitionsResponse Source #
Arguments
| :: Int |
|
| -> ListModelExplainabilityJobDefinitionsResponse |
Create a value of ListModelExplainabilityJobDefinitionsResponse 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:
ListModelExplainabilityJobDefinitions, listModelExplainabilityJobDefinitionsResponse_nextToken - If the response is truncated, Amazon SageMaker returns this token. To
retrieve the next set of jobs, use it in the subsequent request.
$sel:httpStatus:ListModelExplainabilityJobDefinitionsResponse', listModelExplainabilityJobDefinitionsResponse_httpStatus - The response's http status code.
$sel:jobDefinitionSummaries:ListModelExplainabilityJobDefinitionsResponse', listModelExplainabilityJobDefinitionsResponse_jobDefinitionSummaries - A JSON array in which each element is a summary for a explainability
bias jobs.
Response Lenses
listModelExplainabilityJobDefinitionsResponse_nextToken :: Lens' ListModelExplainabilityJobDefinitionsResponse (Maybe Text) Source #
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent request.
listModelExplainabilityJobDefinitionsResponse_httpStatus :: Lens' ListModelExplainabilityJobDefinitionsResponse Int Source #
The response's http status code.
listModelExplainabilityJobDefinitionsResponse_jobDefinitionSummaries :: Lens' ListModelExplainabilityJobDefinitionsResponse [MonitoringJobDefinitionSummary] Source #
A JSON array in which each element is a summary for a explainability bias jobs.