candidates_for_auto_ml_jobs

Creates, updates, deletes, gets or lists a candidates_for_auto_ml_jobs resource.

Overview

Name	candidates_for_auto_ml_jobs
Type	Resource
Id	aws.sagemaker.candidates_for_auto_ml_jobs

Fields

The following fields are returned by SELECT queries:

list_candidates_for_auto_ml_job

Name	Datatype	Description
candidate_name	string	The name of the candidate.
candidate_properties	object	The properties of an AutoML candidate job.
candidate_status	string	The candidate's status. (Completed, InProgress, Failed, Stopped, Stopping)
candidate_steps	array	Information about the candidate's steps.
creation_time	string (date-time)	The creation time.
end_time	string (date-time)	The end time.
failure_reason	string	The failure reason.
final_auto_ml_job_objective_metric	object	The best candidate result from an AutoML training job.
inference_container_definitions	object	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.
inference_containers	array	Information about the recommended inference container definitions.
last_modified_time	string (date-time)	The last modified time.
objective_status	string	The objective's status. (Succeeded, Pending, Failed)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_candidates_for_auto_ml_job	select	region		List the candidates created for the job.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_candidates_for_auto_ml_job

List the candidates created for the job.

SELECT
candidate_name,
candidate_properties,
candidate_status,
candidate_steps,
creation_time,
end_time,
failure_reason,
final_auto_ml_job_objective_metric,
inference_container_definitions,
inference_containers,
last_modified_time,
objective_status
FROM aws.sagemaker.candidates_for_auto_ml_jobs
WHERE region = '{{ region }}' -- required
;