View a markdown version of this page

AWS::SageMaker::AutoMLJob - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::SageMaker::AutoMLJob

Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.

An AutoML job in SageMaker AI is a fully automated process that allows you to build machine learning models with minimal effort and machine learning expertise. When initiating an AutoML job, you provide your data and optionally specify parameters tailored to your use case. SageMaker AI then automates the entire model development lifecycle, including data preprocessing, model training, tuning, and evaluation. AutoML jobs are designed to simplify and accelerate the model building process by automating various tasks and exploring different combinations of machine learning algorithms, data preprocessing techniques, and hyperparameter values. The output of an AutoML job comprises one or more trained models ready for deployment and inference. Additionally, SageMaker AI AutoML jobs generate a candidate model leaderboard, allowing you to select the best-performing model for deployment.

For more information about AutoML jobs, see https://docs.amazonaws.cn/sagemaker/latest/dg/autopilot-automate-model-development.html in the SageMaker AI developer guide.

Note

We recommend using the new versions CreateAutoMLJobV2 and DescribeAutoMLJobV2, which offer backward compatibility.

CreateAutoMLJobV2 can manage tabular problem types identical to those of its previous version CreateAutoMLJob, as well as time-series forecasting, non-tabular problem types such as image or text classification, and text generation (LLMs fine-tuning).

Find guidelines about how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.

You can find the best-performing model after you run an AutoML job by calling DescribeAutoMLJobV2 (recommended) or DescribeAutoMLJob.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::SageMaker::AutoMLJob", "Properties" : { "AutoMLJobConfig" : AutoMLJobConfig, "AutoMLJobObjective" : AutoMLJobObjective, "GenerateCandidateDefinitionsOnly" : Boolean, "InputDataConfig" : [ AutoMLChannel, ... ], "OutputDataConfig" : AutoMLOutputDataConfig, "ProblemType" : String, "RoleArn" : String, "Tags" : [ Tag, ... ] } }

Properties

AutoMLJobConfig

A collection of settings used for an AutoML job.

Required: No

Type: AutoMLJobConfig

Update requires: Replacement

AutoMLJobObjective

Specifies a metric to minimize or maximize as the objective of an AutoML job.

Required: No

Type: AutoMLJobObjective

Update requires: Replacement

GenerateCandidateDefinitionsOnly

Property description not available.

Required: No

Type: Boolean

Update requires: Replacement

InputDataConfig

Property description not available.

Required: No

Type: Array of AutoMLChannel

Minimum: 1

Maximum: 2

Update requires: Replacement

OutputDataConfig

Provides information about how to store model training results (model artifacts).

Required: No

Type: AutoMLOutputDataConfig

Update requires: Replacement

ProblemType

Property description not available.

Required: No

Type: String

Allowed values: BinaryClassification | MulticlassClassification | Regression

Update requires: Replacement

RoleArn

Property description not available.

Required: No

Type: String

Pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

Minimum: 20

Maximum: 2048

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: Replacement

Return values

Ref

Fn::GetAtt

AutoMLJobArn

The ARN of the AutoML job.

AutoMLJobName

The name of the AutoML job you are requesting.

AutoMLJobSecondaryStatus

The secondary status of the AutoML job.

AutoMLJobStatus

The status of the AutoML job.

CreationTime

When the AutoML job was created.

EndTime

The end time of an AutoML job.

LastModifiedTime

When the AutoML job was last modified.