Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . sagemaker ]

list-candidates-for-auto-ml-job

Description

List the Candidates created for the job.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

list-candidates-for-auto-ml-job is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Candidates

Synopsis

  list-candidates-for-auto-ml-job
--auto-ml-job-name <value>
[--status-equals <value>]
[--candidate-name-equals <value>]
[--sort-order <value>]
[--sort-by <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--auto-ml-job-name (string)

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

--status-equals (string)

List the Candidates for the job and filter by status.

Possible values:

  • Completed
  • InProgress
  • Failed
  • Stopped
  • Stopping

--candidate-name-equals (string)

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

--sort-order (string)

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

Possible values:

  • Ascending
  • Descending

--sort-by (string)

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

Possible values:

  • CreationTime
  • Status
  • FinalObjectiveMetricValue

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Candidates -> (list)

Summaries about the Candidates.

(structure)

An AutoPilot job will return recommendations, or candidates. Each candidate has futher details about the steps involed, and the status.

CandidateName -> (string)

The candidate name.

FinalAutoMLJobObjectiveMetric -> (structure)

The candidate result from a job.

Type -> (string)

The metric type used.

MetricName -> (string)

The name of the metric.

Value -> (float)

The value of the metric.

ObjectiveStatus -> (string)

The objective status.

CandidateSteps -> (list)

The candidate's steps.

(structure)

Information about the steps for a Candidate, and what step it is working on.

CandidateStepType -> (string)

Whether the Candidate is at the transform, training, or processing step.

CandidateStepArn -> (string)

The ARN for the Candidate's step.

CandidateStepName -> (string)

The name for the Candidate's step.

CandidateStatus -> (string)

The candidate's status.

InferenceContainers -> (list)

The inference containers.

(structure)

A list of container definitions that describe the different containers that make up one AutoML candidate. Refer to ContainerDefinition for more details.

Image -> (string)

The ECR path of the container. Refer to ContainerDefinition for more details.

ModelDataUrl -> (string)

The location of the model artifacts. Refer to ContainerDefinition for more details.

Environment -> (map)

Environment variables to set in the container. Refer to ContainerDefinition for more details.

key -> (string)

value -> (string)

CreationTime -> (timestamp)

The creation time.

EndTime -> (timestamp)

The end time.

LastModifiedTime -> (timestamp)

The last modified time.

FailureReason -> (string)

The failure reason.

NextToken -> (string)

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