Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateAutoMLJobV2

Creates an Amazon SageMaker AutoML job that uses non-tabular data such as images or text for Computer Vision or Natural Language Processing problems.

Find the resulting model after you run an AutoML job V2 by calling DescribeAutoMLJobV2.

To create an AutoMLJob using tabular data, see CreateAutoMLJob.

Note

This API action is callable through SageMaker Canvas only. Calling it directly from the CLI or an SDK results in an error.

Request Syntax


{
   "AutoMLJobInputDataConfig": [ 
      { 
         "ChannelType": "string",
         "CompressionType": "string",
         "ContentType": "string",
         "DataSource": { 
            "S3DataSource": { 
               "S3DataType": "string",
               "S3Uri": "string"
            }
         }
      }
   ],
   "AutoMLJobName": "string",
   "AutoMLJobObjective": { 
      "MetricName": "string"
   },
   "AutoMLProblemTypeConfig": { ... },
   "DataSplitConfig": { 
      "ValidationFraction": number
   },
   "ModelDeployConfig": { 
      "AutoGenerateEndpointName": boolean,
      "EndpointName": "string"
   },
   "OutputDataConfig": { 
      "KmsKeyId": "string",
      "S3OutputPath": "string"
   },
   "RoleArn": "string",
   "SecurityConfig": { 
      "EnableInterContainerTrafficEncryption": boolean,
      "VolumeKmsKeyId": "string",
      "VpcConfig": { 
         "SecurityGroupIds": [ "string" ],
         "Subnets": [ "string" ]
      }
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AutoMLJobInputDataConfig

An array of channel objects describing the input data and their location. Each channel is a named input source. Similar to InputDataConfig supported by CreateAutoMLJob. The supported formats depend on the problem type:

ImageClassification: S3Prefix, ManifestFile, AugmentedManifestFile
TextClassification: S3Prefix

Type: Array of AutoMLJobChannel objects

Array Members: Minimum number of 1 item. Maximum number of 2 items.

Required: Yes

AutoMLJobName

Identifies an Autopilot job. The name must be unique to your account and is case insensitive.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}

Required: Yes

AutoMLJobObjective

Specifies a metric to minimize or maximize as the objective of a job. For CreateAutoMLJobV2, only Accuracy is supported.

Type: AutoMLJobObjective object

Required: No

AutoMLProblemTypeConfig

Defines the configuration settings of one of the supported problem types.

Type: AutoMLProblemTypeConfig object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

DataSplitConfig

This structure specifies how to split the data into train and validation datasets.

If you are using the V1 API (for example CreateAutoMLJob) or the V2 API for Natural Language Processing problems (for example CreateAutoMLJobV2 with a TextClassificationJobConfig problem type), the validation and training datasets must contain the same headers. Also, for V1 API jobs, the validation dataset must be less than 2 GB in size.

Type: AutoMLDataSplitConfig object

Required: No

ModelDeployConfig

Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.

Type: ModelDeployConfig object

Required: No

OutputDataConfig

Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job.

Type: AutoMLOutputDataConfig object

Required: Yes

RoleArn

The ARN of the role that is used to access the data.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

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

Required: Yes

SecurityConfig

The security configuration for traffic encryption or Amazon VPC settings.

Type: AutoMLSecurityConfig object

Required: No

Tags

An array of key-value pairs. You can use tags to categorize your Amazon resources in different ways, such as by purpose, owner, or environment. For more information, see Tagging AmazonResources. Tag keys must be unique per resource.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

Response Syntax


{
   "AutoMLJobArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AutoMLJobArn

The unique ARN assigned to the AutoMLJob when it is created.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:automl-job/.*

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceInUse

Resource being accessed is in use.

HTTP Status Code: 400

ResourceLimitExceeded

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

HTTP Status Code: 400