com.amazonaws.services.sagemaker.model

Class CreateOptimizationJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sagemaker.model.CreateOptimizationJobRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateOptimizationJobRequest
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
CreateOptimizationJobRequest()

Method Summary

Modifier and Type	Method and Description
CreateOptimizationJobRequest	addOptimizationEnvironmentEntry(String key, String value) Add a single OptimizationEnvironment entry
CreateOptimizationJobRequest	clearOptimizationEnvironmentEntries() Removes all the entries added into OptimizationEnvironment.
CreateOptimizationJobRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDeploymentInstanceType() The type of instance that hosts the optimized model that you create with the optimization job.
OptimizationJobModelSource	getModelSource() The location of the source model to optimize with an optimization job.
List<OptimizationConfig>	getOptimizationConfigs() Settings for each of the optimization techniques that the job applies.
Map<String,String>	getOptimizationEnvironment() The environment variables to set in the model container.
String	getOptimizationJobName() A custom name for the new optimization job.
OptimizationJobOutputConfig	getOutputConfig() Details for where to store the optimized model that you create with the optimization job.
String	getRoleArn() The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
StoppingCondition	getStoppingCondition()
List<Tag>	getTags() A list of key-value pairs associated with the optimization job.
OptimizationVpcConfig	getVpcConfig() A VPC in Amazon VPC that your optimized model has access to.
int	hashCode()
void	setDeploymentInstanceType(String deploymentInstanceType) The type of instance that hosts the optimized model that you create with the optimization job.
void	setModelSource(OptimizationJobModelSource modelSource) The location of the source model to optimize with an optimization job.
void	setOptimizationConfigs(Collection<OptimizationConfig> optimizationConfigs) Settings for each of the optimization techniques that the job applies.
void	setOptimizationEnvironment(Map<String,String> optimizationEnvironment) The environment variables to set in the model container.
void	setOptimizationJobName(String optimizationJobName) A custom name for the new optimization job.
void	setOutputConfig(OptimizationJobOutputConfig outputConfig) Details for where to store the optimized model that you create with the optimization job.
void	setRoleArn(String roleArn) The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
void	setStoppingCondition(StoppingCondition stoppingCondition)
void	setTags(Collection<Tag> tags) A list of key-value pairs associated with the optimization job.
void	setVpcConfig(OptimizationVpcConfig vpcConfig) A VPC in Amazon VPC that your optimized model has access to.
String	toString() Returns a string representation of this object.
CreateOptimizationJobRequest	withDeploymentInstanceType(OptimizationJobDeploymentInstanceType deploymentInstanceType) The type of instance that hosts the optimized model that you create with the optimization job.
CreateOptimizationJobRequest	withDeploymentInstanceType(String deploymentInstanceType) The type of instance that hosts the optimized model that you create with the optimization job.
CreateOptimizationJobRequest	withModelSource(OptimizationJobModelSource modelSource) The location of the source model to optimize with an optimization job.
CreateOptimizationJobRequest	withOptimizationConfigs(Collection<OptimizationConfig> optimizationConfigs) Settings for each of the optimization techniques that the job applies.
CreateOptimizationJobRequest	withOptimizationConfigs(OptimizationConfig... optimizationConfigs) Settings for each of the optimization techniques that the job applies.
CreateOptimizationJobRequest	withOptimizationEnvironment(Map<String,String> optimizationEnvironment) The environment variables to set in the model container.
CreateOptimizationJobRequest	withOptimizationJobName(String optimizationJobName) A custom name for the new optimization job.
CreateOptimizationJobRequest	withOutputConfig(OptimizationJobOutputConfig outputConfig) Details for where to store the optimized model that you create with the optimization job.
CreateOptimizationJobRequest	withRoleArn(String roleArn) The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
CreateOptimizationJobRequest	withStoppingCondition(StoppingCondition stoppingCondition)
CreateOptimizationJobRequest	withTags(Collection<Tag> tags) A list of key-value pairs associated with the optimization job.
CreateOptimizationJobRequest	withTags(Tag... tags) A list of key-value pairs associated with the optimization job.
CreateOptimizationJobRequest	withVpcConfig(OptimizationVpcConfig vpcConfig) A VPC in Amazon VPC that your optimized model has access to.

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

CreateOptimizationJobRequest

public CreateOptimizationJobRequest()

Method Detail

setOptimizationJobName

public void setOptimizationJobName(String optimizationJobName)

A custom name for the new optimization job.

Parameters:

optimizationJobName - A custom name for the new optimization job.

getOptimizationJobName

public String getOptimizationJobName()

A custom name for the new optimization job.

Returns:

A custom name for the new optimization job.

withOptimizationJobName

public CreateOptimizationJobRequest withOptimizationJobName(String optimizationJobName)

A custom name for the new optimization job.

Parameters:

optimizationJobName - A custom name for the new optimization job.

Returns:

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

setRoleArn

public void setRoleArn(String roleArn)

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

During model optimization, Amazon SageMaker needs your permission to:

• Read input data from an S3 bucket

• Write model artifacts to an S3 bucket

• Write logs to Amazon CloudWatch Logs

• Publish metrics to Amazon CloudWatch

You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.

Parameters:

roleArn - The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

During model optimization, Amazon SageMaker needs your permission to:

• Read input data from an S3 bucket

• Write model artifacts to an S3 bucket

• Write logs to Amazon CloudWatch Logs

• Publish metrics to Amazon CloudWatch

You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.

getRoleArn

public String getRoleArn()

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

During model optimization, Amazon SageMaker needs your permission to:

• Read input data from an S3 bucket

• Write model artifacts to an S3 bucket

• Write logs to Amazon CloudWatch Logs

• Publish metrics to Amazon CloudWatch

You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.

Returns:

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

During model optimization, Amazon SageMaker needs your permission to:

• Read input data from an S3 bucket

• Write model artifacts to an S3 bucket

• Write logs to Amazon CloudWatch Logs

• Publish metrics to Amazon CloudWatch

You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.

withRoleArn

public CreateOptimizationJobRequest withRoleArn(String roleArn)

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

During model optimization, Amazon SageMaker needs your permission to:

• Read input data from an S3 bucket

• Write model artifacts to an S3 bucket

• Write logs to Amazon CloudWatch Logs

• Publish metrics to Amazon CloudWatch

You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.

Parameters:

roleArn - The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

During model optimization, Amazon SageMaker needs your permission to:

• Read input data from an S3 bucket

• Write model artifacts to an S3 bucket

• Write logs to Amazon CloudWatch Logs

• Publish metrics to Amazon CloudWatch

You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.

Returns:

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

setModelSource

public void setModelSource(OptimizationJobModelSource modelSource)

The location of the source model to optimize with an optimization job.

Parameters:

modelSource - The location of the source model to optimize with an optimization job.

getModelSource

public OptimizationJobModelSource getModelSource()

The location of the source model to optimize with an optimization job.

Returns:

The location of the source model to optimize with an optimization job.

withModelSource

public CreateOptimizationJobRequest withModelSource(OptimizationJobModelSource modelSource)

The location of the source model to optimize with an optimization job.

Parameters:

modelSource - The location of the source model to optimize with an optimization job.

Returns:

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

setDeploymentInstanceType

public void setDeploymentInstanceType(String deploymentInstanceType)

The type of instance that hosts the optimized model that you create with the optimization job.

Parameters:

deploymentInstanceType - The type of instance that hosts the optimized model that you create with the optimization job.

See Also:

OptimizationJobDeploymentInstanceType

getDeploymentInstanceType

public String getDeploymentInstanceType()

The type of instance that hosts the optimized model that you create with the optimization job.

Returns:

The type of instance that hosts the optimized model that you create with the optimization job.

See Also:

OptimizationJobDeploymentInstanceType

withDeploymentInstanceType

public CreateOptimizationJobRequest withDeploymentInstanceType(String deploymentInstanceType)

The type of instance that hosts the optimized model that you create with the optimization job.

Parameters:

deploymentInstanceType - The type of instance that hosts the optimized model that you create with the optimization job.

Returns:

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

See Also:

OptimizationJobDeploymentInstanceType

withDeploymentInstanceType

public CreateOptimizationJobRequest withDeploymentInstanceType(OptimizationJobDeploymentInstanceType deploymentInstanceType)

The type of instance that hosts the optimized model that you create with the optimization job.

Parameters:

deploymentInstanceType - The type of instance that hosts the optimized model that you create with the optimization job.

Returns:

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

See Also:

OptimizationJobDeploymentInstanceType

getOptimizationEnvironment

public Map<String,String> getOptimizationEnvironment()

The environment variables to set in the model container.

Returns:

The environment variables to set in the model container.

setOptimizationEnvironment

public void setOptimizationEnvironment(Map<String,String> optimizationEnvironment)

The environment variables to set in the model container.

Parameters:

optimizationEnvironment - The environment variables to set in the model container.

withOptimizationEnvironment

public CreateOptimizationJobRequest withOptimizationEnvironment(Map<String,String> optimizationEnvironment)

The environment variables to set in the model container.

Parameters:

optimizationEnvironment - The environment variables to set in the model container.

Returns:

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

addOptimizationEnvironmentEntry

public CreateOptimizationJobRequest addOptimizationEnvironmentEntry(String key,
                                                                    String value)

Add a single OptimizationEnvironment entry

See Also:

withOptimizationEnvironment(java.util.Map<java.lang.String, java.lang.String>)

clearOptimizationEnvironmentEntries

public CreateOptimizationJobRequest clearOptimizationEnvironmentEntries()

Removes all the entries added into OptimizationEnvironment.

Returns:

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

getOptimizationConfigs

public List<OptimizationConfig> getOptimizationConfigs()

Settings for each of the optimization techniques that the job applies.

Returns:

Settings for each of the optimization techniques that the job applies.

setOptimizationConfigs

public void setOptimizationConfigs(Collection<OptimizationConfig> optimizationConfigs)

Settings for each of the optimization techniques that the job applies.

Parameters:

optimizationConfigs - Settings for each of the optimization techniques that the job applies.

withOptimizationConfigs

public CreateOptimizationJobRequest withOptimizationConfigs(OptimizationConfig... optimizationConfigs)

Settings for each of the optimization techniques that the job applies.

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

Parameters:

optimizationConfigs - Settings for each of the optimization techniques that the job applies.

Returns:

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

withOptimizationConfigs

public CreateOptimizationJobRequest withOptimizationConfigs(Collection<OptimizationConfig> optimizationConfigs)

Settings for each of the optimization techniques that the job applies.

Parameters:

optimizationConfigs - Settings for each of the optimization techniques that the job applies.

Returns:

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

setOutputConfig

public void setOutputConfig(OptimizationJobOutputConfig outputConfig)

Details for where to store the optimized model that you create with the optimization job.

Parameters:

outputConfig - Details for where to store the optimized model that you create with the optimization job.

getOutputConfig

public OptimizationJobOutputConfig getOutputConfig()

Details for where to store the optimized model that you create with the optimization job.

Returns:

Details for where to store the optimized model that you create with the optimization job.

withOutputConfig

public CreateOptimizationJobRequest withOutputConfig(OptimizationJobOutputConfig outputConfig)

Details for where to store the optimized model that you create with the optimization job.

Parameters:

outputConfig - Details for where to store the optimized model that you create with the optimization job.

Returns:

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

setStoppingCondition

public void setStoppingCondition(StoppingCondition stoppingCondition)

Parameters:

stoppingCondition -

getStoppingCondition

public StoppingCondition getStoppingCondition()

Returns:

withStoppingCondition

public CreateOptimizationJobRequest withStoppingCondition(StoppingCondition stoppingCondition)

Parameters:

stoppingCondition -

Returns:

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

getTags

public List<Tag> getTags()

A list of key-value pairs associated with the optimization job. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

Returns:

A list of key-value pairs associated with the optimization job. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

setTags

public void setTags(Collection<Tag> tags)

A list of key-value pairs associated with the optimization job. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

Parameters:

tags - A list of key-value pairs associated with the optimization job. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

withTags

public CreateOptimizationJobRequest withTags(Tag... tags)

A list of key-value pairs associated with the optimization job. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

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 - A list of key-value pairs associated with the optimization job. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

Returns:

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

withTags

public CreateOptimizationJobRequest withTags(Collection<Tag> tags)

A list of key-value pairs associated with the optimization job. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

Parameters:

tags - A list of key-value pairs associated with the optimization job. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

Returns:

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

setVpcConfig

public void setVpcConfig(OptimizationVpcConfig vpcConfig)

A VPC in Amazon VPC that your optimized model has access to.

Parameters:

vpcConfig - A VPC in Amazon VPC that your optimized model has access to.

getVpcConfig

public OptimizationVpcConfig getVpcConfig()

A VPC in Amazon VPC that your optimized model has access to.

Returns:

A VPC in Amazon VPC that your optimized model has access to.

withVpcConfig

public CreateOptimizationJobRequest withVpcConfig(OptimizationVpcConfig vpcConfig)

A VPC in Amazon VPC that your optimized model has access to.

Parameters:

vpcConfig - A VPC in Amazon VPC that your optimized model has access to.

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 CreateOptimizationJobRequest 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()