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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListCandidatesForAutoMLJobRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  auto_ml_job_name: "AutoMLJobName", # required
  status_equals: "Completed", # accepts Completed, InProgress, Failed, Stopped, Stopping
  candidate_name_equals: "CandidateName",
  sort_order: "Ascending", # accepts Ascending, Descending
  sort_by: "CreationTime", # accepts CreationTime, Status, FinalObjectiveMetricValue
  max_results: 1,
  next_token: "NextToken",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#auto_ml_job_name ⇒ String

List the Candidates created for the job by providing the job\'s name.

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (Integer) —

    List the job\'s Candidates up to a specified limit.

#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) —

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

#sort_by ⇒ String

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

Possible values:

  • CreationTime
  • Status
  • FinalObjectiveMetricValue

Returns:

  • (String) —

    The parameter by which to sort the results.

#sort_order ⇒ String

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

Possible values:

  • Ascending
  • Descending

Returns:

  • (String) —

    The sort order for the results.

#status_equals ⇒ String

List the Candidates for the job and filter by status.

Possible values:

  • Completed
  • InProgress
  • Failed
  • Stopped
  • Stopping

Returns:

  • (String) —

    List the Candidates for the job and filter by status.