AWS SDK for C++  1.9.75
AWS SDK for C++
Public Member Functions | List of all members
Aws::Personalize::Model::SolutionVersion Class Reference

#include <SolutionVersion.h>

Public Member Functions

 SolutionVersion ()
 
 SolutionVersion (Aws::Utils::Json::JsonView jsonValue)
 
SolutionVersionoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetSolutionVersionArn () const
 
bool SolutionVersionArnHasBeenSet () const
 
void SetSolutionVersionArn (const Aws::String &value)
 
void SetSolutionVersionArn (Aws::String &&value)
 
void SetSolutionVersionArn (const char *value)
 
SolutionVersionWithSolutionVersionArn (const Aws::String &value)
 
SolutionVersionWithSolutionVersionArn (Aws::String &&value)
 
SolutionVersionWithSolutionVersionArn (const char *value)
 
const Aws::StringGetSolutionArn () const
 
bool SolutionArnHasBeenSet () const
 
void SetSolutionArn (const Aws::String &value)
 
void SetSolutionArn (Aws::String &&value)
 
void SetSolutionArn (const char *value)
 
SolutionVersionWithSolutionArn (const Aws::String &value)
 
SolutionVersionWithSolutionArn (Aws::String &&value)
 
SolutionVersionWithSolutionArn (const char *value)
 
bool GetPerformHPO () const
 
bool PerformHPOHasBeenSet () const
 
void SetPerformHPO (bool value)
 
SolutionVersionWithPerformHPO (bool value)
 
bool GetPerformAutoML () const
 
bool PerformAutoMLHasBeenSet () const
 
void SetPerformAutoML (bool value)
 
SolutionVersionWithPerformAutoML (bool value)
 
const Aws::StringGetRecipeArn () const
 
bool RecipeArnHasBeenSet () const
 
void SetRecipeArn (const Aws::String &value)
 
void SetRecipeArn (Aws::String &&value)
 
void SetRecipeArn (const char *value)
 
SolutionVersionWithRecipeArn (const Aws::String &value)
 
SolutionVersionWithRecipeArn (Aws::String &&value)
 
SolutionVersionWithRecipeArn (const char *value)
 
const Aws::StringGetEventType () const
 
bool EventTypeHasBeenSet () const
 
void SetEventType (const Aws::String &value)
 
void SetEventType (Aws::String &&value)
 
void SetEventType (const char *value)
 
SolutionVersionWithEventType (const Aws::String &value)
 
SolutionVersionWithEventType (Aws::String &&value)
 
SolutionVersionWithEventType (const char *value)
 
const Aws::StringGetDatasetGroupArn () const
 
bool DatasetGroupArnHasBeenSet () const
 
void SetDatasetGroupArn (const Aws::String &value)
 
void SetDatasetGroupArn (Aws::String &&value)
 
void SetDatasetGroupArn (const char *value)
 
SolutionVersionWithDatasetGroupArn (const Aws::String &value)
 
SolutionVersionWithDatasetGroupArn (Aws::String &&value)
 
SolutionVersionWithDatasetGroupArn (const char *value)
 
const SolutionConfigGetSolutionConfig () const
 
bool SolutionConfigHasBeenSet () const
 
void SetSolutionConfig (const SolutionConfig &value)
 
void SetSolutionConfig (SolutionConfig &&value)
 
SolutionVersionWithSolutionConfig (const SolutionConfig &value)
 
SolutionVersionWithSolutionConfig (SolutionConfig &&value)
 
double GetTrainingHours () const
 
bool TrainingHoursHasBeenSet () const
 
void SetTrainingHours (double value)
 
SolutionVersionWithTrainingHours (double value)
 
const TrainingModeGetTrainingMode () const
 
bool TrainingModeHasBeenSet () const
 
void SetTrainingMode (const TrainingMode &value)
 
void SetTrainingMode (TrainingMode &&value)
 
SolutionVersionWithTrainingMode (const TrainingMode &value)
 
SolutionVersionWithTrainingMode (TrainingMode &&value)
 
const TunedHPOParamsGetTunedHPOParams () const
 
bool TunedHPOParamsHasBeenSet () const
 
void SetTunedHPOParams (const TunedHPOParams &value)
 
void SetTunedHPOParams (TunedHPOParams &&value)
 
SolutionVersionWithTunedHPOParams (const TunedHPOParams &value)
 
SolutionVersionWithTunedHPOParams (TunedHPOParams &&value)
 
const Aws::StringGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const Aws::String &value)
 
void SetStatus (Aws::String &&value)
 
void SetStatus (const char *value)
 
SolutionVersionWithStatus (const Aws::String &value)
 
SolutionVersionWithStatus (Aws::String &&value)
 
SolutionVersionWithStatus (const char *value)
 
const Aws::StringGetFailureReason () const
 
bool FailureReasonHasBeenSet () const
 
void SetFailureReason (const Aws::String &value)
 
void SetFailureReason (Aws::String &&value)
 
void SetFailureReason (const char *value)
 
SolutionVersionWithFailureReason (const Aws::String &value)
 
SolutionVersionWithFailureReason (Aws::String &&value)
 
SolutionVersionWithFailureReason (const char *value)
 
const Aws::Utils::DateTimeGetCreationDateTime () const
 
bool CreationDateTimeHasBeenSet () const
 
void SetCreationDateTime (const Aws::Utils::DateTime &value)
 
void SetCreationDateTime (Aws::Utils::DateTime &&value)
 
SolutionVersionWithCreationDateTime (const Aws::Utils::DateTime &value)
 
SolutionVersionWithCreationDateTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetLastUpdatedDateTime () const
 
bool LastUpdatedDateTimeHasBeenSet () const
 
void SetLastUpdatedDateTime (const Aws::Utils::DateTime &value)
 
void SetLastUpdatedDateTime (Aws::Utils::DateTime &&value)
 
SolutionVersionWithLastUpdatedDateTime (const Aws::Utils::DateTime &value)
 
SolutionVersionWithLastUpdatedDateTime (Aws::Utils::DateTime &&value)
 

Detailed Description

An object that provides information about a specific version of a Solution.

See Also:

AWS API Reference

Definition at line 36 of file SolutionVersion.h.

Constructor & Destructor Documentation

◆ SolutionVersion() [1/2]

Aws::Personalize::Model::SolutionVersion::SolutionVersion ( )

◆ SolutionVersion() [2/2]

Aws::Personalize::Model::SolutionVersion::SolutionVersion ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ CreationDateTimeHasBeenSet()

bool Aws::Personalize::Model::SolutionVersion::CreationDateTimeHasBeenSet ( ) const
inline

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

Definition at line 644 of file SolutionVersion.h.

◆ DatasetGroupArnHasBeenSet()

bool Aws::Personalize::Model::SolutionVersion::DatasetGroupArnHasBeenSet ( ) const
inline

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

Definition at line 281 of file SolutionVersion.h.

◆ EventTypeHasBeenSet()

bool Aws::Personalize::Model::SolutionVersion::EventTypeHasBeenSet ( ) const
inline

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

Definition at line 232 of file SolutionVersion.h.

◆ FailureReasonHasBeenSet()

bool Aws::Personalize::Model::SolutionVersion::FailureReasonHasBeenSet ( ) const
inline

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

Definition at line 601 of file SolutionVersion.h.

◆ GetCreationDateTime()

const Aws::Utils::DateTime& Aws::Personalize::Model::SolutionVersion::GetCreationDateTime ( ) const
inline

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

Definition at line 638 of file SolutionVersion.h.

◆ GetDatasetGroupArn()

const Aws::String& Aws::Personalize::Model::SolutionVersion::GetDatasetGroupArn ( ) const
inline

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

Definition at line 275 of file SolutionVersion.h.

◆ GetEventType()

const Aws::String& Aws::Personalize::Model::SolutionVersion::GetEventType ( ) const
inline

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

Definition at line 226 of file SolutionVersion.h.

◆ GetFailureReason()

const Aws::String& Aws::Personalize::Model::SolutionVersion::GetFailureReason ( ) const
inline

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

Definition at line 596 of file SolutionVersion.h.

◆ GetLastUpdatedDateTime()

const Aws::Utils::DateTime& Aws::Personalize::Model::SolutionVersion::GetLastUpdatedDateTime ( ) const
inline

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

Definition at line 674 of file SolutionVersion.h.

◆ GetPerformAutoML()

bool Aws::Personalize::Model::SolutionVersion::GetPerformAutoML ( ) const
inline

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

Definition at line 157 of file SolutionVersion.h.

◆ GetPerformHPO()

bool Aws::Personalize::Model::SolutionVersion::GetPerformHPO ( ) const
inline

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

Definition at line 131 of file SolutionVersion.h.

◆ GetRecipeArn()

const Aws::String& Aws::Personalize::Model::SolutionVersion::GetRecipeArn ( ) const
inline

The ARN of the recipe used in the solution.

Definition at line 184 of file SolutionVersion.h.

◆ GetSolutionArn()

const Aws::String& Aws::Personalize::Model::SolutionVersion::GetSolutionArn ( ) const
inline

The ARN of the solution.

Definition at line 89 of file SolutionVersion.h.

◆ GetSolutionConfig()

const SolutionConfig& Aws::Personalize::Model::SolutionVersion::GetSolutionConfig ( ) const
inline

Describes the configuration properties for the solution.

Definition at line 323 of file SolutionVersion.h.

◆ GetSolutionVersionArn()

const Aws::String& Aws::Personalize::Model::SolutionVersion::GetSolutionVersionArn ( ) const
inline

The ARN of the solution version.

Definition at line 48 of file SolutionVersion.h.

◆ GetStatus()

const Aws::String& Aws::Personalize::Model::SolutionVersion::GetStatus ( ) const
inline

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

Definition at line 527 of file SolutionVersion.h.

◆ GetTrainingHours()

double Aws::Personalize::Model::SolutionVersion::GetTrainingHours ( ) const
inline

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.

Definition at line 356 of file SolutionVersion.h.

◆ GetTrainingMode()

const TrainingMode& Aws::Personalize::Model::SolutionVersion::GetTrainingMode ( ) const
inline

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.

Definition at line 395 of file SolutionVersion.h.

◆ GetTunedHPOParams()

const TunedHPOParams& Aws::Personalize::Model::SolutionVersion::GetTunedHPOParams ( ) const
inline

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

Definition at line 487 of file SolutionVersion.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Personalize::Model::SolutionVersion::Jsonize ( ) const

◆ LastUpdatedDateTimeHasBeenSet()

bool Aws::Personalize::Model::SolutionVersion::LastUpdatedDateTimeHasBeenSet ( ) const
inline

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

Definition at line 679 of file SolutionVersion.h.

◆ operator=()

SolutionVersion& Aws::Personalize::Model::SolutionVersion::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PerformAutoMLHasBeenSet()

bool Aws::Personalize::Model::SolutionVersion::PerformAutoMLHasBeenSet ( ) const
inline

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

Definition at line 164 of file SolutionVersion.h.

◆ PerformHPOHasBeenSet()

bool Aws::Personalize::Model::SolutionVersion::PerformHPOHasBeenSet ( ) const
inline

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

Definition at line 137 of file SolutionVersion.h.

◆ RecipeArnHasBeenSet()

bool Aws::Personalize::Model::SolutionVersion::RecipeArnHasBeenSet ( ) const
inline

The ARN of the recipe used in the solution.

Definition at line 189 of file SolutionVersion.h.

◆ SetCreationDateTime() [1/2]

void Aws::Personalize::Model::SolutionVersion::SetCreationDateTime ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 656 of file SolutionVersion.h.

◆ SetCreationDateTime() [2/2]

void Aws::Personalize::Model::SolutionVersion::SetCreationDateTime ( const Aws::Utils::DateTime value)
inline

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

Definition at line 650 of file SolutionVersion.h.

◆ SetDatasetGroupArn() [1/3]

void Aws::Personalize::Model::SolutionVersion::SetDatasetGroupArn ( Aws::String &&  value)
inline

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

Definition at line 293 of file SolutionVersion.h.

◆ SetDatasetGroupArn() [2/3]

void Aws::Personalize::Model::SolutionVersion::SetDatasetGroupArn ( const Aws::String value)
inline

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

Definition at line 287 of file SolutionVersion.h.

◆ SetDatasetGroupArn() [3/3]

void Aws::Personalize::Model::SolutionVersion::SetDatasetGroupArn ( const char *  value)
inline

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

Definition at line 299 of file SolutionVersion.h.

◆ SetEventType() [1/3]

void Aws::Personalize::Model::SolutionVersion::SetEventType ( Aws::String &&  value)
inline

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

Definition at line 244 of file SolutionVersion.h.

◆ SetEventType() [2/3]

void Aws::Personalize::Model::SolutionVersion::SetEventType ( const Aws::String value)
inline

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

Definition at line 238 of file SolutionVersion.h.

◆ SetEventType() [3/3]

void Aws::Personalize::Model::SolutionVersion::SetEventType ( const char *  value)
inline

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

Definition at line 250 of file SolutionVersion.h.

◆ SetFailureReason() [1/3]

void Aws::Personalize::Model::SolutionVersion::SetFailureReason ( Aws::String &&  value)
inline

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

Definition at line 611 of file SolutionVersion.h.

◆ SetFailureReason() [2/3]

void Aws::Personalize::Model::SolutionVersion::SetFailureReason ( const Aws::String value)
inline

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

Definition at line 606 of file SolutionVersion.h.

◆ SetFailureReason() [3/3]

void Aws::Personalize::Model::SolutionVersion::SetFailureReason ( const char *  value)
inline

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

Definition at line 616 of file SolutionVersion.h.

◆ SetLastUpdatedDateTime() [1/2]

void Aws::Personalize::Model::SolutionVersion::SetLastUpdatedDateTime ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 689 of file SolutionVersion.h.

◆ SetLastUpdatedDateTime() [2/2]

void Aws::Personalize::Model::SolutionVersion::SetLastUpdatedDateTime ( const Aws::Utils::DateTime value)
inline

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

Definition at line 684 of file SolutionVersion.h.

◆ SetPerformAutoML()

void Aws::Personalize::Model::SolutionVersion::SetPerformAutoML ( bool  value)
inline

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

Definition at line 171 of file SolutionVersion.h.

◆ SetPerformHPO()

void Aws::Personalize::Model::SolutionVersion::SetPerformHPO ( bool  value)
inline

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

Definition at line 143 of file SolutionVersion.h.

◆ SetRecipeArn() [1/3]

void Aws::Personalize::Model::SolutionVersion::SetRecipeArn ( Aws::String &&  value)
inline

The ARN of the recipe used in the solution.

Definition at line 199 of file SolutionVersion.h.

◆ SetRecipeArn() [2/3]

void Aws::Personalize::Model::SolutionVersion::SetRecipeArn ( const Aws::String value)
inline

The ARN of the recipe used in the solution.

Definition at line 194 of file SolutionVersion.h.

◆ SetRecipeArn() [3/3]

void Aws::Personalize::Model::SolutionVersion::SetRecipeArn ( const char *  value)
inline

The ARN of the recipe used in the solution.

Definition at line 204 of file SolutionVersion.h.

◆ SetSolutionArn() [1/3]

void Aws::Personalize::Model::SolutionVersion::SetSolutionArn ( Aws::String &&  value)
inline

The ARN of the solution.

Definition at line 104 of file SolutionVersion.h.

◆ SetSolutionArn() [2/3]

void Aws::Personalize::Model::SolutionVersion::SetSolutionArn ( const Aws::String value)
inline

The ARN of the solution.

Definition at line 99 of file SolutionVersion.h.

◆ SetSolutionArn() [3/3]

void Aws::Personalize::Model::SolutionVersion::SetSolutionArn ( const char *  value)
inline

The ARN of the solution.

Definition at line 109 of file SolutionVersion.h.

◆ SetSolutionConfig() [1/2]

void Aws::Personalize::Model::SolutionVersion::SetSolutionConfig ( const SolutionConfig value)
inline

Describes the configuration properties for the solution.

Definition at line 333 of file SolutionVersion.h.

◆ SetSolutionConfig() [2/2]

void Aws::Personalize::Model::SolutionVersion::SetSolutionConfig ( SolutionConfig &&  value)
inline

Describes the configuration properties for the solution.

Definition at line 338 of file SolutionVersion.h.

◆ SetSolutionVersionArn() [1/3]

void Aws::Personalize::Model::SolutionVersion::SetSolutionVersionArn ( Aws::String &&  value)
inline

The ARN of the solution version.

Definition at line 63 of file SolutionVersion.h.

◆ SetSolutionVersionArn() [2/3]

void Aws::Personalize::Model::SolutionVersion::SetSolutionVersionArn ( const Aws::String value)
inline

The ARN of the solution version.

Definition at line 58 of file SolutionVersion.h.

◆ SetSolutionVersionArn() [3/3]

void Aws::Personalize::Model::SolutionVersion::SetSolutionVersionArn ( const char *  value)
inline

The ARN of the solution version.

Definition at line 68 of file SolutionVersion.h.

◆ SetStatus() [1/3]

void Aws::Personalize::Model::SolutionVersion::SetStatus ( Aws::String &&  value)
inline

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

Definition at line 554 of file SolutionVersion.h.

◆ SetStatus() [2/3]

void Aws::Personalize::Model::SolutionVersion::SetStatus ( const Aws::String value)
inline

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

Definition at line 545 of file SolutionVersion.h.

◆ SetStatus() [3/3]

void Aws::Personalize::Model::SolutionVersion::SetStatus ( const char *  value)
inline

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

Definition at line 563 of file SolutionVersion.h.

◆ SetTrainingHours()

void Aws::Personalize::Model::SolutionVersion::SetTrainingHours ( double  value)
inline

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.

Definition at line 370 of file SolutionVersion.h.

◆ SetTrainingMode() [1/2]

void Aws::Personalize::Model::SolutionVersion::SetTrainingMode ( const TrainingMode value)
inline

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.

Definition at line 429 of file SolutionVersion.h.

◆ SetTrainingMode() [2/2]

void Aws::Personalize::Model::SolutionVersion::SetTrainingMode ( TrainingMode &&  value)
inline

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.

Definition at line 446 of file SolutionVersion.h.

◆ SetTunedHPOParams() [1/2]

void Aws::Personalize::Model::SolutionVersion::SetTunedHPOParams ( const TunedHPOParams value)
inline

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

Definition at line 499 of file SolutionVersion.h.

◆ SetTunedHPOParams() [2/2]

void Aws::Personalize::Model::SolutionVersion::SetTunedHPOParams ( TunedHPOParams &&  value)
inline

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

Definition at line 505 of file SolutionVersion.h.

◆ SolutionArnHasBeenSet()

bool Aws::Personalize::Model::SolutionVersion::SolutionArnHasBeenSet ( ) const
inline

The ARN of the solution.

Definition at line 94 of file SolutionVersion.h.

◆ SolutionConfigHasBeenSet()

bool Aws::Personalize::Model::SolutionVersion::SolutionConfigHasBeenSet ( ) const
inline

Describes the configuration properties for the solution.

Definition at line 328 of file SolutionVersion.h.

◆ SolutionVersionArnHasBeenSet()

bool Aws::Personalize::Model::SolutionVersion::SolutionVersionArnHasBeenSet ( ) const
inline

The ARN of the solution version.

Definition at line 53 of file SolutionVersion.h.

◆ StatusHasBeenSet()

bool Aws::Personalize::Model::SolutionVersion::StatusHasBeenSet ( ) const
inline

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

Definition at line 536 of file SolutionVersion.h.

◆ TrainingHoursHasBeenSet()

bool Aws::Personalize::Model::SolutionVersion::TrainingHoursHasBeenSet ( ) const
inline

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.

Definition at line 363 of file SolutionVersion.h.

◆ TrainingModeHasBeenSet()

bool Aws::Personalize::Model::SolutionVersion::TrainingModeHasBeenSet ( ) const
inline

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.

Definition at line 412 of file SolutionVersion.h.

◆ TunedHPOParamsHasBeenSet()

bool Aws::Personalize::Model::SolutionVersion::TunedHPOParamsHasBeenSet ( ) const
inline

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

Definition at line 493 of file SolutionVersion.h.

◆ WithCreationDateTime() [1/2]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithCreationDateTime ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 668 of file SolutionVersion.h.

◆ WithCreationDateTime() [2/2]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithCreationDateTime ( const Aws::Utils::DateTime value)
inline

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

Definition at line 662 of file SolutionVersion.h.

◆ WithDatasetGroupArn() [1/3]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithDatasetGroupArn ( Aws::String &&  value)
inline

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

Definition at line 311 of file SolutionVersion.h.

◆ WithDatasetGroupArn() [2/3]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithDatasetGroupArn ( const Aws::String value)
inline

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

Definition at line 305 of file SolutionVersion.h.

◆ WithDatasetGroupArn() [3/3]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithDatasetGroupArn ( const char *  value)
inline

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

Definition at line 317 of file SolutionVersion.h.

◆ WithEventType() [1/3]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithEventType ( Aws::String &&  value)
inline

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

Definition at line 262 of file SolutionVersion.h.

◆ WithEventType() [2/3]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithEventType ( const Aws::String value)
inline

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

Definition at line 256 of file SolutionVersion.h.

◆ WithEventType() [3/3]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithEventType ( const char *  value)
inline

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

Definition at line 268 of file SolutionVersion.h.

◆ WithFailureReason() [1/3]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithFailureReason ( Aws::String &&  value)
inline

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

Definition at line 626 of file SolutionVersion.h.

◆ WithFailureReason() [2/3]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithFailureReason ( const Aws::String value)
inline

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

Definition at line 621 of file SolutionVersion.h.

◆ WithFailureReason() [3/3]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithFailureReason ( const char *  value)
inline

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

Definition at line 631 of file SolutionVersion.h.

◆ WithLastUpdatedDateTime() [1/2]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithLastUpdatedDateTime ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 699 of file SolutionVersion.h.

◆ WithLastUpdatedDateTime() [2/2]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithLastUpdatedDateTime ( const Aws::Utils::DateTime value)
inline

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

Definition at line 694 of file SolutionVersion.h.

◆ WithPerformAutoML()

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithPerformAutoML ( bool  value)
inline

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

Definition at line 178 of file SolutionVersion.h.

◆ WithPerformHPO()

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithPerformHPO ( bool  value)
inline

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

Definition at line 149 of file SolutionVersion.h.

◆ WithRecipeArn() [1/3]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithRecipeArn ( Aws::String &&  value)
inline

The ARN of the recipe used in the solution.

Definition at line 214 of file SolutionVersion.h.

◆ WithRecipeArn() [2/3]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithRecipeArn ( const Aws::String value)
inline

The ARN of the recipe used in the solution.

Definition at line 209 of file SolutionVersion.h.

◆ WithRecipeArn() [3/3]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithRecipeArn ( const char *  value)
inline

The ARN of the recipe used in the solution.

Definition at line 219 of file SolutionVersion.h.

◆ WithSolutionArn() [1/3]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithSolutionArn ( Aws::String &&  value)
inline

The ARN of the solution.

Definition at line 119 of file SolutionVersion.h.

◆ WithSolutionArn() [2/3]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithSolutionArn ( const Aws::String value)
inline

The ARN of the solution.

Definition at line 114 of file SolutionVersion.h.

◆ WithSolutionArn() [3/3]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithSolutionArn ( const char *  value)
inline

The ARN of the solution.

Definition at line 124 of file SolutionVersion.h.

◆ WithSolutionConfig() [1/2]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithSolutionConfig ( const SolutionConfig value)
inline

Describes the configuration properties for the solution.

Definition at line 343 of file SolutionVersion.h.

◆ WithSolutionConfig() [2/2]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithSolutionConfig ( SolutionConfig &&  value)
inline

Describes the configuration properties for the solution.

Definition at line 348 of file SolutionVersion.h.

◆ WithSolutionVersionArn() [1/3]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithSolutionVersionArn ( Aws::String &&  value)
inline

The ARN of the solution version.

Definition at line 78 of file SolutionVersion.h.

◆ WithSolutionVersionArn() [2/3]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithSolutionVersionArn ( const Aws::String value)
inline

The ARN of the solution version.

Definition at line 73 of file SolutionVersion.h.

◆ WithSolutionVersionArn() [3/3]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithSolutionVersionArn ( const char *  value)
inline

The ARN of the solution version.

Definition at line 83 of file SolutionVersion.h.

◆ WithStatus() [1/3]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithStatus ( Aws::String &&  value)
inline

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

Definition at line 581 of file SolutionVersion.h.

◆ WithStatus() [2/3]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithStatus ( const Aws::String value)
inline

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

Definition at line 572 of file SolutionVersion.h.

◆ WithStatus() [3/3]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithStatus ( const char *  value)
inline

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

Definition at line 590 of file SolutionVersion.h.

◆ WithTrainingHours()

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithTrainingHours ( double  value)
inline

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.

Definition at line 377 of file SolutionVersion.h.

◆ WithTrainingMode() [1/2]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithTrainingMode ( const TrainingMode value)
inline

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.

Definition at line 463 of file SolutionVersion.h.

◆ WithTrainingMode() [2/2]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithTrainingMode ( TrainingMode &&  value)
inline

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.

Definition at line 480 of file SolutionVersion.h.

◆ WithTunedHPOParams() [1/2]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithTunedHPOParams ( const TunedHPOParams value)
inline

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

Definition at line 511 of file SolutionVersion.h.

◆ WithTunedHPOParams() [2/2]

SolutionVersion& Aws::Personalize::Model::SolutionVersion::WithTunedHPOParams ( TunedHPOParams &&  value)
inline

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

Definition at line 517 of file SolutionVersion.h.


The documentation for this class was generated from the following file: