| 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.ListTrainingJobs
Description
Lists training jobs.
When StatusEquals and MaxResults are set at the same time, the
MaxResults number of training jobs are first retrieved ignoring the
StatusEquals parameter and then they are filtered by the
StatusEquals parameter, which is returned as a response.
For example, if ListTrainingJobs is invoked with the following
parameters:
{ ... MaxResults: 100, StatusEquals: InProgress ... }First, 100 trainings jobs with any status, including those other than
InProgress, are selected (sorted according to the creation time, from
the most current to the oldest). Next, those with a status of
InProgress are returned.
You can quickly test the API using the following Amazon Web Services CLI code.
aws sagemaker list-training-jobs --max-results 100 --status-equals InProgress
This operation returns paginated results.
Synopsis
- data ListTrainingJobs = ListTrainingJobs' {
- creationTimeAfter :: Maybe POSIX
- creationTimeBefore :: Maybe POSIX
- lastModifiedTimeAfter :: Maybe POSIX
- lastModifiedTimeBefore :: Maybe POSIX
- maxResults :: Maybe Natural
- nameContains :: Maybe Text
- nextToken :: Maybe Text
- sortBy :: Maybe SortBy
- sortOrder :: Maybe SortOrder
- statusEquals :: Maybe TrainingJobStatus
- warmPoolStatusEquals :: Maybe WarmPoolResourceStatus
- newListTrainingJobs :: ListTrainingJobs
- listTrainingJobs_creationTimeAfter :: Lens' ListTrainingJobs (Maybe UTCTime)
- listTrainingJobs_creationTimeBefore :: Lens' ListTrainingJobs (Maybe UTCTime)
- listTrainingJobs_lastModifiedTimeAfter :: Lens' ListTrainingJobs (Maybe UTCTime)
- listTrainingJobs_lastModifiedTimeBefore :: Lens' ListTrainingJobs (Maybe UTCTime)
- listTrainingJobs_maxResults :: Lens' ListTrainingJobs (Maybe Natural)
- listTrainingJobs_nameContains :: Lens' ListTrainingJobs (Maybe Text)
- listTrainingJobs_nextToken :: Lens' ListTrainingJobs (Maybe Text)
- listTrainingJobs_sortBy :: Lens' ListTrainingJobs (Maybe SortBy)
- listTrainingJobs_sortOrder :: Lens' ListTrainingJobs (Maybe SortOrder)
- listTrainingJobs_statusEquals :: Lens' ListTrainingJobs (Maybe TrainingJobStatus)
- listTrainingJobs_warmPoolStatusEquals :: Lens' ListTrainingJobs (Maybe WarmPoolResourceStatus)
- data ListTrainingJobsResponse = ListTrainingJobsResponse' {}
- newListTrainingJobsResponse :: Int -> ListTrainingJobsResponse
- listTrainingJobsResponse_nextToken :: Lens' ListTrainingJobsResponse (Maybe Text)
- listTrainingJobsResponse_httpStatus :: Lens' ListTrainingJobsResponse Int
- listTrainingJobsResponse_trainingJobSummaries :: Lens' ListTrainingJobsResponse [TrainingJobSummary]
Creating a Request
data ListTrainingJobs Source #
See: newListTrainingJobs smart constructor.
Constructors
| ListTrainingJobs' | |
Fields
| |
Instances
newListTrainingJobs :: ListTrainingJobs Source #
Create a value of ListTrainingJobs 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:ListTrainingJobs', listTrainingJobs_creationTimeAfter - A filter that returns only training jobs created after the specified
time (timestamp).
$sel:creationTimeBefore:ListTrainingJobs', listTrainingJobs_creationTimeBefore - A filter that returns only training jobs created before the specified
time (timestamp).
$sel:lastModifiedTimeAfter:ListTrainingJobs', listTrainingJobs_lastModifiedTimeAfter - A filter that returns only training jobs modified after the specified
time (timestamp).
$sel:lastModifiedTimeBefore:ListTrainingJobs', listTrainingJobs_lastModifiedTimeBefore - A filter that returns only training jobs modified before the specified
time (timestamp).
$sel:maxResults:ListTrainingJobs', listTrainingJobs_maxResults - The maximum number of training jobs to return in the response.
$sel:nameContains:ListTrainingJobs', listTrainingJobs_nameContains - A string in the training job name. This filter returns only training
jobs whose name contains the specified string.
ListTrainingJobs, listTrainingJobs_nextToken - If the result of the previous ListTrainingJobs request was truncated,
the response includes a NextToken. To retrieve the next set of
training jobs, use the token in the next request.
$sel:sortBy:ListTrainingJobs', listTrainingJobs_sortBy - The field to sort results by. The default is CreationTime.
$sel:sortOrder:ListTrainingJobs', listTrainingJobs_sortOrder - The sort order for results. The default is Ascending.
$sel:statusEquals:ListTrainingJobs', listTrainingJobs_statusEquals - A filter that retrieves only training jobs with a specific status.
$sel:warmPoolStatusEquals:ListTrainingJobs', listTrainingJobs_warmPoolStatusEquals - A filter that retrieves only training jobs with a specific warm pool
status.
Request Lenses
listTrainingJobs_creationTimeAfter :: Lens' ListTrainingJobs (Maybe UTCTime) Source #
A filter that returns only training jobs created after the specified time (timestamp).
listTrainingJobs_creationTimeBefore :: Lens' ListTrainingJobs (Maybe UTCTime) Source #
A filter that returns only training jobs created before the specified time (timestamp).
listTrainingJobs_lastModifiedTimeAfter :: Lens' ListTrainingJobs (Maybe UTCTime) Source #
A filter that returns only training jobs modified after the specified time (timestamp).
listTrainingJobs_lastModifiedTimeBefore :: Lens' ListTrainingJobs (Maybe UTCTime) Source #
A filter that returns only training jobs modified before the specified time (timestamp).
listTrainingJobs_maxResults :: Lens' ListTrainingJobs (Maybe Natural) Source #
The maximum number of training jobs to return in the response.
listTrainingJobs_nameContains :: Lens' ListTrainingJobs (Maybe Text) Source #
A string in the training job name. This filter returns only training jobs whose name contains the specified string.
listTrainingJobs_nextToken :: Lens' ListTrainingJobs (Maybe Text) Source #
If the result of the previous ListTrainingJobs request was truncated,
the response includes a NextToken. To retrieve the next set of
training jobs, use the token in the next request.
listTrainingJobs_sortBy :: Lens' ListTrainingJobs (Maybe SortBy) Source #
The field to sort results by. The default is CreationTime.
listTrainingJobs_sortOrder :: Lens' ListTrainingJobs (Maybe SortOrder) Source #
The sort order for results. The default is Ascending.
listTrainingJobs_statusEquals :: Lens' ListTrainingJobs (Maybe TrainingJobStatus) Source #
A filter that retrieves only training jobs with a specific status.
listTrainingJobs_warmPoolStatusEquals :: Lens' ListTrainingJobs (Maybe WarmPoolResourceStatus) Source #
A filter that retrieves only training jobs with a specific warm pool status.
Destructuring the Response
data ListTrainingJobsResponse Source #
See: newListTrainingJobsResponse smart constructor.
Constructors
| ListTrainingJobsResponse' | |
Fields
| |
Instances
newListTrainingJobsResponse Source #
Create a value of ListTrainingJobsResponse 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:
ListTrainingJobs, listTrainingJobsResponse_nextToken - If the response is truncated, SageMaker returns this token. To retrieve
the next set of training jobs, use it in the subsequent request.
$sel:httpStatus:ListTrainingJobsResponse', listTrainingJobsResponse_httpStatus - The response's http status code.
$sel:trainingJobSummaries:ListTrainingJobsResponse', listTrainingJobsResponse_trainingJobSummaries - An array of TrainingJobSummary objects, each listing a training job.
Response Lenses
listTrainingJobsResponse_nextToken :: Lens' ListTrainingJobsResponse (Maybe Text) Source #
If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.
listTrainingJobsResponse_httpStatus :: Lens' ListTrainingJobsResponse Int Source #
The response's http status code.
listTrainingJobsResponse_trainingJobSummaries :: Lens' ListTrainingJobsResponse [TrainingJobSummary] Source #
An array of TrainingJobSummary objects, each listing a training job.