Struct aws_sdk_personalize::types::SolutionVersion

#[non_exhaustive]
pub struct SolutionVersion {

    pub name: Option<String>,
    pub solution_version_arn: Option<String>,
    pub solution_arn: Option<String>,
    pub perform_hpo: bool,
    pub perform_auto_ml: bool,
    pub recipe_arn: Option<String>,
    pub event_type: Option<String>,
    pub dataset_group_arn: Option<String>,
    pub solution_config: Option<SolutionConfig>,
    pub training_hours: Option<f64>,
    pub training_mode: Option<TrainingMode>,
    pub tuned_hpo_params: Option<TunedHpoParams>,
    pub status: Option<String>,
    pub failure_reason: Option<String>,
    pub creation_date_time: Option<DateTime>,
    pub last_updated_date_time: Option<DateTime>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of the solution version.

solution_version_arn: Option<String>

The ARN of the solution version.

solution_arn: Option<String>

The ARN of the solution.

perform_hpo: bool

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

perform_auto_ml: bool

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

recipe_arn: Option<String>

The ARN of the recipe used in the solution.

event_type: Option<String>

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

dataset_group_arn: Option<String>

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

solution_config: Option<SolutionConfig>

Describes the configuration properties for the solution.

training_hours: Option<f64>

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.

training_mode: Option<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.

tuned_hpo_params: Option<TunedHpoParams>

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

status: Option<String>

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

failure_reason: Option<String>

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

creation_date_time: Option<DateTime>

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

last_updated_date_time: Option<DateTime>

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

Implementations

impl SolutionVersion

pub fn name(&self) -> Option<&str>

The name of the solution version.

pub fn solution_version_arn(&self) -> Option<&str>

The ARN of the solution version.

pub fn solution_arn(&self) -> Option<&str>

The ARN of the solution.

pub fn perform_hpo(&self) -> bool

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

pub fn perform_auto_ml(&self) -> bool

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

pub fn recipe_arn(&self) -> Option<&str>

The ARN of the recipe used in the solution.

pub fn event_type(&self) -> Option<&str>

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

pub fn dataset_group_arn(&self) -> Option<&str>

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

pub fn solution_config(&self) -> Option<&SolutionConfig>

Describes the configuration properties for the solution.

pub fn training_hours(&self) -> Option<f64>

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.

pub fn training_mode(&self) -> Option<&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.

pub fn tuned_hpo_params(&self) -> Option<&TunedHpoParams>

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

pub fn status(&self) -> Option<&str>

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

pub fn failure_reason(&self) -> Option<&str>

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

pub fn creation_date_time(&self) -> Option<&DateTime>

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

pub fn last_updated_date_time(&self) -> Option<&DateTime>

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

impl SolutionVersion

pub fn builder() -> SolutionVersionBuilder

Creates a new builder-style object to manufacture SolutionVersion.

Trait Implementations

impl Clone for SolutionVersion

fn clone(&self) -> SolutionVersion

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SolutionVersion

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for SolutionVersion

fn eq(&self, other: &SolutionVersion) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SolutionVersion