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

Interface CreateCompilationJobRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateCompilationJobRequest

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

Method Summary

Modifier and Type	Method	Description
CreateCompilationJobRequest.Builder	compilationJobName(String compilationJobName)	A name for the model compilation job.
default CreateCompilationJobRequest.Builder	inputConfig(Consumer<InputConfig.Builder> inputConfig)	Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.
CreateCompilationJobRequest.Builder	inputConfig(InputConfig inputConfig)	Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.
CreateCompilationJobRequest.Builder	modelPackageVersionArn(String modelPackageVersionArn)	The Amazon Resource Name (ARN) of a versioned model package.
default CreateCompilationJobRequest.Builder	outputConfig(Consumer<OutputConfig.Builder> outputConfig)	Provides information about the output location for the compiled model and the target device the model runs on.
CreateCompilationJobRequest.Builder	outputConfig(OutputConfig outputConfig)	Provides information about the output location for the compiled model and the target device the model runs on.
CreateCompilationJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateCompilationJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateCompilationJobRequest.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
default CreateCompilationJobRequest.Builder	stoppingCondition(Consumer<StoppingCondition.Builder> stoppingCondition)	Specifies a limit to how long a model compilation job can run.
CreateCompilationJobRequest.Builder	stoppingCondition(StoppingCondition stoppingCondition)	Specifies a limit to how long a model compilation job can run.
CreateCompilationJobRequest.Builder	tags(Collection<Tag> tags)	An array of key-value pairs.
CreateCompilationJobRequest.Builder	tags(Consumer<Tag.Builder>... tags)	An array of key-value pairs.
CreateCompilationJobRequest.Builder	tags(Tag... tags)	An array of key-value pairs.
default CreateCompilationJobRequest.Builder	vpcConfig(Consumer<NeoVpcConfig.Builder> vpcConfig)	A VpcConfig object that specifies the VPC that you want your compilation job to connect to.
CreateCompilationJobRequest.Builder	vpcConfig(NeoVpcConfig vpcConfig)	A VpcConfig object that specifies the VPC that you want your compilation job to connect 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

compilationJobName

CreateCompilationJobRequest.Builder compilationJobName(String compilationJobName)

A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.

Parameters:

compilationJobName - A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.

Returns:

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

roleArn

CreateCompilationJobRequest.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 compilation, 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 compilation, 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.

modelPackageVersionArn

CreateCompilationJobRequest.Builder modelPackageVersionArn(String modelPackageVersionArn)

The Amazon Resource Name (ARN) of a versioned model package. Provide either a ModelPackageVersionArn or an InputConfig object in the request syntax. The presence of both objects in the CreateCompilationJob request will return an exception.

Parameters:

modelPackageVersionArn - The Amazon Resource Name (ARN) of a versioned model package. Provide either a ModelPackageVersionArn or an InputConfig object in the request syntax. The presence of both objects in the CreateCompilationJob request will return an exception.

Returns:

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

inputConfig

CreateCompilationJobRequest.Builder inputConfig(InputConfig inputConfig)

Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

Parameters:

inputConfig - Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

Returns:

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

inputConfig

default CreateCompilationJobRequest.Builder inputConfig(Consumer<InputConfig.Builder> inputConfig)

Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

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

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

Parameters:

inputConfig - a consumer that will call methods on InputConfig.Builder

Returns:

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

See Also:

• inputConfig(InputConfig)

outputConfig

CreateCompilationJobRequest.Builder outputConfig(OutputConfig outputConfig)

Provides information about the output location for the compiled model and the target device the model runs on.

Parameters:

outputConfig - Provides information about the output location for the compiled model and the target device the model runs on.

Returns:

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

outputConfig

default CreateCompilationJobRequest.Builder outputConfig(Consumer<OutputConfig.Builder> outputConfig)

Provides information about the output location for the compiled model and the target device the model runs on.

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

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

Parameters:

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

Returns:

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

See Also:

• outputConfig(OutputConfig)

vpcConfig

CreateCompilationJobRequest.Builder vpcConfig(NeoVpcConfig vpcConfig)

A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

Parameters:

vpcConfig - A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

Returns:

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

vpcConfig

default CreateCompilationJobRequest.Builder vpcConfig(Consumer<NeoVpcConfig.Builder> vpcConfig)

A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

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

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

Parameters:

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

Returns:

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

See Also:

• vpcConfig(NeoVpcConfig)

stoppingCondition

CreateCompilationJobRequest.Builder stoppingCondition(StoppingCondition stoppingCondition)

Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

Parameters:

stoppingCondition - Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

Returns:

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

stoppingCondition

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

Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

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

CreateCompilationJobRequest.Builder tags(Collection<Tag> tags)

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

Parameters:

tags - An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

Returns:

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

tags

CreateCompilationJobRequest.Builder tags(Tag... tags)

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

Parameters:

tags - An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

Returns:

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

tags

CreateCompilationJobRequest.Builder tags(Consumer<Tag.Builder>... tags)

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

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

overrideConfiguration

CreateCompilationJobRequest.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

CreateCompilationJobRequest.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.