Skip to content

Solution

Source code in docs_src/capo_personalize/types/solution.py
class Solution(TypedDict, closed=True):
    name: NotRequired["capo_personalize.types.name.Name"]
    """<p>The name of the solution.</p>"""
    solution_arn: NotRequired["capo_personalize.types.arn.Arn"]
    """<p>The ARN of the solution.</p>"""
    perform_hpo: "capo_personalize.types.perform_hpo.PerformHPO"
    """<p>Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is <code>false</code>.</p>"""
    perform_auto_ml: "capo_personalize.types.perform_auto_ml.PerformAutoML"
    """<important> <p>We don't recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize recipes. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/determining-use-case.html">Determining your use case.</a> </p> </important> <p>When true, Amazon Personalize performs a search for the best USER_PERSONALIZATION recipe from the list specified in the solution configuration (<code>recipeArn</code> must not be specified). When false (the default), Amazon Personalize uses <code>recipeArn</code> for training.</p>"""
    perform_auto_training: NotRequired[
        "capo_personalize.types.perform_auto_training.PerformAutoTraining"
    ]
    """<p>Specifies whether the solution automatically creates solution versions. The default is <code>True</code> and the solution automatically creates new solution versions every 7 days.</p> <p>For more information about auto training, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html">Creating and configuring a solution</a>.</p>"""
    perform_incremental_update: NotRequired[
        "capo_personalize.types.perform_incremental_update.PerformIncrementalUpdate"
    ]
    """<p>A Boolean value that indicates whether incremental training updates are performed on the model. When enabled, this allows the model to learn from new data more frequently without requiring full retraining, which enables near real-time personalization. This parameter is supported only for solutions that use the semantic-similarity recipe</p>"""
    recipe_arn: NotRequired["capo_personalize.types.arn.Arn"]
    """<p>The ARN of the recipe used to create the solution. This is required when <code>performAutoML</code> is false.</p>"""
    dataset_group_arn: NotRequired["capo_personalize.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the dataset group that provides the training data.</p>"""
    event_type: NotRequired["capo_personalize.types.event_type.EventType"]
    """<p>The event type (for example, 'click' or 'like') that is used for training the model. If no <code>eventType</code> is provided, Amazon Personalize uses all interactions for training with equal weight regardless of type.</p>"""
    solution_config: NotRequired[
        "capo_personalize.types.solution_config.SolutionConfig"
    ]
    """<p>Describes the configuration properties for the solution.</p>"""
    auto_ml_result: NotRequired["capo_personalize.types.auto_ml_result.AutoMLResult"]
    """<p>When <code>performAutoML</code> is true, specifies the best recipe found.</p>"""
    status: NotRequired["capo_personalize.types.status.Status"]
    """<p>The status of the solution.</p> <p>A solution can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING > DELETE IN_PROGRESS</p> </li> </ul>"""
    creation_date_time: NotRequired["capo_personalize.types.date.Date"]
    """<p>The creation date and time (in Unix time) of the solution.</p>"""
    last_updated_date_time: NotRequired["capo_personalize.types.date.Date"]
    """<p>The date and time (in Unix time) that the solution was last updated.</p>"""
    latest_solution_version: NotRequired[
        "capo_personalize.types.solution_version_summary.SolutionVersionSummary"
    ]
    """<p>Describes the latest version of the solution, including the status and the ARN.</p>"""
    latest_solution_update: NotRequired[
        "capo_personalize.types.solution_update_summary.SolutionUpdateSummary"
    ]
    """<p>Provides a summary of the latest updates to the solution.</p>"""

auto_ml_result instance-attribute

auto_ml_result: NotRequired[AutoMLResult]

When performAutoML is true, specifies the best recipe found.

creation_date_time instance-attribute

creation_date_time: NotRequired[Date]

The creation date and time (in Unix time) of the solution.

dataset_group_arn instance-attribute

dataset_group_arn: NotRequired[Arn]

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

event_type instance-attribute

event_type: NotRequired[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.

last_updated_date_time instance-attribute

last_updated_date_time: NotRequired[Date]

The date and time (in Unix time) that the solution was last updated.

latest_solution_update instance-attribute

latest_solution_update: NotRequired[SolutionUpdateSummary]

Provides a summary of the latest updates to the solution.

latest_solution_version instance-attribute

latest_solution_version: NotRequired[SolutionVersionSummary]

Describes the latest version of the solution, including the status and the ARN.

name instance-attribute

name: NotRequired[Name]

The name of the solution.

perform_auto_ml instance-attribute

perform_auto_ml: 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.

perform_auto_training instance-attribute

perform_auto_training: NotRequired[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.

perform_hpo instance-attribute

perform_hpo: PerformHPO

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

perform_incremental_update instance-attribute

perform_incremental_update: NotRequired[PerformIncrementalUpdate]

A Boolean value that indicates whether incremental training updates are performed on the model. When enabled, this allows the model to learn from new data more frequently without requiring full retraining, which enables near real-time personalization. This parameter is supported only for solutions that use the semantic-similarity recipe

recipe_arn instance-attribute

recipe_arn: NotRequired[Arn]

The ARN of the recipe used to create the solution. This is required when performAutoML is false.

solution_arn instance-attribute

solution_arn: NotRequired[Arn]

The ARN of the solution.

solution_config instance-attribute

solution_config: NotRequired[SolutionConfig]

Describes the configuration properties for the solution.

status instance-attribute

status: NotRequired[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