software.amazon.awssdk.services.personalize.model

Interface CreateSolutionRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateSolutionRequest.Builder,CreateSolutionRequest>, PersonalizeRequest.Builder, SdkBuilder<CreateSolutionRequest.Builder,CreateSolutionRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateSolutionRequest

public static interface CreateSolutionRequest.Builder
extends PersonalizeRequest.Builder, SdkPojo, CopyableBuilder<CreateSolutionRequest.Builder,CreateSolutionRequest>

Method Summary

Modifier and Type	Method and Description
CreateSolutionRequest.Builder	datasetGroupArn(String datasetGroupArn) The Amazon Resource Name (ARN) of the dataset group that provides the training data.
CreateSolutionRequest.Builder	eventType(String eventType) When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.
CreateSolutionRequest.Builder	name(String name) The name for the solution.
CreateSolutionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateSolutionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateSolutionRequest.Builder	performAutoML(Boolean performAutoML) Whether to perform automated machine learning (AutoML).
CreateSolutionRequest.Builder	performHPO(Boolean performHPO) Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe.
CreateSolutionRequest.Builder	recipeArn(String recipeArn) The ARN of the recipe to use for model training.
default CreateSolutionRequest.Builder	solutionConfig(Consumer<SolutionConfig.Builder> solutionConfig) The configuration to use with the solution.
CreateSolutionRequest.Builder	solutionConfig(SolutionConfig solutionConfig) The configuration to use with the solution.
CreateSolutionRequest.Builder	tags(Collection<Tag> tags) A list of tags to apply to the solution.
CreateSolutionRequest.Builder	tags(Consumer<Tag.Builder>... tags) A list of tags to apply to the solution.
CreateSolutionRequest.Builder	tags(Tag... tags) A list of tags to apply to the solution.

Methods inherited from interface software.amazon.awssdk.services.personalize.model.PersonalizeRequest.Builder

build

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

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

name

CreateSolutionRequest.Builder name(String name)

The name for the solution.

Parameters:

name - The name for the solution.

Returns:

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

performHPO

CreateSolutionRequest.Builder performHPO(Boolean performHPO)

Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is false.

When performing AutoML, this parameter is always true and you should not set it to false.

Parameters:

performHPO - Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is false.

When performing AutoML, this parameter is always true and you should not set it to false.

Returns:

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

performAutoML

CreateSolutionRequest.Builder performAutoML(Boolean performAutoML)

Whether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn.

When set to true, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.

Parameters:

performAutoML - Whether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn.

When set to true, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.

Returns:

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

recipeArn

CreateSolutionRequest.Builder recipeArn(String recipeArn)

The ARN of the recipe to use for model training. Only specified when performAutoML is false.

Parameters:

recipeArn - The ARN of the recipe to use for model training. Only specified when performAutoML is false.

Returns:

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

datasetGroupArn

CreateSolutionRequest.Builder datasetGroupArn(String datasetGroupArn)

The Amazon Resource Name (ARN) of the dataset group that provides the training data.

Parameters:

datasetGroupArn - The Amazon Resource Name (ARN) of the dataset group that provides the training data.

Returns:

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

eventType

CreateSolutionRequest.Builder eventType(String eventType)

When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.

If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.

Parameters:

eventType - When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.

If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.

Returns:

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

solutionConfig

CreateSolutionRequest.Builder solutionConfig(SolutionConfig solutionConfig)

The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.

Amazon Personalize doesn't support configuring the hpoObjective at this time.

Parameters:

solutionConfig - The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.

Amazon Personalize doesn't support configuring the hpoObjective at this time.

Returns:

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

solutionConfig

default CreateSolutionRequest.Builder solutionConfig(Consumer<SolutionConfig.Builder> solutionConfig)

The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.

Amazon Personalize doesn't support configuring the hpoObjective at this time.

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

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

Parameters:

solutionConfig - a consumer that will call methods on SolutionConfig.Builder

Returns:

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

See Also:

solutionConfig(SolutionConfig)

tags

CreateSolutionRequest.Builder tags(Collection<Tag> tags)

A list of tags to apply to the solution.

Parameters:

tags - A list of tags to apply to the solution.

Returns:

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

tags

CreateSolutionRequest.Builder tags(Tag... tags)

A list of tags to apply to the solution.

Parameters:

tags - A list of tags to apply to the solution.

Returns:

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

tags

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

A list of tags to apply to the solution.

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

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)

overrideConfiguration

CreateSolutionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder