| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Personalize.CreateSolutionVersion
Description
Trains or retrains an active solution in a Custom dataset group. A
solution is created using the
CreateSolution
operation and must be in the ACTIVE state before calling
CreateSolutionVersion. A new version of the solution is created every
time you call this operation.
Status
A solution version can be in one of the following states:
- CREATE PENDING
- CREATE IN_PROGRESS
- ACTIVE
- CREATE FAILED
- CREATE STOPPING
- CREATE STOPPED
To get the status of the version, call
DescribeSolutionVersion.
Wait until the status shows as ACTIVE before calling CreateCampaign.
If the status shows as CREATE FAILED, the response includes a
failureReason key, which describes why the job failed.
Related APIs
Synopsis
- data CreateSolutionVersion = CreateSolutionVersion' {
- name :: Maybe Text
- tags :: Maybe [Tag]
- trainingMode :: Maybe TrainingMode
- solutionArn :: Text
- newCreateSolutionVersion :: Text -> CreateSolutionVersion
- createSolutionVersion_name :: Lens' CreateSolutionVersion (Maybe Text)
- createSolutionVersion_tags :: Lens' CreateSolutionVersion (Maybe [Tag])
- createSolutionVersion_trainingMode :: Lens' CreateSolutionVersion (Maybe TrainingMode)
- createSolutionVersion_solutionArn :: Lens' CreateSolutionVersion Text
- data CreateSolutionVersionResponse = CreateSolutionVersionResponse' {}
- newCreateSolutionVersionResponse :: Int -> CreateSolutionVersionResponse
- createSolutionVersionResponse_solutionVersionArn :: Lens' CreateSolutionVersionResponse (Maybe Text)
- createSolutionVersionResponse_httpStatus :: Lens' CreateSolutionVersionResponse Int
Creating a Request
data CreateSolutionVersion Source #
See: newCreateSolutionVersion smart constructor.
Constructors
| CreateSolutionVersion' | |
Fields
| |
Instances
newCreateSolutionVersion Source #
Arguments
| :: Text | |
| -> CreateSolutionVersion |
Create a value of CreateSolutionVersion 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:
CreateSolutionVersion, createSolutionVersion_name - The name of the solution version.
$sel:tags:CreateSolutionVersion', createSolutionVersion_tags - A list of
tags
to apply to the solution version.
CreateSolutionVersion, createSolutionVersion_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.
CreateSolutionVersion, createSolutionVersion_solutionArn - The Amazon Resource Name (ARN) of the solution containing the training
configuration information.
Request Lenses
createSolutionVersion_name :: Lens' CreateSolutionVersion (Maybe Text) Source #
The name of the solution version.
createSolutionVersion_tags :: Lens' CreateSolutionVersion (Maybe [Tag]) Source #
A list of tags to apply to the solution version.
createSolutionVersion_trainingMode :: Lens' CreateSolutionVersion (Maybe TrainingMode) Source #
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.
createSolutionVersion_solutionArn :: Lens' CreateSolutionVersion Text Source #
The Amazon Resource Name (ARN) of the solution containing the training configuration information.
Destructuring the Response
data CreateSolutionVersionResponse Source #
See: newCreateSolutionVersionResponse smart constructor.
Constructors
| CreateSolutionVersionResponse' | |
Fields
| |
Instances
newCreateSolutionVersionResponse Source #
Create a value of CreateSolutionVersionResponse 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:
CreateSolutionVersionResponse, createSolutionVersionResponse_solutionVersionArn - The ARN of the new solution version.
$sel:httpStatus:CreateSolutionVersionResponse', createSolutionVersionResponse_httpStatus - The response's http status code.
Response Lenses
createSolutionVersionResponse_solutionVersionArn :: Lens' CreateSolutionVersionResponse (Maybe Text) Source #
The ARN of the new solution version.
createSolutionVersionResponse_httpStatus :: Lens' CreateSolutionVersionResponse Int Source #
The response's http status code.