SolutionVersion
An object that provides information about a specific version of a Solution in a Custom dataset group.
Contents
- creationDateTime
-
The date and time (in Unix time) that this version of the solution was created.
Type: Timestamp
Required: No
- datasetGroupArn
-
The Amazon Resource Name (ARN) of the dataset group providing the training data.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):personalize:.*:.*:.+
Required: No
- eventType
-
The event type (for example, 'click' or 'like') that is used for training the model.
Type: String
Length Constraints: Maximum length of 256.
Required: No
- failureReason
-
If training a solution version fails, the reason for the failure.
Type: String
Required: No
- lastUpdatedDateTime
-
The date and time (in Unix time) that the solution was last updated.
Type: Timestamp
Required: No
- name
-
The name of the solution version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9\-_]*
Required: No
- performAutoML
-
When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses
recipeArn
.Type: Boolean
Required: No
- performHPO
-
Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is
false
.Type: Boolean
Required: No
- recipeArn
-
The ARN of the recipe used in the solution.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):personalize:.*:.*:.+
Required: No
- solutionArn
-
The ARN of the solution.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):personalize:.*:.*:.+
Required: No
- solutionConfig
-
Describes the configuration properties for the solution.
Type: SolutionConfig object
Required: No
- solutionVersionArn
-
The ARN of the solution version.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):personalize:.*:.*:.+
Required: No
- 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
Type: String
Length Constraints: Maximum length of 256.
Required: No
-
- 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.
Type: Double
Valid Range: Minimum value of 0.
Required: No
- 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.Important
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.Type: String
Valid Values:
FULL | UPDATE
Required: No
- tunedHPOParams
-
If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.
Type: TunedHPOParams object
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: