/AWS1/CL_SGM=>LISTTRAININGJOBS()
¶
About ListTrainingJobs¶
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
Method Signature¶
IMPORTING¶
Optional arguments:¶
IV_NEXTTOKEN
TYPE /AWS1/SGMNEXTTOKEN
/AWS1/SGMNEXTTOKEN
¶
If the result of the previous
ListTrainingJobs
request was truncated, the response includes aNextToken
. To retrieve the next set of training jobs, use the token in the next request.
IV_MAXRESULTS
TYPE /AWS1/SGMMAXRESULTS
/AWS1/SGMMAXRESULTS
¶
The maximum number of training jobs to return in the response.
IV_CREATIONTIMEAFTER
TYPE /AWS1/SGMTIMESTAMP
/AWS1/SGMTIMESTAMP
¶
A filter that returns only training jobs created after the specified time (timestamp).
IV_CREATIONTIMEBEFORE
TYPE /AWS1/SGMTIMESTAMP
/AWS1/SGMTIMESTAMP
¶
A filter that returns only training jobs created before the specified time (timestamp).
IV_LASTMODIFIEDTIMEAFTER
TYPE /AWS1/SGMTIMESTAMP
/AWS1/SGMTIMESTAMP
¶
A filter that returns only training jobs modified after the specified time (timestamp).
IV_LASTMODIFIEDTIMEBEFORE
TYPE /AWS1/SGMTIMESTAMP
/AWS1/SGMTIMESTAMP
¶
A filter that returns only training jobs modified before the specified time (timestamp).
IV_NAMECONTAINS
TYPE /AWS1/SGMNAMECONTAINS
/AWS1/SGMNAMECONTAINS
¶
A string in the training job name. This filter returns only training jobs whose name contains the specified string.
IV_STATUSEQUALS
TYPE /AWS1/SGMTRAININGJOBSTATUS
/AWS1/SGMTRAININGJOBSTATUS
¶
A filter that retrieves only training jobs with a specific status.
IV_SORTBY
TYPE /AWS1/SGMSORTBY
/AWS1/SGMSORTBY
¶
The field to sort results by. The default is
CreationTime
.
IV_SORTORDER
TYPE /AWS1/SGMSORTORDER
/AWS1/SGMSORTORDER
¶
The sort order for results. The default is
Ascending
.
IV_WARMPOOLSTATUSEQUALS
TYPE /AWS1/SGMWARMPOOLRESRCSTATUS
/AWS1/SGMWARMPOOLRESRCSTATUS
¶
A filter that retrieves only training jobs with a specific warm pool status.