Interface SolutionVersion.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<SolutionVersion.Builder,
,SolutionVersion> SdkBuilder<SolutionVersion.Builder,
,SolutionVersion> SdkPojo
- Enclosing class:
SolutionVersion
-
Method Summary
Modifier and TypeMethodDescriptioncreationDateTime
(Instant creationDateTime) The date and time (in Unix time) that this version of the solution was created.datasetGroupArn
(String datasetGroupArn) The Amazon Resource Name (ARN) of the dataset group providing the training data.The event type (for example, 'click' or 'like') that is used for training the model.failureReason
(String failureReason) If training a solution version fails, the reason for the failure.lastUpdatedDateTime
(Instant lastUpdatedDateTime) The date and time (in Unix time) that the solution was last updated.The name of the solution version.performAutoML
(Boolean performAutoML) When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration.performHPO
(Boolean performHPO) Whether to perform hyperparameter optimization (HPO) on the chosen recipe.The ARN of the recipe used in the solution.solutionArn
(String solutionArn) The ARN of the solution.default SolutionVersion.Builder
solutionConfig
(Consumer<SolutionConfig.Builder> solutionConfig) Describes the configuration properties for the solution.solutionConfig
(SolutionConfig solutionConfig) Describes the configuration properties for the solution.solutionVersionArn
(String solutionVersionArn) The ARN of the solution version.The status of the solution version.trainingHours
(Double trainingHours) The time used to train the model.trainingMode
(String trainingMode) The scope of training to be performed when creating the solution version.trainingMode
(TrainingMode trainingMode) The scope of training to be performed when creating the solution version.default SolutionVersion.Builder
tunedHPOParams
(Consumer<TunedHPOParams.Builder> tunedHPOParams) If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.tunedHPOParams
(TunedHPOParams tunedHPOParams) If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
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
-
name
The name of the solution version.
- Parameters:
name
- The name of the solution version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
solutionVersionArn
The ARN of the solution version.
- Parameters:
solutionVersionArn
- The ARN of the solution version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
solutionArn
The ARN of the solution.
- Parameters:
solutionArn
- The ARN of the solution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
performHPO
Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is
false
.- Parameters:
performHPO
- Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default isfalse
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
performAutoML
When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses
recipeArn
.- Parameters:
performAutoML
- When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize usesrecipeArn
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
recipeArn
The ARN of the recipe used in the solution.
- Parameters:
recipeArn
- The ARN of the recipe used in the solution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
eventType
The event type (for example, 'click' or 'like') that is used for training the model.
- Parameters:
eventType
- The event type (for example, 'click' or 'like') that is used for training the model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
datasetGroupArn
The Amazon Resource Name (ARN) of the dataset group providing the training data.
- Parameters:
datasetGroupArn
- The Amazon Resource Name (ARN) of the dataset group providing the training data.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
solutionConfig
Describes the configuration properties for the solution.
- Parameters:
solutionConfig
- Describes the configuration properties for the solution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
solutionConfig
Describes the configuration properties for the solution.
This is a convenience method that creates an instance of theSolutionConfig.Builder
avoiding the need to create one manually viaSolutionConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosolutionConfig(SolutionConfig)
.- Parameters:
solutionConfig
- a consumer that will call methods onSolutionConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
trainingHours
The time used to train the model. You are billed for the time it takes to train a model. This field is visible only after Amazon Personalize successfully trains a model.
- Parameters:
trainingHours
- The time used to train the model. You are billed for the time it takes to train a model. This field is visible only after Amazon Personalize successfully trains a model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
trainingMode
The scope of training to be performed when creating the solution version. The
FULL
option trains the solution version based on the entirety of the input solution's training data, while theUPDATE
option processes only the data that has changed in comparison to the input solution. ChooseUPDATE
when you want to incrementally update your solution version instead of creating an entirely new one.The
UPDATE
option can only be used when you already have an active solution version created from the input solution using theFULL
option and the input solution was trained with the User-Personalization recipe or the HRNN-Coldstart recipe.- Parameters:
trainingMode
- The scope of training to be performed when creating the solution version. TheFULL
option trains the solution version based on the entirety of the input solution's training data, while theUPDATE
option processes only the data that has changed in comparison to the input solution. ChooseUPDATE
when you want to incrementally update your solution version instead of creating an entirely new one.The
UPDATE
option can only be used when you already have an active solution version created from the input solution using theFULL
option and the input solution was trained with the User-Personalization recipe or the HRNN-Coldstart recipe.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
trainingMode
The scope of training to be performed when creating the solution version. The
FULL
option trains the solution version based on the entirety of the input solution's training data, while theUPDATE
option processes only the data that has changed in comparison to the input solution. ChooseUPDATE
when you want to incrementally update your solution version instead of creating an entirely new one.The
UPDATE
option can only be used when you already have an active solution version created from the input solution using theFULL
option and the input solution was trained with the User-Personalization recipe or the HRNN-Coldstart recipe.- Parameters:
trainingMode
- The scope of training to be performed when creating the solution version. TheFULL
option trains the solution version based on the entirety of the input solution's training data, while theUPDATE
option processes only the data that has changed in comparison to the input solution. ChooseUPDATE
when you want to incrementally update your solution version instead of creating an entirely new one.The
UPDATE
option can only be used when you already have an active solution version created from the input solution using theFULL
option and the input solution was trained with the User-Personalization recipe or the HRNN-Coldstart recipe.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tunedHPOParams
If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.
- Parameters:
tunedHPOParams
- If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tunedHPOParams
If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.
This is a convenience method that creates an instance of theTunedHPOParams.Builder
avoiding the need to create one manually viaTunedHPOParams.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totunedHPOParams(TunedHPOParams)
.- Parameters:
tunedHPOParams
- a consumer that will call methods onTunedHPOParams.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The status of the solution version.
A solution version can be in one of the following states:
-
CREATE PENDING
-
CREATE IN_PROGRESS
-
ACTIVE
-
CREATE FAILED
-
CREATE STOPPING
-
CREATE STOPPED
- Parameters:
status
- The status of the solution version.A solution version can be in one of the following states:
-
CREATE PENDING
-
CREATE IN_PROGRESS
-
ACTIVE
-
CREATE FAILED
-
CREATE STOPPING
-
CREATE STOPPED
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
failureReason
If training a solution version fails, the reason for the failure.
- Parameters:
failureReason
- If training a solution version fails, the reason for the failure.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
creationDateTime
The date and time (in Unix time) that this version of the solution was created.
- Parameters:
creationDateTime
- The date and time (in Unix time) that this version of the solution was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastUpdatedDateTime
The date and time (in Unix time) that the solution was last updated.
- Parameters:
lastUpdatedDateTime
- The date and time (in Unix time) that the solution was last updated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-