/AWS1/CL_PZZSOLUTIONVERSION

An object that provides information about a specific version of a Solution in a Custom dataset group.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_name TYPE /AWS1/PZZNAME /AWS1/PZZNAME

The name of the solution version.

iv_solutionversionarn TYPE /AWS1/PZZARN /AWS1/PZZARN

The ARN of the solution version.

iv_solutionarn TYPE /AWS1/PZZARN /AWS1/PZZARN

The ARN of the solution.

iv_performhpo TYPE /AWS1/PZZPERFORMHPO /AWS1/PZZPERFORMHPO

Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.

iv_performautoml TYPE /AWS1/PZZPERFORMAUTOML /AWS1/PZZPERFORMAUTOML

When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses recipeArn.

iv_performincrementalupdate TYPE /AWS1/PZZPERFORMINCREMENTALUPD /AWS1/PZZPERFORMINCREMENTALUPD

Whether the solution version should perform an incremental update. When set to true, the training will process only the data that has changed since the latest training, similar to when trainingMode is set to UPDATE. This can only be used with solution versions that use the User-Personalization recipe.

iv_recipearn TYPE /AWS1/PZZARN /AWS1/PZZARN

The ARN of the recipe used in the solution.

iv_eventtype TYPE /AWS1/PZZEVENTTYPE /AWS1/PZZEVENTTYPE

The event type (for example, 'click' or 'like') that is used for training the model.

iv_datasetgrouparn TYPE /AWS1/PZZARN /AWS1/PZZARN

The Amazon Resource Name (ARN) of the dataset group providing the training data.

io_solutionconfig TYPE REF TO /AWS1/CL_PZZSOLUTIONCONFIG /AWS1/CL_PZZSOLUTIONCONFIG

Describes the configuration properties for the solution.

iv_traininghours TYPE /AWS1/RT_DOUBLE_AS_STRING /AWS1/RT_DOUBLE_AS_STRING

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.

iv_trainingmode TYPE /AWS1/PZZTRAININGMODE /AWS1/PZZTRAININGMODE

The scope of training to be performed when creating the solution version. A FULL training considers all of the data in your dataset group. An UPDATE processes only the data that has changed since the latest training. Only solution versions created with the User-Personalization recipe can use UPDATE.

io_tunedhpoparams TYPE REF TO /AWS1/CL_PZZTUNEDHPOPARAMS /AWS1/CL_PZZTUNEDHPOPARAMS

If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.

iv_status TYPE /AWS1/PZZSTATUS /AWS1/PZZSTATUS

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

iv_failurereason TYPE /AWS1/PZZFAILUREREASON /AWS1/PZZFAILUREREASON

If training a solution version fails, the reason for the failure.

iv_creationdatetime TYPE /AWS1/PZZDATE /AWS1/PZZDATE

The date and time (in Unix time) that this version of the solution was created.

iv_lastupdateddatetime TYPE /AWS1/PZZDATE /AWS1/PZZDATE

The date and time (in Unix time) that the solution was last updated.

iv_trainingtype TYPE /AWS1/PZZTRAININGTYPE /AWS1/PZZTRAININGTYPE

Whether the solution version was created automatically or manually.

---

Queryable Attributes

name

The name of the solution version.

Accessible with the following methods

Method	Description
GET_NAME()	Getter for NAME, with configurable default
ASK_NAME()	Getter for NAME w/ exceptions if field has no value
HAS_NAME()	Determine if NAME has a value

solutionVersionArn

The ARN of the solution version.

Accessible with the following methods

Method	Description
GET_SOLUTIONVERSIONARN()	Getter for SOLUTIONVERSIONARN, with configurable default
ASK_SOLUTIONVERSIONARN()	Getter for SOLUTIONVERSIONARN w/ exceptions if field has no
HAS_SOLUTIONVERSIONARN()	Determine if SOLUTIONVERSIONARN has a value

solutionArn

The ARN of the solution.

Accessible with the following methods

Method	Description
GET_SOLUTIONARN()	Getter for SOLUTIONARN, with configurable default
ASK_SOLUTIONARN()	Getter for SOLUTIONARN w/ exceptions if field has no value
HAS_SOLUTIONARN()	Determine if SOLUTIONARN has a value

performHPO

Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.

Accessible with the following methods

Method	Description
GET_PERFORMHPO()	Getter for PERFORMHPO

performAutoML

When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses recipeArn.

Accessible with the following methods

Method	Description
GET_PERFORMAUTOML()	Getter for PERFORMAUTOML

performIncrementalUpdate

Whether the solution version should perform an incremental update. When set to true, the training will process only the data that has changed since the latest training, similar to when trainingMode is set to UPDATE. This can only be used with solution versions that use the User-Personalization recipe.

Accessible with the following methods

Method	Description
GET_PERFORMINCREMENTALUPDATE()	Getter for PERFORMINCREMENTALUPDATE, with configurable defau
ASK_PERFORMINCREMENTALUPDATE()	Getter for PERFORMINCREMENTALUPDATE w/ exceptions if field h
HAS_PERFORMINCREMENTALUPDATE()	Determine if PERFORMINCREMENTALUPDATE has a value

recipeArn

The ARN of the recipe used in the solution.

Accessible with the following methods

Method	Description
GET_RECIPEARN()	Getter for RECIPEARN, with configurable default
ASK_RECIPEARN()	Getter for RECIPEARN w/ exceptions if field has no value
HAS_RECIPEARN()	Determine if RECIPEARN has a value

eventType

The event type (for example, 'click' or 'like') that is used for training the model.

Accessible with the following methods

Method	Description
GET_EVENTTYPE()	Getter for EVENTTYPE, with configurable default
ASK_EVENTTYPE()	Getter for EVENTTYPE w/ exceptions if field has no value
HAS_EVENTTYPE()	Determine if EVENTTYPE has a value

datasetGroupArn

The Amazon Resource Name (ARN) of the dataset group providing the training data.

Accessible with the following methods

Method	Description
GET_DATASETGROUPARN()	Getter for DATASETGROUPARN, with configurable default
ASK_DATASETGROUPARN()	Getter for DATASETGROUPARN w/ exceptions if field has no val
HAS_DATASETGROUPARN()	Determine if DATASETGROUPARN has a value

solutionConfig

Describes the configuration properties for the solution.

Accessible with the following methods

Method	Description
GET_SOLUTIONCONFIG()	Getter for SOLUTIONCONFIG

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.

Accessible with the following methods

Method	Description
GET_TRAININGHOURS()	Getter for TRAININGHOURS, with configurable default
ASK_TRAININGHOURS()	Getter for TRAININGHOURS w/ exceptions if field has no value
STR_TRAININGHOURS()	String format for TRAININGHOURS, with configurable default
HAS_TRAININGHOURS()	Determine if TRAININGHOURS has a value

trainingMode

The scope of training to be performed when creating the solution version. A FULL training considers all of the data in your dataset group. An UPDATE processes only the data that has changed since the latest training. Only solution versions created with the User-Personalization recipe can use UPDATE.

Accessible with the following methods

Method	Description
GET_TRAININGMODE()	Getter for TRAININGMODE, with configurable default
ASK_TRAININGMODE()	Getter for TRAININGMODE w/ exceptions if field has no value
HAS_TRAININGMODE()	Determine if TRAININGMODE has a value

tunedHPOParams

If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.

Accessible with the following methods

Method	Description
GET_TUNEDHPOPARAMS()	Getter for TUNEDHPOPARAMS

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

Accessible with the following methods

Method	Description
GET_STATUS()	Getter for STATUS, with configurable default
ASK_STATUS()	Getter for STATUS w/ exceptions if field has no value
HAS_STATUS()	Determine if STATUS has a value

failureReason

If training a solution version fails, the reason for the failure.

Accessible with the following methods

Method	Description
GET_FAILUREREASON()	Getter for FAILUREREASON, with configurable default
ASK_FAILUREREASON()	Getter for FAILUREREASON w/ exceptions if field has no value
HAS_FAILUREREASON()	Determine if FAILUREREASON has a value

creationDateTime

The date and time (in Unix time) that this version of the solution was created.

Accessible with the following methods

Method	Description
GET_CREATIONDATETIME()	Getter for CREATIONDATETIME, with configurable default
ASK_CREATIONDATETIME()	Getter for CREATIONDATETIME w/ exceptions if field has no va
HAS_CREATIONDATETIME()	Determine if CREATIONDATETIME has a value

lastUpdatedDateTime

The date and time (in Unix time) that the solution was last updated.

Accessible with the following methods

Method	Description
GET_LASTUPDATEDDATETIME()	Getter for LASTUPDATEDDATETIME, with configurable default
ASK_LASTUPDATEDDATETIME()	Getter for LASTUPDATEDDATETIME w/ exceptions if field has no
HAS_LASTUPDATEDDATETIME()	Determine if LASTUPDATEDDATETIME has a value

trainingType

Whether the solution version was created automatically or manually.

Accessible with the following methods

Method	Description
GET_TRAININGTYPE()	Getter for TRAININGTYPE, with configurable default
ASK_TRAININGTYPE()	Getter for TRAININGTYPE w/ exceptions if field has no value
HAS_TRAININGTYPE()	Determine if TRAININGTYPE has a value