Skip to content
AWS for Query.Farm

aws.sagemaker.list_candidates_for_auto_ml_job

Example SQL Queries

SELECT * FROM
aws.sagemaker.list_candidates_for_auto_ml_job
WHERE
"auto_ml_job_name" = 'VALUE';

Description

List the candidates created for the job.

Table Definition

Column NameColumn Data Type
auto_ml_job_name Required Input Column

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

VARCHAR
candidate_name_equals Input Column

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

VARCHAR
sort_by Input Column

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

VARCHAR
sort_order Input Column

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

VARCHAR
status_equals Input Column

List the candidates for the job and filter by status.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

candidate_name

The name of the candidate.

VARCHAR
candidate_properties

The properties of an AutoML candidate job.

STRUCT(
    "candidate_artifact_locations" STRUCT(
        "explainability" VARCHAR,
        "model_insights" VARCHAR,
        "backtest_results" VARCHAR
    ),
    "candidate_metrics" STRUCT(
        "metric_name" VARCHAR,
        "value" DOUBLE,
        "set" VARCHAR,
        "standard_metric_name" VARCHAR
    )[]
)
Show child fields
candidate_properties.candidate_artifact_locations

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

Show child fields
candidate_properties.candidate_artifact_locations.backtest_results

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.

candidate_properties.candidate_artifact_locations.explainability

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

candidate_properties.candidate_artifact_locations.model_insights

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

candidate_properties.candidate_metrics[]
Show child fields
candidate_properties.candidate_metrics[].metric_name

The name of the metric.

candidate_properties.candidate_metrics[].set

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

candidate_properties.candidate_metrics[].standard_metric_name

The name of the standard metric.

For definitions of the standard metrics, see Autopilot candidate metrics .

candidate_properties.candidate_metrics[].value

The value of the metric.

candidate_status

The candidate's status.

VARCHAR
candidate_steps

Information about the candidate's steps.

STRUCT(
    "candidate_step_type" VARCHAR,
    "candidate_step_arn" VARCHAR,
    "candidate_step_name" VARCHAR
)[]
Show child fields
candidate_steps[]
Show child fields
candidate_steps[].candidate_step_arn

The ARN for the candidate's step.

candidate_steps[].candidate_step_name

The name for the candidate's step.

candidate_steps[].candidate_step_type

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

creation_time

The creation time.

TIMESTAMP_S
end_time

The end time.

TIMESTAMP_S
failure_reason

The failure reason.

VARCHAR
final_auto_ml_job_objective_metric

The best candidate result from an AutoML training job.

STRUCT(
    "type" VARCHAR,
    "metric_name" VARCHAR,
    "value" DOUBLE,
    "standard_metric_name" VARCHAR
)
Show child fields
final_auto_ml_job_objective_metric.metric_name

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

final_auto_ml_job_objective_metric.standard_metric_name

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

final_auto_ml_job_objective_metric.type

The type of metric with the best result.

final_auto_ml_job_objective_metric.value

The value of the metric with the best result.

inference_container_definitions

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.

MAP(VARCHAR, STRUCT(
        "image" VARCHAR,
        "model_data_url" VARCHAR,
        "environment" MAP(VARCHAR, VARCHAR)
    )[])
inference_containers

Information about the recommended inference container definitions.

STRUCT(
    "image" VARCHAR,
    "model_data_url" VARCHAR,
    "environment" MAP(VARCHAR, VARCHAR)
)[]
Show child fields
inference_containers[]
Show child fields
inference_containers[].environment

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

inference_containers[].image

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

inference_containers[].model_data_url

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

last_modified_time

The last modified time.

TIMESTAMP_S
objective_status

The objective's status.

VARCHAR