Interface CreateAiRecommendationJobRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateAiRecommendationJobRequest

@Mutable
@NotThreadSafe
public static interface CreateAiRecommendationJobRequest.Builder
extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<CreateAiRecommendationJobRequest.Builder,CreateAiRecommendationJobRequest>

Method Summary

Modifier and Type	Method	Description
CreateAiRecommendationJobRequest.Builder	aiRecommendationJobName(String aiRecommendationJobName)	The name of the AI recommendation job.
CreateAiRecommendationJobRequest.Builder	aiWorkloadConfigIdentifier(String aiWorkloadConfigIdentifier)	The name or Amazon Resource Name (ARN) of the AI workload configuration to use for this recommendation job.
default CreateAiRecommendationJobRequest.Builder	computeSpec(Consumer<AIRecommendationComputeSpec.Builder> computeSpec)	The compute resource specification for the recommendation job.
CreateAiRecommendationJobRequest.Builder	computeSpec(AIRecommendationComputeSpec computeSpec)	The compute resource specification for the recommendation job.
default CreateAiRecommendationJobRequest.Builder	inferenceSpecification(Consumer<AIRecommendationInferenceSpecification.Builder> inferenceSpecification)	The inference framework configuration.
CreateAiRecommendationJobRequest.Builder	inferenceSpecification(AIRecommendationInferenceSpecification inferenceSpecification)	The inference framework configuration.
default CreateAiRecommendationJobRequest.Builder	modelSource(Consumer<AIModelSource.Builder> modelSource)	The source of the model to optimize.
CreateAiRecommendationJobRequest.Builder	modelSource(AIModelSource modelSource)	The source of the model to optimize.
CreateAiRecommendationJobRequest.Builder	optimizeModel(Boolean optimizeModel)	Whether to allow model optimization techniques such as quantization, speculative decoding, and kernel tuning.
default CreateAiRecommendationJobRequest.Builder	outputConfig(Consumer<AIRecommendationOutputConfig.Builder> outputConfig)	The output configuration for the recommendation job, including the Amazon S3 location for results and an optional model package group where the optimized model is registered.
CreateAiRecommendationJobRequest.Builder	outputConfig(AIRecommendationOutputConfig outputConfig)	The output configuration for the recommendation job, including the Amazon S3 location for results and an optional model package group where the optimized model is registered.
CreateAiRecommendationJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateAiRecommendationJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateAiRecommendationJobRequest.Builder	performanceTarget(Consumer<AIRecommendationPerformanceTarget.Builder> performanceTarget)	The performance targets for the recommendation job.
CreateAiRecommendationJobRequest.Builder	performanceTarget(AIRecommendationPerformanceTarget performanceTarget)	The performance targets for the recommendation job.
CreateAiRecommendationJobRequest.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.
CreateAiRecommendationJobRequest.Builder	tags(Collection<Tag> tags)	The metadata that you apply to Amazon Web Services resources to help you categorize and organize them.
CreateAiRecommendationJobRequest.Builder	tags(Consumer<Tag.Builder>... tags)	The metadata that you apply to Amazon Web Services resources to help you categorize and organize them.
CreateAiRecommendationJobRequest.Builder	tags(Tag... tags)	The metadata that you apply to Amazon Web Services resources to help you categorize and organize them.

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, sdkFieldNameToField, sdkFields

Method Details

aiRecommendationJobName

CreateAiRecommendationJobRequest.Builder aiRecommendationJobName(String aiRecommendationJobName)

The name of the AI recommendation job. The name must be unique within your Amazon Web Services account in the current Amazon Web Services Region.

Parameters:

aiRecommendationJobName - The name of the AI recommendation job. The name must be unique within your Amazon Web Services account in the current Amazon Web Services Region.

Returns:

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

modelSource

CreateAiRecommendationJobRequest.Builder modelSource(AIModelSource modelSource)

The source of the model to optimize. Specify the Amazon S3 location of the model artifacts.

Parameters:

modelSource - The source of the model to optimize. Specify the Amazon S3 location of the model artifacts.

Returns:

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

modelSource

default CreateAiRecommendationJobRequest.Builder modelSource(Consumer<AIModelSource.Builder> modelSource)

The source of the model to optimize. Specify the Amazon S3 location of the model artifacts.

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

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

Parameters:

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

Returns:

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

See Also:

• modelSource(AIModelSource)

outputConfig

CreateAiRecommendationJobRequest.Builder outputConfig(AIRecommendationOutputConfig outputConfig)

The output configuration for the recommendation job, including the Amazon S3 location for results and an optional model package group where the optimized model is registered.

Parameters:

outputConfig - The output configuration for the recommendation job, including the Amazon S3 location for results and an optional model package group where the optimized model is registered.

Returns:

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

outputConfig

default CreateAiRecommendationJobRequest.Builder outputConfig(Consumer<AIRecommendationOutputConfig.Builder> outputConfig)

The output configuration for the recommendation job, including the Amazon S3 location for results and an optional model package group where the optimized model is registered.

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

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

Parameters:

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

Returns:

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

See Also:

• outputConfig(AIRecommendationOutputConfig)

aiWorkloadConfigIdentifier

CreateAiRecommendationJobRequest.Builder aiWorkloadConfigIdentifier(String aiWorkloadConfigIdentifier)

The name or Amazon Resource Name (ARN) of the AI workload configuration to use for this recommendation job.

Parameters:

aiWorkloadConfigIdentifier - The name or Amazon Resource Name (ARN) of the AI workload configuration to use for this recommendation job.

Returns:

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

performanceTarget

CreateAiRecommendationJobRequest.Builder performanceTarget(AIRecommendationPerformanceTarget performanceTarget)

The performance targets for the recommendation job. Specify constraints on metrics such as time to first token (ttft-ms), throughput, or cost.

Parameters:

performanceTarget - The performance targets for the recommendation job. Specify constraints on metrics such as time to first token (ttft-ms), throughput, or cost.

Returns:

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

performanceTarget

default CreateAiRecommendationJobRequest.Builder performanceTarget(Consumer<AIRecommendationPerformanceTarget.Builder> performanceTarget)

The performance targets for the recommendation job. Specify constraints on metrics such as time to first token (ttft-ms), throughput, or cost.

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

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

Parameters:

performanceTarget - a consumer that will call methods on AIRecommendationPerformanceTarget.Builder

Returns:

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

See Also:

• performanceTarget(AIRecommendationPerformanceTarget)

roleArn

CreateAiRecommendationJobRequest.Builder roleArn(String roleArn)

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

Parameters:

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

Returns:

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

inferenceSpecification

CreateAiRecommendationJobRequest.Builder inferenceSpecification(AIRecommendationInferenceSpecification inferenceSpecification)

The inference framework configuration. Specify the framework (such as LMI or vLLM) for the recommendation job.

Parameters:

inferenceSpecification - The inference framework configuration. Specify the framework (such as LMI or vLLM) for the recommendation job.

Returns:

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

inferenceSpecification

default CreateAiRecommendationJobRequest.Builder inferenceSpecification(Consumer<AIRecommendationInferenceSpecification.Builder> inferenceSpecification)

The inference framework configuration. Specify the framework (such as LMI or vLLM) for the recommendation job.

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

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

Parameters:

inferenceSpecification - a consumer that will call methods on AIRecommendationInferenceSpecification.Builder

Returns:

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

See Also:

• inferenceSpecification(AIRecommendationInferenceSpecification)

optimizeModel

CreateAiRecommendationJobRequest.Builder optimizeModel(Boolean optimizeModel)

Whether to allow model optimization techniques such as quantization, speculative decoding, and kernel tuning. The default is true.

Parameters:

optimizeModel - Whether to allow model optimization techniques such as quantization, speculative decoding, and kernel tuning. The default is true.

Returns:

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

computeSpec

CreateAiRecommendationJobRequest.Builder computeSpec(AIRecommendationComputeSpec computeSpec)

The compute resource specification for the recommendation job. You can specify up to 3 instance types to consider, and optionally provide capacity reservation configuration.

Parameters:

computeSpec - The compute resource specification for the recommendation job. You can specify up to 3 instance types to consider, and optionally provide capacity reservation configuration.

Returns:

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

computeSpec

default CreateAiRecommendationJobRequest.Builder computeSpec(Consumer<AIRecommendationComputeSpec.Builder> computeSpec)

The compute resource specification for the recommendation job. You can specify up to 3 instance types to consider, and optionally provide capacity reservation configuration.

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

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

Parameters:

computeSpec - a consumer that will call methods on AIRecommendationComputeSpec.Builder

Returns:

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

See Also:

• computeSpec(AIRecommendationComputeSpec)

tags

CreateAiRecommendationJobRequest.Builder tags(Collection<Tag> tags)

The metadata that you apply to Amazon Web Services resources to help you categorize and organize them.

Parameters:

tags - The metadata that you apply to Amazon Web Services resources to help you categorize and organize them.

Returns:

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

tags

CreateAiRecommendationJobRequest.Builder tags(Tag... tags)

The metadata that you apply to Amazon Web Services resources to help you categorize and organize them.

Parameters:

tags - The metadata that you apply to Amazon Web Services resources to help you categorize and organize them.

Returns:

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

tags

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

The metadata that you apply to Amazon Web Services resources to help you categorize and organize them.

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

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

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