Class Solution
- java.lang.Object
-
- software.amazon.awssdk.services.personalize.model.Solution
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Solution.Builder,Solution>
@Generated("software.amazon.awssdk:codegen") public final class Solution extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Solution.Builder,Solution>
After you create a solution, you can’t change its configuration. By default, all new solutions use automatic training. With automatic training, you incur training costs while your solution is active. You can't stop automatic training for a solution. To avoid unnecessary costs, make sure to delete the solution when you are finished. For information about training costs, see Amazon Personalize pricing.
An object that provides information about a solution. A solution includes the custom recipe, customized parameters, and trained models (Solution Versions) that Amazon Personalize uses to generate recommendations.
After you create a solution, you can’t change its configuration. If you need to make changes, you can clone the solution with the Amazon Personalize console or create a new one.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceSolution.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AutoMLResultautoMLResult()WhenperformAutoMLis true, specifies the best recipe found.static Solution.Builderbuilder()InstantcreationDateTime()The creation date and time (in Unix time) of the solution.StringdatasetGroupArn()The Amazon Resource Name (ARN) of the dataset group that provides the training data.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringeventType()The event type (for example, 'click' or 'like') that is used for training the model.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()InstantlastUpdatedDateTime()The date and time (in Unix time) that the solution was last updated.SolutionVersionSummarylatestSolutionVersion()Describes the latest version of the solution, including the status and the ARN.Stringname()The name of the solution.BooleanperformAutoML()BooleanperformAutoTraining()Specifies whether the solution automatically creates solution versions.BooleanperformHPO()Whether to perform hyperparameter optimization (HPO) on the chosen recipe.StringrecipeArn()The ARN of the recipe used to create the solution.List<SdkField<?>>sdkFields()static Class<? extends Solution.Builder>serializableBuilderClass()StringsolutionArn()The ARN of the solution.SolutionConfigsolutionConfig()Describes the configuration properties for the solution.Stringstatus()The status of the solution.Solution.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
name
public final String name()
The name of the solution.
- Returns:
- The name of the solution.
-
solutionArn
public final String solutionArn()
The ARN of the solution.
- Returns:
- The ARN of the solution.
-
performHPO
public final Boolean 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
public final Boolean performAutoML()
We don't recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize recipes. For more information, see Determining your use case.
When true, Amazon Personalize performs a search for the best USER_PERSONALIZATION recipe from the list specified in the solution configuration (
recipeArnmust not be specified). When false (the default), Amazon Personalize usesrecipeArnfor training.- Returns:
We don't recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize recipes. For more information, see Determining your use case.
When true, Amazon Personalize performs a search for the best USER_PERSONALIZATION recipe from the list specified in the solution configuration (
recipeArnmust not be specified). When false (the default), Amazon Personalize usesrecipeArnfor training.
-
performAutoTraining
public final Boolean performAutoTraining()
Specifies whether the solution automatically creates solution versions. The default is
Trueand the solution automatically creates new solution versions every 7 days.For more information about auto training, see Creating and configuring a solution.
- Returns:
- Specifies whether the solution automatically creates solution versions. The default is
Trueand the solution automatically creates new solution versions every 7 days.For more information about auto training, see Creating and configuring a solution.
-
recipeArn
public final String recipeArn()
The ARN of the recipe used to create the solution. This is required when
performAutoMLis false.- Returns:
- The ARN of the recipe used to create the solution. This is required when
performAutoMLis false.
-
datasetGroupArn
public final String datasetGroupArn()
The Amazon Resource Name (ARN) of the dataset group that provides the training data.
- Returns:
- The Amazon Resource Name (ARN) of the dataset group that provides the training data.
-
eventType
public final String eventType()
The event type (for example, 'click' or 'like') that is used for training the model. If no
eventTypeis provided, Amazon Personalize uses all interactions for training with equal weight regardless of type.- Returns:
- The event type (for example, 'click' or 'like') that is used for training the model. If no
eventTypeis provided, Amazon Personalize uses all interactions for training with equal weight regardless of type.
-
solutionConfig
public final SolutionConfig solutionConfig()
Describes the configuration properties for the solution.
- Returns:
- Describes the configuration properties for the solution.
-
autoMLResult
public final AutoMLResult autoMLResult()
When
performAutoMLis true, specifies the best recipe found.- Returns:
- When
performAutoMLis true, specifies the best recipe found.
-
status
public final String status()
The status of the solution.
A solution can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
DELETE PENDING > DELETE IN_PROGRESS
- Returns:
- The status of the solution.
A solution can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
DELETE PENDING > DELETE IN_PROGRESS
-
-
-
creationDateTime
public final Instant creationDateTime()
The creation date and time (in Unix time) of the solution.
- Returns:
- The creation date and time (in Unix time) of the solution.
-
lastUpdatedDateTime
public final Instant 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.
-
latestSolutionVersion
public final SolutionVersionSummary latestSolutionVersion()
Describes the latest version of the solution, including the status and the ARN.
- Returns:
- Describes the latest version of the solution, including the status and the ARN.
-
toBuilder
public Solution.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Solution.Builder,Solution>
-
builder
public static Solution.Builder builder()
-
serializableBuilderClass
public static Class<? extends Solution.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String 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.
-
-