ListTrainingJobsRequest Class | AWS SDK for .NET V3

Container for the parameters to the ListTrainingJobs operation. 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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SageMaker.AmazonSageMakerRequest
      Amazon.SageMaker.Model.ListTrainingJobsRequest

Namespace: Amazon.SageMaker.Model
Assembly: AWSSDK.SageMaker.dll
Version: 3.x.y.z

Syntax

public class ListTrainingJobsRequest : AmazonSageMakerRequest
         IAmazonWebServiceRequest

The ListTrainingJobsRequest type exposes the following members

Constructors

	Name	Description
	ListTrainingJobsRequest()

Properties

Name	Type	Description
CreationTimeAfter	System.DateTime	Gets and sets the property CreationTimeAfter. A filter that returns only training jobs created after the specified time (timestamp).
CreationTimeBefore	System.DateTime	Gets and sets the property CreationTimeBefore. A filter that returns only training jobs created before the specified time (timestamp).
LastModifiedTimeAfter	System.DateTime	Gets and sets the property LastModifiedTimeAfter. A filter that returns only training jobs modified after the specified time (timestamp).
LastModifiedTimeBefore	System.DateTime	Gets and sets the property LastModifiedTimeBefore. A filter that returns only training jobs modified before the specified time (timestamp).
MaxResults	System.Int32	Gets and sets the property MaxResults. The maximum number of training jobs to return in the response.
NameContains	System.String	Gets and sets the property NameContains. A string in the training job name. This filter returns only training jobs whose name contains the specified string.
NextToken	System.String	Gets and sets the property 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.
SortBy	Amazon.SageMaker.SortBy	Gets and sets the property SortBy. The field to sort results by. The default is `CreationTime`.
SortOrder	Amazon.SageMaker.SortOrder	Gets and sets the property SortOrder. The sort order for results. The default is `Ascending`.
StatusEquals	Amazon.SageMaker.TrainingJobStatus	Gets and sets the property StatusEquals. A filter that retrieves only training jobs with a specific status.
TrainingPlanArnEquals	System.String	Gets and sets the property TrainingPlanArnEquals. The Amazon Resource Name (ARN); of the training plan to filter training jobs by. For more information about reserving GPU capacity for your SageMaker training jobs using Amazon SageMaker Training Plan, see `CreateTrainingPlan`.
WarmPoolStatusEquals	Amazon.SageMaker.WarmPoolResourceStatus	Gets and sets the property WarmPoolStatusEquals. A filter that retrieves only training jobs with a specific warm pool status.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5