Class: Aws::SageMaker::Types::ListCandidatesForAutoMLJobRequest

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::ListCandidatesForAutoMLJobRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sagemaker/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #auto_ml_job_name ⇒ String

  List the candidates created for the job by providing the job’s name.

• #candidate_name_equals ⇒ String

  List the candidates for the job and filter by candidate name.

• #max_results ⇒ Integer

  List the job’s candidates up to a specified limit.

• #next_token ⇒ String

  If the previous response was truncated, you receive this token.

• #sort_by ⇒ String

  The parameter by which to sort the results.

• #sort_order ⇒ String

  The sort order for the results.

• #status_equals ⇒ String

  List the candidates for the job and filter by status.

Instance Attribute Details

#auto_ml_job_name ⇒ String

List the candidates created for the job by providing the job’s name.

Returns:

• (String)

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

class ListCandidatesForAutoMLJobRequest < Struct.new(
  :auto_ml_job_name,
  :status_equals,
  :candidate_name_equals,
  :sort_order,
  :sort_by,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#candidate_name_equals ⇒ String

List the candidates for the job and filter by candidate name.

Returns:

• (String)

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

class ListCandidatesForAutoMLJobRequest < Struct.new(
  :auto_ml_job_name,
  :status_equals,
  :candidate_name_equals,
  :sort_order,
  :sort_by,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

List the job’s candidates up to a specified limit.

Returns:

• (Integer)

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

class ListCandidatesForAutoMLJobRequest < Struct.new(
  :auto_ml_job_name,
  :status_equals,
  :candidate_name_equals,
  :sort_order,
  :sort_by,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

Returns:

• (String)

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

class ListCandidatesForAutoMLJobRequest < Struct.new(
  :auto_ml_job_name,
  :status_equals,
  :candidate_name_equals,
  :sort_order,
  :sort_by,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#sort_by ⇒ String

The parameter by which to sort the results. The default is ‘Descending`.

Returns:

• (String)

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

class ListCandidatesForAutoMLJobRequest < Struct.new(
  :auto_ml_job_name,
  :status_equals,
  :candidate_name_equals,
  :sort_order,
  :sort_by,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#sort_order ⇒ String

The sort order for the results. The default is ‘Ascending`.

Returns:

• (String)

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

class ListCandidatesForAutoMLJobRequest < Struct.new(
  :auto_ml_job_name,
  :status_equals,
  :candidate_name_equals,
  :sort_order,
  :sort_by,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#status_equals ⇒ String

List the candidates for the job and filter by status.

Returns:

• (String)

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

class ListCandidatesForAutoMLJobRequest < Struct.new(
  :auto_ml_job_name,
  :status_equals,
  :candidate_name_equals,
  :sort_order,
  :sort_by,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end