[ 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 | --cli-input-yaml]
[--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 | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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 AutoMLCandidates .

(structure)

Information about a candidate produced by an AutoML training job, including its status, steps, and other properties.

CandidateName -> (string)

The name of the candidate.

FinalAutoMLJobObjectiveMetric -> (structure)

The best candidate result from an AutoML training job.

Type -> (string)

The type of metric with the best result.

MetricName -> (string)

The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName .

Value -> (float)

The value of the metric with the best result.

ObjectiveStatus -> (string)

The objective’s status.

CandidateSteps -> (list)

Information about 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)

Information about the inference container definitions.

(structure)

A list of container definitions that describe the different containers that make up an AutoML candidate. For more information, see .

Image -> (string)

The Amazon Elastic Container Registry (Amazon ECR) path of the container. For more information, see .

ModelDataUrl -> (string)

The location of the model artifacts. For more information, see .

Environment -> (map)

The environment variables to set in the container. For more information, see .

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.

CandidateProperties -> (structure)

The properties of an AutoML candidate job.

CandidateArtifactLocations -> (structure)

The Amazon S3 prefix to the artifacts generated for an AutoML candidate.

Explainability -> (string)

The Amazon S3 prefix to the explainability artifacts generated for the AutoML candidate.

CandidateMetrics -> (list)

Information about the candidate metrics for an AutoML job.

(structure)

Information about the metric for a candidate produced by an AutoML job.

MetricName -> (string)

The name of the metric.

Value -> (float)

The value of the metric.

Set -> (string)

The dataset split from which the AutoML job produced the metric.

NextToken -> (string)

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