com.amazonaws.services.sagemaker.model

Class CreateAutoMLJobV2Request

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sagemaker.model.CreateAutoMLJobV2Request

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateAutoMLJobV2Request
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateAutoMLJobV2Request()

Method Summary

Modifier and Type	Method and Description
CreateAutoMLJobV2Request	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<AutoMLJobChannel>	getAutoMLJobInputDataConfig() An array of channel objects describing the input data and their location.
String	getAutoMLJobName() Identifies an Autopilot job.
AutoMLJobObjective	getAutoMLJobObjective() Specifies a metric to minimize or maximize as the objective of a job.
AutoMLProblemTypeConfig	getAutoMLProblemTypeConfig() Defines the configuration settings of one of the supported problem types.
AutoMLDataSplitConfig	getDataSplitConfig() This structure specifies how to split the data into train and validation datasets.
ModelDeployConfig	getModelDeployConfig() Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.
AutoMLOutputDataConfig	getOutputDataConfig() Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job.
String	getRoleArn() The ARN of the role that is used to access the data.
AutoMLSecurityConfig	getSecurityConfig() The security configuration for traffic encryption or Amazon VPC settings.
List<Tag>	getTags() An array of key-value pairs.
int	hashCode()
void	setAutoMLJobInputDataConfig(Collection<AutoMLJobChannel> autoMLJobInputDataConfig) An array of channel objects describing the input data and their location.
void	setAutoMLJobName(String autoMLJobName) Identifies an Autopilot job.
void	setAutoMLJobObjective(AutoMLJobObjective autoMLJobObjective) Specifies a metric to minimize or maximize as the objective of a job.
void	setAutoMLProblemTypeConfig(AutoMLProblemTypeConfig autoMLProblemTypeConfig) Defines the configuration settings of one of the supported problem types.
void	setDataSplitConfig(AutoMLDataSplitConfig dataSplitConfig) This structure specifies how to split the data into train and validation datasets.
void	setModelDeployConfig(ModelDeployConfig modelDeployConfig) Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.
void	setOutputDataConfig(AutoMLOutputDataConfig outputDataConfig) Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job.
void	setRoleArn(String roleArn) The ARN of the role that is used to access the data.
void	setSecurityConfig(AutoMLSecurityConfig securityConfig) The security configuration for traffic encryption or Amazon VPC settings.
void	setTags(Collection<Tag> tags) An array of key-value pairs.
String	toString() Returns a string representation of this object.
CreateAutoMLJobV2Request	withAutoMLJobInputDataConfig(AutoMLJobChannel... autoMLJobInputDataConfig) An array of channel objects describing the input data and their location.
CreateAutoMLJobV2Request	withAutoMLJobInputDataConfig(Collection<AutoMLJobChannel> autoMLJobInputDataConfig) An array of channel objects describing the input data and their location.
CreateAutoMLJobV2Request	withAutoMLJobName(String autoMLJobName) Identifies an Autopilot job.
CreateAutoMLJobV2Request	withAutoMLJobObjective(AutoMLJobObjective autoMLJobObjective) Specifies a metric to minimize or maximize as the objective of a job.
CreateAutoMLJobV2Request	withAutoMLProblemTypeConfig(AutoMLProblemTypeConfig autoMLProblemTypeConfig) Defines the configuration settings of one of the supported problem types.
CreateAutoMLJobV2Request	withDataSplitConfig(AutoMLDataSplitConfig dataSplitConfig) This structure specifies how to split the data into train and validation datasets.
CreateAutoMLJobV2Request	withModelDeployConfig(ModelDeployConfig modelDeployConfig) Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.
CreateAutoMLJobV2Request	withOutputDataConfig(AutoMLOutputDataConfig outputDataConfig) Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job.
CreateAutoMLJobV2Request	withRoleArn(String roleArn) The ARN of the role that is used to access the data.
CreateAutoMLJobV2Request	withSecurityConfig(AutoMLSecurityConfig securityConfig) The security configuration for traffic encryption or Amazon VPC settings.
CreateAutoMLJobV2Request	withTags(Collection<Tag> tags) An array of key-value pairs.
CreateAutoMLJobV2Request	withTags(Tag... tags) An array of key-value pairs.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateAutoMLJobV2Request

public CreateAutoMLJobV2Request()

Method Detail

setAutoMLJobName

public void setAutoMLJobName(String autoMLJobName)

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

Parameters:

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

getAutoMLJobName

public String getAutoMLJobName()

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

Returns:

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

withAutoMLJobName

public CreateAutoMLJobV2Request withAutoMLJobName(String autoMLJobName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getAutoMLJobInputDataConfig

public List<AutoMLJobChannel> getAutoMLJobInputDataConfig()

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

Returns:

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

setAutoMLJobInputDataConfig

public void setAutoMLJobInputDataConfig(Collection<AutoMLJobChannel> 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

Parameters:

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

withAutoMLJobInputDataConfig

public CreateAutoMLJobV2Request withAutoMLJobInputDataConfig(AutoMLJobChannel... 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

NOTE: This method appends the values to the existing list (if any). Use setAutoMLJobInputDataConfig(java.util.Collection) or withAutoMLJobInputDataConfig(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withAutoMLJobInputDataConfig

public CreateAutoMLJobV2Request withAutoMLJobInputDataConfig(Collection<AutoMLJobChannel> 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setOutputDataConfig

public void setOutputDataConfig(AutoMLOutputDataConfig outputDataConfig)

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

Parameters:

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

getOutputDataConfig

public AutoMLOutputDataConfig getOutputDataConfig()

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

Returns:

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

withOutputDataConfig

public CreateAutoMLJobV2Request withOutputDataConfig(AutoMLOutputDataConfig outputDataConfig)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setAutoMLProblemTypeConfig

public void setAutoMLProblemTypeConfig(AutoMLProblemTypeConfig autoMLProblemTypeConfig)

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

Parameters:

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

getAutoMLProblemTypeConfig

public AutoMLProblemTypeConfig getAutoMLProblemTypeConfig()

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

Returns:

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

withAutoMLProblemTypeConfig

public CreateAutoMLJobV2Request withAutoMLProblemTypeConfig(AutoMLProblemTypeConfig autoMLProblemTypeConfig)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setRoleArn

public void setRoleArn(String roleArn)

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

Parameters:

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

getRoleArn

public String getRoleArn()

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

Returns:

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

withRoleArn

public CreateAutoMLJobV2Request withRoleArn(String roleArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

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

Returns:

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

setTags

public void setTags(Collection<Tag> tags)

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

Parameters:

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

withTags

public CreateAutoMLJobV2Request withTags(Tag... tags)

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

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateAutoMLJobV2Request withTags(Collection<Tag> tags)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setSecurityConfig

public void setSecurityConfig(AutoMLSecurityConfig securityConfig)

The security configuration for traffic encryption or Amazon VPC settings.

Parameters:

securityConfig - The security configuration for traffic encryption or Amazon VPC settings.

getSecurityConfig

public AutoMLSecurityConfig getSecurityConfig()

The security configuration for traffic encryption or Amazon VPC settings.

Returns:

The security configuration for traffic encryption or Amazon VPC settings.

withSecurityConfig

public CreateAutoMLJobV2Request withSecurityConfig(AutoMLSecurityConfig securityConfig)

The security configuration for traffic encryption or Amazon VPC settings.

Parameters:

securityConfig - The security configuration for traffic encryption or Amazon VPC settings.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAutoMLJobObjective

public void setAutoMLJobObjective(AutoMLJobObjective autoMLJobObjective)

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

Parameters:

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

getAutoMLJobObjective

public AutoMLJobObjective getAutoMLJobObjective()

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

Returns:

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

withAutoMLJobObjective

public CreateAutoMLJobV2Request withAutoMLJobObjective(AutoMLJobObjective autoMLJobObjective)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setModelDeployConfig

public void setModelDeployConfig(ModelDeployConfig modelDeployConfig)

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

Parameters:

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

getModelDeployConfig

public ModelDeployConfig getModelDeployConfig()

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

Returns:

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

withModelDeployConfig

public CreateAutoMLJobV2Request withModelDeployConfig(ModelDeployConfig modelDeployConfig)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setDataSplitConfig

public void setDataSplitConfig(AutoMLDataSplitConfig 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.

Parameters:

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.

getDataSplitConfig

public AutoMLDataSplitConfig getDataSplitConfig()

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.

Returns:

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.

withDataSplitConfig

public CreateAutoMLJobV2Request withDataSplitConfig(AutoMLDataSplitConfig 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateAutoMLJobV2Request clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()