libZSservicesZSamazonka-personalizeZSamazonka-personalize
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Personalize.CreateSolutionVersion

Description

Trains or retrains an active solution. 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

  • ListSolutionVersions
  • DescribeSolutionVersion
  • ListSolutions
  • CreateSolution
  • DescribeSolution
  • DeleteSolution
Synopsis

Creating a Request

data CreateSolutionVersion Source #

See: newCreateSolutionVersion smart constructor.

Constructors

CreateSolutionVersion' 

Fields

  • trainingMode :: Maybe 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.

  • solutionArn :: Text

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

Instances

Instances details
Eq CreateSolutionVersion Source # 
Instance details

Defined in Amazonka.Personalize.CreateSolutionVersion

Read CreateSolutionVersion Source # 
Instance details

Defined in Amazonka.Personalize.CreateSolutionVersion

Show CreateSolutionVersion Source # 
Instance details

Defined in Amazonka.Personalize.CreateSolutionVersion

Generic CreateSolutionVersion Source # 
Instance details

Defined in Amazonka.Personalize.CreateSolutionVersion

Associated Types

type Rep CreateSolutionVersion :: Type -> Type #

NFData CreateSolutionVersion Source # 
Instance details

Defined in Amazonka.Personalize.CreateSolutionVersion

Methods

rnf :: CreateSolutionVersion -> () #

Hashable CreateSolutionVersion Source # 
Instance details

Defined in Amazonka.Personalize.CreateSolutionVersion

ToJSON CreateSolutionVersion Source # 
Instance details

Defined in Amazonka.Personalize.CreateSolutionVersion

AWSRequest CreateSolutionVersion Source # 
Instance details

Defined in Amazonka.Personalize.CreateSolutionVersion

Associated Types

type AWSResponse CreateSolutionVersion #

ToHeaders CreateSolutionVersion Source # 
Instance details

Defined in Amazonka.Personalize.CreateSolutionVersion

ToPath CreateSolutionVersion Source # 
Instance details

Defined in Amazonka.Personalize.CreateSolutionVersion

ToQuery CreateSolutionVersion Source # 
Instance details

Defined in Amazonka.Personalize.CreateSolutionVersion

type Rep CreateSolutionVersion Source # 
Instance details

Defined in Amazonka.Personalize.CreateSolutionVersion

type Rep CreateSolutionVersion = D1 ('MetaData "CreateSolutionVersion" "Amazonka.Personalize.CreateSolutionVersion" "libZSservicesZSamazonka-personalizeZSamazonka-personalize" 'False) (C1 ('MetaCons "CreateSolutionVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "trainingMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TrainingMode)) :*: S1 ('MetaSel ('Just "solutionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CreateSolutionVersion Source # 
Instance details

Defined in Amazonka.Personalize.CreateSolutionVersion

newCreateSolutionVersion Source #

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:

$sel:trainingMode: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.

$sel:solutionArn:CreateSolutionVersion', createSolutionVersion_solutionArn - The Amazon Resource Name (ARN) of the solution containing the training configuration information.

Request Lenses

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

Instances details
Eq CreateSolutionVersionResponse Source # 
Instance details

Defined in Amazonka.Personalize.CreateSolutionVersion

Read CreateSolutionVersionResponse Source # 
Instance details

Defined in Amazonka.Personalize.CreateSolutionVersion

Show CreateSolutionVersionResponse Source # 
Instance details

Defined in Amazonka.Personalize.CreateSolutionVersion

Generic CreateSolutionVersionResponse Source # 
Instance details

Defined in Amazonka.Personalize.CreateSolutionVersion

Associated Types

type Rep CreateSolutionVersionResponse :: Type -> Type #

NFData CreateSolutionVersionResponse Source # 
Instance details

Defined in Amazonka.Personalize.CreateSolutionVersion

type Rep CreateSolutionVersionResponse Source # 
Instance details

Defined in Amazonka.Personalize.CreateSolutionVersion

type Rep CreateSolutionVersionResponse = D1 ('MetaData "CreateSolutionVersionResponse" "Amazonka.Personalize.CreateSolutionVersion" "libZSservicesZSamazonka-personalizeZSamazonka-personalize" 'False) (C1 ('MetaCons "CreateSolutionVersionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "solutionVersionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

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:

$sel:solutionVersionArn:CreateSolutionVersionResponse', createSolutionVersionResponse_solutionVersionArn - The ARN of the new solution version.

$sel:httpStatus:CreateSolutionVersionResponse', createSolutionVersionResponse_httpStatus - The response's http status code.

Response Lenses