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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-personalize/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_ml_resultTypes::AutoMLResult

When performAutoML is true, specifies the best recipe found.

Returns:



5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
# File 'gems/aws-sdk-personalize/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_timeTime

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

Returns:

  • (Time)


5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
# File 'gems/aws-sdk-personalize/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_arnString

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

Returns:

  • (String)


5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
# File 'gems/aws-sdk-personalize/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_typeString

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)


5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
# File 'gems/aws-sdk-personalize/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_timeTime

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

Returns:

  • (Time)


5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
# File 'gems/aws-sdk-personalize/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_updateTypes::SolutionUpdateSummary

Provides a summary of the latest updates to the solution.



5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
# File 'gems/aws-sdk-personalize/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_versionTypes::SolutionVersionSummary

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



5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
# File 'gems/aws-sdk-personalize/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

#nameString

The name of the solution.

Returns:

  • (String)


5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
# File 'gems/aws-sdk-personalize/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_mlBoolean

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.

Returns:

  • (Boolean)


5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
# File 'gems/aws-sdk-personalize/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_trainingBoolean

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.

Returns:

  • (Boolean)


5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
# File 'gems/aws-sdk-personalize/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_hpoBoolean

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

Returns:

  • (Boolean)


5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
# File 'gems/aws-sdk-personalize/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_arnString

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

Returns:

  • (String)


5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
# File 'gems/aws-sdk-personalize/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_arnString

The ARN of the solution.

Returns:

  • (String)


5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
# File 'gems/aws-sdk-personalize/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_configTypes::SolutionConfig

Describes the configuration properties for the solution.



5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
# File 'gems/aws-sdk-personalize/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

#statusString

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)


5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
# File 'gems/aws-sdk-personalize/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