Package software.amazon.awssdk.services.sagemaker.model

Interface CreateOptimizationJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateOptimizationJobRequest.Builder,CreateOptimizationJobRequest>, SageMakerRequest.Builder, SdkBuilder<CreateOptimizationJobRequest.Builder,CreateOptimizationJobRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateOptimizationJobRequest

public static interface CreateOptimizationJobRequest.Builder
extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<CreateOptimizationJobRequest.Builder,CreateOptimizationJobRequest>

Method Summary

Modifier and Type	Method	Description
CreateOptimizationJobRequest.Builder	deploymentInstanceType(String deploymentInstanceType)	The type of instance that hosts the optimized model that you create with the optimization job.
CreateOptimizationJobRequest.Builder	deploymentInstanceType(OptimizationJobDeploymentInstanceType deploymentInstanceType)	The type of instance that hosts the optimized model that you create with the optimization job.
default CreateOptimizationJobRequest.Builder	modelSource(Consumer<OptimizationJobModelSource.Builder> modelSource)	The location of the source model to optimize with an optimization job.
CreateOptimizationJobRequest.Builder	modelSource(OptimizationJobModelSource modelSource)	The location of the source model to optimize with an optimization job.
CreateOptimizationJobRequest.Builder	optimizationConfigs(Collection<OptimizationConfig> optimizationConfigs)	Settings for each of the optimization techniques that the job applies.
CreateOptimizationJobRequest.Builder	optimizationConfigs(Consumer<OptimizationConfig.Builder>... optimizationConfigs)	Settings for each of the optimization techniques that the job applies.
CreateOptimizationJobRequest.Builder	optimizationConfigs(OptimizationConfig... optimizationConfigs)	Settings for each of the optimization techniques that the job applies.
CreateOptimizationJobRequest.Builder	optimizationEnvironment(Map<String,String> optimizationEnvironment)	The environment variables to set in the model container.
CreateOptimizationJobRequest.Builder	optimizationJobName(String optimizationJobName)	A custom name for the new optimization job.
default CreateOptimizationJobRequest.Builder	outputConfig(Consumer<OptimizationJobOutputConfig.Builder> outputConfig)	Details for where to store the optimized model that you create with the optimization job.
CreateOptimizationJobRequest.Builder	outputConfig(OptimizationJobOutputConfig outputConfig)	Details for where to store the optimized model that you create with the optimization job.
CreateOptimizationJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateOptimizationJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateOptimizationJobRequest.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
default CreateOptimizationJobRequest.Builder	stoppingCondition(Consumer<StoppingCondition.Builder> stoppingCondition)	Sets the value of the StoppingCondition property for this object.
CreateOptimizationJobRequest.Builder	stoppingCondition(StoppingCondition stoppingCondition)	Sets the value of the StoppingCondition property for this object.
CreateOptimizationJobRequest.Builder	tags(Collection<Tag> tags)	A list of key-value pairs associated with the optimization job.
CreateOptimizationJobRequest.Builder	tags(Consumer<Tag.Builder>... tags)	A list of key-value pairs associated with the optimization job.
CreateOptimizationJobRequest.Builder	tags(Tag... tags)	A list of key-value pairs associated with the optimization job.
default CreateOptimizationJobRequest.Builder	vpcConfig(Consumer<OptimizationVpcConfig.Builder> vpcConfig)	A VPC in Amazon VPC that your optimized model has access to.
CreateOptimizationJobRequest.Builder	vpcConfig(OptimizationVpcConfig vpcConfig)	A VPC in Amazon VPC that your optimized model has access to.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

optimizationJobName

CreateOptimizationJobRequest.Builder optimizationJobName(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.

roleArn

CreateOptimizationJobRequest.Builder roleArn(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.

modelSource

CreateOptimizationJobRequest.Builder modelSource(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.

modelSource

default CreateOptimizationJobRequest.Builder modelSource(Consumer<OptimizationJobModelSource.Builder> modelSource)

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

This is a convenience method that creates an instance of the OptimizationJobModelSource.Builder avoiding the need to create one manually via OptimizationJobModelSource.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to modelSource(OptimizationJobModelSource).

Parameters:

modelSource - a consumer that will call methods on OptimizationJobModelSource.Builder

Returns:

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

See Also:

• modelSource(OptimizationJobModelSource)

deploymentInstanceType

CreateOptimizationJobRequest.Builder deploymentInstanceType(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
• OptimizationJobDeploymentInstanceType

deploymentInstanceType

CreateOptimizationJobRequest.Builder deploymentInstanceType(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
• OptimizationJobDeploymentInstanceType

optimizationEnvironment

CreateOptimizationJobRequest.Builder optimizationEnvironment(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.

optimizationConfigs

CreateOptimizationJobRequest.Builder optimizationConfigs(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.

optimizationConfigs

CreateOptimizationJobRequest.Builder optimizationConfigs(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.

optimizationConfigs

CreateOptimizationJobRequest.Builder optimizationConfigs(Consumer<OptimizationConfig.Builder>... optimizationConfigs)

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

This is a convenience method that creates an instance of the OptimizationConfig.Builder avoiding the need to create one manually via OptimizationConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to optimizationConfigs(List<OptimizationConfig>).

Parameters:

optimizationConfigs - a consumer that will call methods on OptimizationConfig.Builder

Returns:

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

See Also:

• optimizationConfigs(java.util.Collection<OptimizationConfig>)

outputConfig

CreateOptimizationJobRequest.Builder outputConfig(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.

outputConfig

default CreateOptimizationJobRequest.Builder outputConfig(Consumer<OptimizationJobOutputConfig.Builder> outputConfig)

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

This is a convenience method that creates an instance of the OptimizationJobOutputConfig.Builder avoiding the need to create one manually via OptimizationJobOutputConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputConfig(OptimizationJobOutputConfig).

Parameters:

outputConfig - a consumer that will call methods on OptimizationJobOutputConfig.Builder

Returns:

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

See Also:

• outputConfig(OptimizationJobOutputConfig)

stoppingCondition

CreateOptimizationJobRequest.Builder stoppingCondition(StoppingCondition stoppingCondition)

Sets the value of the StoppingCondition property for this object.

Parameters:

stoppingCondition - The new value for the StoppingCondition property for this object.

Returns:

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

stoppingCondition

default CreateOptimizationJobRequest.Builder stoppingCondition(Consumer<StoppingCondition.Builder> stoppingCondition)

Sets the value of the StoppingCondition property for this object. This is a convenience method that creates an instance of the StoppingCondition.Builder avoiding the need to create one manually via StoppingCondition.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to stoppingCondition(StoppingCondition).

Parameters:

stoppingCondition - a consumer that will call methods on StoppingCondition.Builder

Returns:

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

See Also:

• stoppingCondition(StoppingCondition)

tags

CreateOptimizationJobRequest.Builder tags(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.

tags

CreateOptimizationJobRequest.Builder tags(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.

tags

CreateOptimizationJobRequest.Builder tags(Consumer<Tag.Builder>... 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.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

• tags(java.util.Collection<Tag>)

vpcConfig

CreateOptimizationJobRequest.Builder vpcConfig(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.

vpcConfig

default CreateOptimizationJobRequest.Builder vpcConfig(Consumer<OptimizationVpcConfig.Builder> vpcConfig)

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

This is a convenience method that creates an instance of the OptimizationVpcConfig.Builder avoiding the need to create one manually via OptimizationVpcConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfig(OptimizationVpcConfig).

Parameters:

vpcConfig - a consumer that will call methods on OptimizationVpcConfig.Builder

Returns:

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

See Also:

• vpcConfig(OptimizationVpcConfig)

overrideConfiguration

CreateOptimizationJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateOptimizationJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.