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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-personalize/types.rb

Overview

An object that provides information about a solution. A solution is a trained model that can be deployed as a campaign.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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_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_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 4935

class Solution < Struct.new(
  :name,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config,
  :auto_ml_result,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :latest_solution_version)
  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 4935

class Solution < Struct.new(
  :name,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config,
  :auto_ml_result,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :latest_solution_version)
  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 4935

class Solution < Struct.new(
  :name,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config,
  :auto_ml_result,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :latest_solution_version)
  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 4935

class Solution < Struct.new(
  :name,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config,
  :auto_ml_result,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :latest_solution_version)
  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 4935

class Solution < Struct.new(
  :name,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config,
  :auto_ml_result,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :latest_solution_version)
  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 4935

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

#name ⇒ String

The name of the solution.

Returns:

• (String)

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

class Solution < Struct.new(
  :name,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config,
  :auto_ml_result,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :latest_solution_version)
  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 4935

class Solution < Struct.new(
  :name,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config,
  :auto_ml_result,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :latest_solution_version)
  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 4935

class Solution < Struct.new(
  :name,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config,
  :auto_ml_result,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :latest_solution_version)
  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 4935

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

#solution_arn ⇒ String

The ARN of the solution.

Returns:

• (String)

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

class Solution < Struct.new(
  :name,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config,
  :auto_ml_result,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :latest_solution_version)
  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 4935

class Solution < Struct.new(
  :name,
  :solution_arn,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config,
  :auto_ml_result,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :latest_solution_version)
  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 4935

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