Class SolutionVersion
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SolutionVersion.Builder,
SolutionVersion>
An object that provides information about a specific version of a Solution in a Custom dataset group.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic SolutionVersion.Builder
builder()
final Instant
The date and time (in Unix time) that this version of the solution was created.final String
The Amazon Resource Name (ARN) of the dataset group providing the training data.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The event type (for example, 'click' or 'like') that is used for training the model.final String
If training a solution version fails, the reason for the failure.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Instant
The date and time (in Unix time) that the solution was last updated.final String
name()
The name of the solution version.final Boolean
When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration.final Boolean
Whether to perform hyperparameter optimization (HPO) on the chosen recipe.final String
The ARN of the recipe used in the solution.static Class
<? extends SolutionVersion.Builder> final String
The ARN of the solution.final SolutionConfig
Describes the configuration properties for the solution.final String
The ARN of the solution version.final String
status()
The status of the solution version.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Double
The time used to train the model.final TrainingMode
The scope of training to be performed when creating the solution version.final String
The scope of training to be performed when creating the solution version.final TunedHPOParams
If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the solution version.
- Returns:
- The name of the solution version.
-
solutionVersionArn
The ARN of the solution version.
- Returns:
- The ARN of the solution version.
-
solutionArn
The ARN of the solution.
- Returns:
- The ARN of the solution.
-
performHPO
Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is
false
.- Returns:
- Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is
false
.
-
performAutoML
When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses
recipeArn
.- Returns:
- When true, Amazon Personalize searches for the most optimal recipe according to the solution
configuration. When false (the default), Amazon Personalize uses
recipeArn
.
-
recipeArn
The ARN of the recipe used in the solution.
- Returns:
- The ARN of the recipe used in the solution.
-
eventType
The event type (for example, 'click' or 'like') that is used for training the model.
- Returns:
- The event type (for example, 'click' or 'like') that is used for training the model.
-
datasetGroupArn
The Amazon Resource Name (ARN) of the dataset group providing the training data.
- Returns:
- The Amazon Resource Name (ARN) of the dataset group providing the training data.
-
solutionConfig
Describes the configuration properties for the solution.
- Returns:
- Describes the configuration properties for the solution.
-
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:
- 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.
-
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.If the service returns an enum value that is not available in the current SDK version,
trainingMode
will returnTrainingMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtrainingModeAsString()
.- Returns:
- 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. - See Also:
-
trainingModeAsString
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.If the service returns an enum value that is not available in the current SDK version,
trainingMode
will returnTrainingMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtrainingModeAsString()
.- Returns:
- 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. - See Also:
-
tunedHPOParams
If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.
- Returns:
- If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.
-
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:
- 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
-
-
-
failureReason
If training a solution version fails, the reason for the failure.
- Returns:
- If training a solution version fails, the reason for the failure.
-
creationDateTime
The date and time (in Unix time) that this version of the solution was created.
- Returns:
- The date and time (in Unix time) that this version of the solution was created.
-
lastUpdatedDateTime
The date and time (in Unix time) that the solution was last updated.
- Returns:
- The date and time (in Unix time) that the solution was last updated.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<SolutionVersion.Builder,
SolutionVersion> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-