AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon SageMaker Service CreateAutoMLJob API operation.

Syntax

New-SMAutoMLJob
-AutoMLJobName <String>
-SecurityConfig_EnableInterContainerTrafficEncryption <Boolean>
-GenerateCandidateDefinitionsOnly <Boolean>
-InputDataConfig <AutoMLChannel[]>
-OutputDataConfig_KmsKeyId <String>
-CompletionCriteria_MaxAutoMLJobRuntimeInSecond <Int32>
-CompletionCriteria_MaxCandidate <Int32>
-CompletionCriteria_MaxRuntimePerTrainingJobInSecond <Int32>
-AutoMLJobObjective_MetricName <AutoMLMetricEnum>
-ProblemType <ProblemType>
-RoleArn <String>
-OutputDataConfig_S3OutputPath <String>
-VpcConfig_SecurityGroupId <String[]>
-VpcConfig_Subnet <String[]>
-Tag <Tag[]>
-SecurityConfig_VolumeKmsKeyId <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Creates an AutoPilot job.

Parameters

-AutoMLJobName <String>
Identifies an AutoPilot job. Must be unique to your account and is case-insensitive.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-AutoMLJobObjective_MetricName <AutoMLMetricEnum>
The name of the metric.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CompletionCriteria_MaxAutoMLJobRuntimeInSecond <Int32>
The maximum time, in seconds, an AutoML job is allowed to wait for a trial to complete. It must be equal to or greater than MaxRuntimePerTrainingJobInSeconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoMLJobConfig_CompletionCriteria_MaxAutoMLJobRuntimeInSeconds
-CompletionCriteria_MaxCandidate <Int32>
The maximum number of times a training job is allowed to run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoMLJobConfig_CompletionCriteria_MaxCandidates
-CompletionCriteria_MaxRuntimePerTrainingJobInSecond <Int32>
The maximum time, in seconds, a job is allowed to run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoMLJobConfig_CompletionCriteria_MaxRuntimePerTrainingJobInSeconds
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GenerateCandidateDefinitionsOnly <Boolean>
This will generate possible candidates without training a model. A candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InputDataConfig <AutoMLChannel[]>
Similar to InputDataConfig supported by Tuning. Format(s) supported: CSV.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputDataConfig_KmsKeyId <String>
The AWS KMS encryption key ID.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputDataConfig_S3OutputPath <String>
The Amazon S3 output path. Must be 128 characters or less.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the AutoMLJobName parameter. The -PassThru parameter is deprecated, use -Select '^AutoMLJobName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProblemType <ProblemType>
Defines the kind of preprocessing and algorithms intended for the candidates. Options include: BinaryClassification, MulticlassClassification, and Regression.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RoleArn <String>
The ARN of the role that will be used to access the data.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityConfig_EnableInterContainerTrafficEncryption <Boolean>
Whether to use traffic encryption between the container layers.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoMLJobConfig_SecurityConfig_EnableInterContainerTrafficEncryption
-SecurityConfig_VolumeKmsKeyId <String>
The key used to encrypt stored data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoMLJobConfig_SecurityConfig_VolumeKmsKeyId
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'AutoMLJobArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateAutoMLJobResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateAutoMLJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
Each tag consists of a key and an optional value. Tag keys must be unique per resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-VpcConfig_SecurityGroupId <String[]>
The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoMLJobConfig_SecurityConfig_VpcConfig_SecurityGroupIds
-VpcConfig_Subnet <String[]>
The ID of the subnets in the VPC to which you want to connect your training job or model. Amazon EC2 P3 accelerated computing instances are not available in the c/d/e availability zones of region us-east-1. If you want to create endpoints with P3 instances in VPC mode in region us-east-1, create subnets in a/b/f availability zones instead.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoMLJobConfig_SecurityConfig_VpcConfig_Subnets

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns a System.String object. The service call response (type Amazon.SageMaker.Model.CreateAutoMLJobResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z