libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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

Creating a Request

data ListTrainingJobs Source #

See: newListTrainingJobs smart constructor.

Constructors

ListTrainingJobs' 

Fields

Instances

Instances details
Eq ListTrainingJobs Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrainingJobs

Read ListTrainingJobs Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrainingJobs

Show ListTrainingJobs Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrainingJobs

Generic ListTrainingJobs Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrainingJobs

Associated Types

type Rep ListTrainingJobs :: Type -> Type #

NFData ListTrainingJobs Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrainingJobs

Methods

rnf :: ListTrainingJobs -> () #

Hashable ListTrainingJobs Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrainingJobs

ToJSON ListTrainingJobs Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrainingJobs

AWSPager ListTrainingJobs Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrainingJobs

AWSRequest ListTrainingJobs Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrainingJobs

Associated Types

type AWSResponse ListTrainingJobs #

ToHeaders ListTrainingJobs Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrainingJobs

ToPath ListTrainingJobs Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrainingJobs

ToQuery ListTrainingJobs Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrainingJobs

type Rep ListTrainingJobs Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrainingJobs

type AWSResponse ListTrainingJobs Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrainingJobs

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:nameContains:ListTrainingJobs', listTrainingJobs_nameContains - A string in the training job name. This filter returns only training jobs whose name contains the specified string.

$sel:lastModifiedTimeBefore:ListTrainingJobs', listTrainingJobs_lastModifiedTimeBefore - A filter that returns only training jobs modified before the specified time (timestamp).

$sel:creationTimeAfter:ListTrainingJobs', listTrainingJobs_creationTimeAfter - A filter that returns only training jobs created after the specified time (timestamp).

$sel:nextToken: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:sortOrder:ListTrainingJobs', listTrainingJobs_sortOrder - The sort order for results. The default is Ascending.

$sel:lastModifiedTimeAfter:ListTrainingJobs', listTrainingJobs_lastModifiedTimeAfter - A filter that returns only training jobs modified after the specified time (timestamp).

$sel:creationTimeBefore:ListTrainingJobs', listTrainingJobs_creationTimeBefore - A filter that returns only training jobs created before the specified time (timestamp).

$sel:statusEquals:ListTrainingJobs', listTrainingJobs_statusEquals - A filter that retrieves only training jobs with a specific status.

$sel:maxResults:ListTrainingJobs', listTrainingJobs_maxResults - The maximum number of training jobs to return in the response.

$sel:sortBy:ListTrainingJobs', listTrainingJobs_sortBy - The field to sort results by. The default is CreationTime.

Request Lenses

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_lastModifiedTimeBefore :: Lens' ListTrainingJobs (Maybe UTCTime) Source #

A filter that returns only training jobs modified before the specified time (timestamp).

listTrainingJobs_creationTimeAfter :: Lens' ListTrainingJobs (Maybe UTCTime) Source #

A filter that returns only training jobs created after the specified time (timestamp).

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_sortOrder :: Lens' ListTrainingJobs (Maybe SortOrder) Source #

The sort order for results. The default is Ascending.

listTrainingJobs_lastModifiedTimeAfter :: Lens' ListTrainingJobs (Maybe UTCTime) Source #

A filter that returns only training jobs modified 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_statusEquals :: Lens' ListTrainingJobs (Maybe TrainingJobStatus) Source #

A filter that retrieves only training jobs with a specific status.

listTrainingJobs_maxResults :: Lens' ListTrainingJobs (Maybe Natural) Source #

The maximum number of training jobs to return in the response.

listTrainingJobs_sortBy :: Lens' ListTrainingJobs (Maybe SortBy) Source #

The field to sort results by. The default is CreationTime.

Destructuring the Response

data ListTrainingJobsResponse Source #

See: newListTrainingJobsResponse smart constructor.

Constructors

ListTrainingJobsResponse' 

Fields

Instances

Instances details
Eq ListTrainingJobsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrainingJobs

Read ListTrainingJobsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrainingJobs

Show ListTrainingJobsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrainingJobs

Generic ListTrainingJobsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrainingJobs

Associated Types

type Rep ListTrainingJobsResponse :: Type -> Type #

NFData ListTrainingJobsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrainingJobs

type Rep ListTrainingJobsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrainingJobs

type Rep ListTrainingJobsResponse = D1 ('MetaData "ListTrainingJobsResponse" "Amazonka.SageMaker.ListTrainingJobs" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "ListTrainingJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "trainingJobSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [TrainingJobSummary]))))

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:

$sel:nextToken:ListTrainingJobs', listTrainingJobsResponse_nextToken - If the response is truncated, Amazon 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, Amazon SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.

listTrainingJobsResponse_trainingJobSummaries :: Lens' ListTrainingJobsResponse [TrainingJobSummary] Source #

An array of TrainingJobSummary objects, each listing a training job.