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>

By default, all new solutions use automatic training. With automatic training, you incur training costs while your solution is active. To avoid unnecessary costs, when you are finished you can update the solution to turn off automatic training. 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:

  • Method Details

    • 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 (recipeArn must not be specified). When false (the default), Amazon Personalize uses recipeArn for 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 (recipeArn must not be specified). When false (the default), Amazon Personalize uses recipeArn for training.

    • performAutoTraining

      public final Boolean performAutoTraining()

      Specifies whether the solution automatically creates solution versions. The default is True and 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 True and 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 performAutoML is false.

      Returns:
      The ARN of the recipe used to create the solution. This is required when performAutoML is 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 eventType is 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 eventType is 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 performAutoML is true, specifies the best recipe found.

      Returns:
      When performAutoML is 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.

    • latestSolutionUpdate

      public final SolutionUpdateSummary latestSolutionUpdate()

      Provides a summary of the latest updates to the solution.

      Returns:
      Provides a summary of the latest updates to the solution.

    • toBuilder

      public Solution.Builder 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 interface ToCopyableBuilder<Solution.Builder,Solution>
      Returns:
      a builder for type T

    • builder

      public static Solution.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Solution.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.