Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sagemaker ]

list-candidates-for-auto-ml-job

Description

List the candidates created for the job.

See also: AWS API Documentation

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>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <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.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

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.

StandardMetricName -> (string)

The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics .

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 recommended inference container definitions.

(structure)

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

Image -> (string)

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

ModelDataUrl -> (string)

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

Environment -> (map)

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

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.

ModelInsights -> (string)

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

BacktestResults -> (string)

The Amazon S3 prefix to the accuracy metrics and the inference results observed over the testing window. Available only for the time-series forecasting problem type.

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.

StandardMetricName -> (string)

The name of the standard metric.

Note

For definitions of the standard metrics, see ` Autopilot candidate metrics https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-model-support-validation.html#autopilot-metrics`__ .

InferenceContainerDefinitions -> (map)

The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the candidate. This field is populated for the AutoML jobs V2 (for example, for jobs created by calling CreateAutoMLJobV2 ) related to image or text classification problem types only.

key -> (string)

Processing unit for an inference container. Currently Autopilot only supports CPU or GPU .

value -> (list)

Information about the recommended inference container definitions.

(structure)

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

Image -> (string)

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

ModelDataUrl -> (string)

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

Environment -> (map)

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

key -> (string)

value -> (string)

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.