Documentation

An object that provides information about a specific version of a Solution in a Custom dataset group.

See: newSolutionVersion smart constructor.

Create a value of SolutionVersion with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:creationDateTime:SolutionVersion', solutionVersion_creationDateTime - The date and time (in Unix time) that this version of the solution was created.

$sel:datasetGroupArn:SolutionVersion', solutionVersion_datasetGroupArn - The Amazon Resource Name (ARN) of the dataset group providing the training data.

$sel:eventType:SolutionVersion', solutionVersion_eventType - The event type (for example, 'click' or 'like') that is used for training the model.

$sel:failureReason:SolutionVersion', solutionVersion_failureReason - If training a solution version fails, the reason for the failure.

$sel:lastUpdatedDateTime:SolutionVersion', solutionVersion_lastUpdatedDateTime - The date and time (in Unix time) that the solution was last updated.

$sel:name:SolutionVersion', solutionVersion_name - The name of the solution version.

$sel:performAutoML:SolutionVersion', solutionVersion_performAutoML - When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses recipeArn.

$sel:performHPO:SolutionVersion', solutionVersion_performHPO - Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.

$sel:recipeArn:SolutionVersion', solutionVersion_recipeArn - The ARN of the recipe used in the solution.

$sel:solutionArn:SolutionVersion', solutionVersion_solutionArn - The ARN of the solution.

$sel:solutionConfig:SolutionVersion', solutionVersion_solutionConfig - Describes the configuration properties for the solution.

$sel:solutionVersionArn:SolutionVersion', solutionVersion_solutionVersionArn - The ARN of the solution version.

$sel:status:SolutionVersion', solutionVersion_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

$sel:trainingHours:SolutionVersion', solutionVersion_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.

$sel:trainingMode:SolutionVersion', solutionVersion_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 the UPDATE option processes only the data that has changed in comparison to the input solution. Choose UPDATE 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 the FULL option and the input solution was trained with the User-Personalization recipe or the HRNN-Coldstart recipe.

$sel:tunedHPOParams:SolutionVersion', solutionVersion_tunedHPOParams - If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.

The date and time (in Unix time) that this version of the solution was created.

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.

If training a solution version fails, the reason for the failure.

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

The name of the solution version.

When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses recipeArn.

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

The ARN of the recipe used in the solution.

The ARN of the solution.

Describes the configuration properties for the solution.

The ARN of the solution version.

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

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.

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 the UPDATE option processes only the data that has changed in comparison to the input solution. Choose UPDATE 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 the FULL option and the input solution was trained with the User-Personalization recipe or the HRNN-Coldstart recipe.

If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.