CreateSolutionVersionCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { PersonalizeClient, CreateSolutionVersionCommand } from "@aws-sdk/client-personalize"; // ES Modules import
// const { PersonalizeClient, CreateSolutionVersionCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
const client = new PersonalizeClient(config);
const input = { // CreateSolutionVersionRequest
  name: "STRING_VALUE",
  solutionArn: "STRING_VALUE", // required
  trainingMode: "FULL" || "UPDATE" || "AUTOTRAIN",
  tags: [ // Tags
    { // Tag
      tagKey: "STRING_VALUE", // required
      tagValue: "STRING_VALUE", // required
    },
  ],
};
const command = new CreateSolutionVersionCommand(input);
const response = await client.send(command);
// { // CreateSolutionVersionResponse
//   solutionVersionArn: "STRING_VALUE",
// };

CreateSolutionVersionCommand Input

See CreateSolutionVersionCommandInput for more details

Parameter
Type
Description
solutionArn
Required
string | undefined

The Amazon Resource Name (ARN) of the solution containing the training configuration information.

name
string | undefined

The name of the solution version.

tags
Tag[] | undefined

A list of tags  to apply to the solution version.

trainingMode
TrainingMode | undefined

The scope of training to be performed when creating the solution version. The default is FULL. This creates a completely new model based on the entirety of the training data from the datasets in your dataset group.

If you use User-Personalization , you can specify a training mode of UPDATE. This updates the model to consider new items for recommendations. It is not a full retraining. You should still complete a full retraining weekly. If you specify UPDATE, Amazon Personalize will stop automatic updates for the solution version. To resume updates, create a new solution with training mode set to FULL and deploy it in a campaign. For more information about automatic updates, see Automatic updates .

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 legacy HRNN-Coldstart  recipe.

CreateSolutionVersionCommand Output

See CreateSolutionVersionCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
solutionVersionArn
string | undefined

The ARN of the new solution version.

Throws

Name
Fault
Details
InvalidInputException
client

Provide a valid value for the field or parameter.

LimitExceededException
client

The limit on the number of requests per second has been exceeded.

ResourceAlreadyExistsException
client

The specified resource already exists.

ResourceInUseException
client

The specified resource is in use.

ResourceNotFoundException
client

Could not find the specified resource.

TooManyTagsException
client

You have exceeded the maximum number of tags you can apply to this resource.

PersonalizeServiceException
Base exception class for all service exceptions from Personalize service.