You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SageMaker::Types::ListTrainingJobsRequest

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::ListTrainingJobsRequest

Defined in:

gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Note:

When making an API call, you may pass ListTrainingJobsRequest data as a hash:

{
  next_token: "NextToken",
  max_results: 1,
  creation_time_after: Time.now,
  creation_time_before: Time.now,
  last_modified_time_after: Time.now,
  last_modified_time_before: Time.now,
  name_contains: "NameContains",
  status_equals: "InProgress", # accepts InProgress, Completed, Failed, Stopping, Stopped
  sort_by: "Name", # accepts Name, CreationTime, Status
  sort_order: "Ascending", # accepts Ascending, Descending
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #creation_time_after ⇒ Time

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

• #creation_time_before ⇒ Time

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

• #last_modified_time_after ⇒ Time

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

• #last_modified_time_before ⇒ Time

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

• #max_results ⇒ Integer

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

• #name_contains ⇒ String

  A string in the training job name.

• #next_token ⇒ String

  If the result of the previous ListTrainingJobs request was truncated, the response includes a NextToken.

• #sort_by ⇒ String

  The field to sort results by.

• #sort_order ⇒ String

  The sort order for results.

• #status_equals ⇒ String

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

Instance Attribute Details

#creation_time_after ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8583

class ListTrainingJobsRequest < Struct.new(
  :next_token,
  :max_results,
  :creation_time_after,
  :creation_time_before,
  :last_modified_time_after,
  :last_modified_time_before,
  :name_contains,
  :status_equals,
  :sort_by,
  :sort_order)
  include Aws::Structure
end

#creation_time_before ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8583

class ListTrainingJobsRequest < Struct.new(
  :next_token,
  :max_results,
  :creation_time_after,
  :creation_time_before,
  :last_modified_time_after,
  :last_modified_time_before,
  :name_contains,
  :status_equals,
  :sort_by,
  :sort_order)
  include Aws::Structure
end

#last_modified_time_after ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8583

class ListTrainingJobsRequest < Struct.new(
  :next_token,
  :max_results,
  :creation_time_after,
  :creation_time_before,
  :last_modified_time_after,
  :last_modified_time_before,
  :name_contains,
  :status_equals,
  :sort_by,
  :sort_order)
  include Aws::Structure
end

#last_modified_time_before ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8583

class ListTrainingJobsRequest < Struct.new(
  :next_token,
  :max_results,
  :creation_time_after,
  :creation_time_before,
  :last_modified_time_after,
  :last_modified_time_before,
  :name_contains,
  :status_equals,
  :sort_by,
  :sort_order)
  include Aws::Structure
end

#max_results ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8583

class ListTrainingJobsRequest < Struct.new(
  :next_token,
  :max_results,
  :creation_time_after,
  :creation_time_before,
  :last_modified_time_after,
  :last_modified_time_before,
  :name_contains,
  :status_equals,
  :sort_by,
  :sort_order)
  include Aws::Structure
end

#name_contains ⇒ String

A string in the training job name. This filter returns only training jobs whose name contains the specified string.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8583

class ListTrainingJobsRequest < Struct.new(
  :next_token,
  :max_results,
  :creation_time_after,
  :creation_time_before,
  :last_modified_time_after,
  :last_modified_time_before,
  :name_contains,
  :status_equals,
  :sort_by,
  :sort_order)
  include Aws::Structure
end

#next_token ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8583

class ListTrainingJobsRequest < Struct.new(
  :next_token,
  :max_results,
  :creation_time_after,
  :creation_time_before,
  :last_modified_time_after,
  :last_modified_time_before,
  :name_contains,
  :status_equals,
  :sort_by,
  :sort_order)
  include Aws::Structure
end

#sort_by ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8583

class ListTrainingJobsRequest < Struct.new(
  :next_token,
  :max_results,
  :creation_time_after,
  :creation_time_before,
  :last_modified_time_after,
  :last_modified_time_before,
  :name_contains,
  :status_equals,
  :sort_by,
  :sort_order)
  include Aws::Structure
end

#sort_order ⇒ String

The sort order for results. The default is Ascending.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8583

class ListTrainingJobsRequest < Struct.new(
  :next_token,
  :max_results,
  :creation_time_after,
  :creation_time_before,
  :last_modified_time_after,
  :last_modified_time_before,
  :name_contains,
  :status_equals,
  :sort_by,
  :sort_order)
  include Aws::Structure
end

#status_equals ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8583

class ListTrainingJobsRequest < Struct.new(
  :next_token,
  :max_results,
  :creation_time_after,
  :creation_time_before,
  :last_modified_time_after,
  :last_modified_time_before,
  :name_contains,
  :status_equals,
  :sort_by,
  :sort_order)
  include Aws::Structure
end