Class: Aws::Personalize::Types::Solution

Inherits:

Struct

Object
Struct
Aws::Personalize::Types::Solution

show all

Includes:: Structure

Defined in:: lib/aws-sdk-personalize/types.rb

Overview

By default, all new solutions use automatic training. With automatic training, you incur training costs while your solution is active. To avoid unnecessary costs, when you are finished you can [update the solution] to turn off automatic training. For information about training costs, see [Amazon Personalize pricing].

An object that provides information about a solution. A solution includes the custom recipe, customized parameters, and trained models (Solution Versions) that Amazon Personalize uses to generate recommendations.

After you create a solution, you can’t change its configuration. If you need to make changes, you can [clone the solution] with the Amazon Personalize console or create a new one.

[1]: docs.aws.amazon.com/personalize/latest/dg/API_UpdateSolution.html [2]: aws.amazon.com/personalize/pricing/ [3]: docs.aws.amazon.com/personalize/latest/dg/cloning-solution.html

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#auto_ml_result ⇒ Types::AutoMLResult

When ‘performAutoML` is true, specifies the best recipe found.
#creation_date_time ⇒ Time

The creation date and time (in Unix time) of the solution.
#dataset_group_arn ⇒ String

The Amazon Resource Name (ARN) of the dataset group that provides the training data.
#event_type ⇒ String

The event type (for example, ‘click’ or ‘like’) that is used for training the model.
#last_updated_date_time ⇒ Time

The date and time (in Unix time) that the solution was last updated.
#latest_solution_update ⇒ Types::SolutionUpdateSummary

Provides a summary of the latest updates to the solution.
#latest_solution_version ⇒ Types::SolutionVersionSummary

Describes the latest version of the solution, including the status and the ARN.
#name ⇒ String

The name of the solution.
#perform_auto_ml ⇒ Boolean

We don’t recommend enabling automated machine learning.
#perform_auto_training ⇒ Boolean

Specifies whether the solution automatically creates solution versions.
#perform_hpo ⇒ Boolean

Whether to perform hyperparameter optimization (HPO) on the chosen recipe.
#recipe_arn ⇒ String

The ARN of the recipe used to create the solution.
#solution_arn ⇒ String

The ARN of the solution.
#solution_config ⇒ Types::SolutionConfig

Describes the configuration properties for the solution.
#status ⇒ String

The status of the solution.

Instance Attribute Details

#auto_ml_result ⇒ `Types::AutoMLResult`

When ‘performAutoML` is true, specifies the best recipe found.

Returns:

(Types::AutoMLResult)

# File 'lib/aws-sdk-personalize/types.rb', line 5319

class Solution < Struct.new(
  :name,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_auto_training,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config,
  :auto_ml_result,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :latest_solution_version,
  :latest_solution_update)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date_time ⇒ `Time`

The creation date and time (in Unix time) of the solution.

Returns:

(Time)

# File 'lib/aws-sdk-personalize/types.rb', line 5319

class Solution < Struct.new(
  :name,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_auto_training,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config,
  :auto_ml_result,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :latest_solution_version,
  :latest_solution_update)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_group_arn ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-personalize/types.rb', line 5319

class Solution < Struct.new(
  :name,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_auto_training,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config,
  :auto_ml_result,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :latest_solution_version,
  :latest_solution_update)
  SENSITIVE = []
  include Aws::Structure
end

#event_type ⇒ `String`

The event type (for example, ‘click’ or ‘like’) that is used for training the model. If no ‘eventType` is provided, Amazon Personalize uses all interactions for training with equal weight regardless of type.

Returns:

(String)

# File 'lib/aws-sdk-personalize/types.rb', line 5319

class Solution < Struct.new(
  :name,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_auto_training,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config,
  :auto_ml_result,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :latest_solution_version,
  :latest_solution_update)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_date_time ⇒ `Time`

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

Returns:

(Time)

# File 'lib/aws-sdk-personalize/types.rb', line 5319

class Solution < Struct.new(
  :name,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_auto_training,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config,
  :auto_ml_result,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :latest_solution_version,
  :latest_solution_update)
  SENSITIVE = []
  include Aws::Structure
end

#latest_solution_update ⇒ `Types::SolutionUpdateSummary`

Provides a summary of the latest updates to the solution.

Returns:

(Types::SolutionUpdateSummary)

# File 'lib/aws-sdk-personalize/types.rb', line 5319

class Solution < Struct.new(
  :name,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_auto_training,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config,
  :auto_ml_result,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :latest_solution_version,
  :latest_solution_update)
  SENSITIVE = []
  include Aws::Structure
end

#latest_solution_version ⇒ `Types::SolutionVersionSummary`

Describes the latest version of the solution, including the status and the ARN.

Returns:

(Types::SolutionVersionSummary)

# File 'lib/aws-sdk-personalize/types.rb', line 5319

class Solution < Struct.new(
  :name,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_auto_training,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config,
  :auto_ml_result,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :latest_solution_version,
  :latest_solution_update)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

The name of the solution.

Returns:

(String)

# File 'lib/aws-sdk-personalize/types.rb', line 5319

class Solution < Struct.new(
  :name,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_auto_training,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config,
  :auto_ml_result,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :latest_solution_version,
  :latest_solution_update)
  SENSITIVE = []
  include Aws::Structure
end

#perform_auto_ml ⇒ `Boolean`

We don’t recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize recipes. For more information, see [Determining your use case.]

When true, Amazon Personalize performs a search for the best USER_PERSONALIZATION recipe from the list specified in the solution configuration (‘recipeArn` must not be specified). When false (the default), Amazon Personalize uses `recipeArn` for training.

[1]: docs.aws.amazon.com/personalize/latest/dg/determining-use-case.html

Returns:

(Boolean)

# File 'lib/aws-sdk-personalize/types.rb', line 5319

class Solution < Struct.new(
  :name,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_auto_training,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config,
  :auto_ml_result,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :latest_solution_version,
  :latest_solution_update)
  SENSITIVE = []
  include Aws::Structure
end

#perform_auto_training ⇒ `Boolean`

Specifies whether the solution automatically creates solution versions. The default is ‘True` and the solution automatically creates new solution versions every 7 days.

For more information about auto training, see [Creating and configuring a solution].

[1]: docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html

Returns:

(Boolean)

# File 'lib/aws-sdk-personalize/types.rb', line 5319

class Solution < Struct.new(
  :name,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_auto_training,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config,
  :auto_ml_result,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :latest_solution_version,
  :latest_solution_update)
  SENSITIVE = []
  include Aws::Structure
end

#perform_hpo ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'lib/aws-sdk-personalize/types.rb', line 5319

class Solution < Struct.new(
  :name,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_auto_training,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config,
  :auto_ml_result,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :latest_solution_version,
  :latest_solution_update)
  SENSITIVE = []
  include Aws::Structure
end

#recipe_arn ⇒ `String`

The ARN of the recipe used to create the solution. This is required when ‘performAutoML` is false.

Returns:

(String)

# File 'lib/aws-sdk-personalize/types.rb', line 5319

class Solution < Struct.new(
  :name,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_auto_training,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config,
  :auto_ml_result,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :latest_solution_version,
  :latest_solution_update)
  SENSITIVE = []
  include Aws::Structure
end

#solution_arn ⇒ `String`

The ARN of the solution.

Returns:

(String)

# File 'lib/aws-sdk-personalize/types.rb', line 5319

class Solution < Struct.new(
  :name,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_auto_training,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config,
  :auto_ml_result,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :latest_solution_version,
  :latest_solution_update)
  SENSITIVE = []
  include Aws::Structure
end

#solution_config ⇒ `Types::SolutionConfig`

Describes the configuration properties for the solution.

Returns:

(Types::SolutionConfig)

# File 'lib/aws-sdk-personalize/types.rb', line 5319

class Solution < Struct.new(
  :name,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_auto_training,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config,
  :auto_ml_result,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :latest_solution_version,
  :latest_solution_update)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

The status of the solution.

A solution can be in one of the following states:

CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS

Returns:

(String)

# File 'lib/aws-sdk-personalize/types.rb', line 5319

class Solution < Struct.new(
  :name,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :perform_auto_training,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config,
  :auto_ml_result,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :latest_solution_version,
  :latest_solution_update)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::Personalize::Types::Solution

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#auto_ml_result ⇒ Types::AutoMLResult

#creation_date_time ⇒ Time

#dataset_group_arn ⇒ String

#event_type ⇒ String

#last_updated_date_time ⇒ Time

#latest_solution_update ⇒ Types::SolutionUpdateSummary

#latest_solution_version ⇒ Types::SolutionVersionSummary

#name ⇒ String

#perform_auto_ml ⇒ Boolean

#perform_auto_training ⇒ Boolean

#perform_hpo ⇒ Boolean

#recipe_arn ⇒ String

#solution_arn ⇒ String

#solution_config ⇒ Types::SolutionConfig

#status ⇒ String

#auto_ml_result ⇒ `Types::AutoMLResult`

#creation_date_time ⇒ `Time`

#dataset_group_arn ⇒ `String`

#event_type ⇒ `String`

#last_updated_date_time ⇒ `Time`

#latest_solution_update ⇒ `Types::SolutionUpdateSummary`

#latest_solution_version ⇒ `Types::SolutionVersionSummary`

#name ⇒ `String`

#perform_auto_ml ⇒ `Boolean`

#perform_auto_training ⇒ `Boolean`

#perform_hpo ⇒ `Boolean`

#recipe_arn ⇒ `String`

#solution_arn ⇒ `String`

#solution_config ⇒ `Types::SolutionConfig`

#status ⇒ `String`