Personalize / Client / create_solution_version

create_solution_version#

Personalize.Client.create_solution_version(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.create_solution_version(
    name='string',
    solutionArn='string',
    trainingMode='FULL'|'UPDATE',
    tags=[
        {
            'tagKey': 'string',
            'tagValue': 'string'
        },
    ]
)
Parameters:

  • name (string) – The name of the solution version.

  • solutionArn (string) –

    [REQUIRED]

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

  • trainingMode (string) –

    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.

    Warning

    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.

  • tags (list) –

    A list of tags to apply to the solution version.

    • (dict) –

      The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information see Tagging Amazon Personalize recources.

      • tagKey (string) – [REQUIRED]

        One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

      • tagValue (string) – [REQUIRED]

        The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).

Return type:

dict

Returns:

Response Syntax

{
    'solutionVersionArn': 'string'
}

Response Structure

  • (dict) –

    • solutionVersionArn (string) –

      The ARN of the new solution version.

Exceptions

  • Personalize.Client.exceptions.InvalidInputException

  • Personalize.Client.exceptions.ResourceNotFoundException

  • Personalize.Client.exceptions.LimitExceededException

  • Personalize.Client.exceptions.ResourceInUseException

  • Personalize.Client.exceptions.TooManyTagsException

  • Personalize.Client.exceptions.ResourceAlreadyExistsException