/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace Personalize { namespace Model { /** *

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 Reference

*/ class Solution { public: AWS_PERSONALIZE_API Solution(); AWS_PERSONALIZE_API Solution(Aws::Utils::Json::JsonView jsonValue); AWS_PERSONALIZE_API Solution& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_PERSONALIZE_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The name of the solution.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

The name of the solution.

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

The name of the solution.

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

The name of the solution.

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

The name of the solution.

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

The name of the solution.

*/ inline Solution& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

The name of the solution.

*/ inline Solution& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

The name of the solution.

*/ inline Solution& WithName(const char* value) { SetName(value); return *this;} /** *

The ARN of the solution.

*/ inline const Aws::String& GetSolutionArn() const{ return m_solutionArn; } /** *

The ARN of the solution.

*/ inline bool SolutionArnHasBeenSet() const { return m_solutionArnHasBeenSet; } /** *

The ARN of the solution.

*/ inline void SetSolutionArn(const Aws::String& value) { m_solutionArnHasBeenSet = true; m_solutionArn = value; } /** *

The ARN of the solution.

*/ inline void SetSolutionArn(Aws::String&& value) { m_solutionArnHasBeenSet = true; m_solutionArn = std::move(value); } /** *

The ARN of the solution.

*/ inline void SetSolutionArn(const char* value) { m_solutionArnHasBeenSet = true; m_solutionArn.assign(value); } /** *

The ARN of the solution.

*/ inline Solution& WithSolutionArn(const Aws::String& value) { SetSolutionArn(value); return *this;} /** *

The ARN of the solution.

*/ inline Solution& WithSolutionArn(Aws::String&& value) { SetSolutionArn(std::move(value)); return *this;} /** *

The ARN of the solution.

*/ inline Solution& WithSolutionArn(const char* value) { SetSolutionArn(value); return *this;} /** *

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

*/ inline bool GetPerformHPO() const{ return m_performHPO; } /** *

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

*/ inline bool PerformHPOHasBeenSet() const { return m_performHPOHasBeenSet; } /** *

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

*/ inline void SetPerformHPO(bool value) { m_performHPOHasBeenSet = true; m_performHPO = value; } /** *

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

*/ inline Solution& WithPerformHPO(bool value) { SetPerformHPO(value); return *this;} /** *

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.

*/ inline bool GetPerformAutoML() const{ return m_performAutoML; } /** *

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.

*/ inline bool PerformAutoMLHasBeenSet() const { return m_performAutoMLHasBeenSet; } /** *

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.

*/ inline void SetPerformAutoML(bool value) { m_performAutoMLHasBeenSet = true; m_performAutoML = value; } /** *

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.

*/ inline Solution& WithPerformAutoML(bool value) { SetPerformAutoML(value); return *this;} /** *

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

*/ inline const Aws::String& GetRecipeArn() const{ return m_recipeArn; } /** *

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

*/ inline bool RecipeArnHasBeenSet() const { return m_recipeArnHasBeenSet; } /** *

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

*/ inline void SetRecipeArn(const Aws::String& value) { m_recipeArnHasBeenSet = true; m_recipeArn = value; } /** *

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

*/ inline void SetRecipeArn(Aws::String&& value) { m_recipeArnHasBeenSet = true; m_recipeArn = std::move(value); } /** *

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

*/ inline void SetRecipeArn(const char* value) { m_recipeArnHasBeenSet = true; m_recipeArn.assign(value); } /** *

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

*/ inline Solution& WithRecipeArn(const Aws::String& value) { SetRecipeArn(value); return *this;} /** *

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

*/ inline Solution& WithRecipeArn(Aws::String&& value) { SetRecipeArn(std::move(value)); return *this;} /** *

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

*/ inline Solution& WithRecipeArn(const char* value) { SetRecipeArn(value); return *this;} /** *

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

*/ inline const Aws::String& GetDatasetGroupArn() const{ return m_datasetGroupArn; } /** *

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

*/ inline bool DatasetGroupArnHasBeenSet() const { return m_datasetGroupArnHasBeenSet; } /** *

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

*/ inline void SetDatasetGroupArn(const Aws::String& value) { m_datasetGroupArnHasBeenSet = true; m_datasetGroupArn = value; } /** *

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

*/ inline void SetDatasetGroupArn(Aws::String&& value) { m_datasetGroupArnHasBeenSet = true; m_datasetGroupArn = std::move(value); } /** *

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

*/ inline void SetDatasetGroupArn(const char* value) { m_datasetGroupArnHasBeenSet = true; m_datasetGroupArn.assign(value); } /** *

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

*/ inline Solution& WithDatasetGroupArn(const Aws::String& value) { SetDatasetGroupArn(value); return *this;} /** *

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

*/ inline Solution& WithDatasetGroupArn(Aws::String&& value) { SetDatasetGroupArn(std::move(value)); return *this;} /** *

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

*/ inline Solution& WithDatasetGroupArn(const char* value) { SetDatasetGroupArn(value); return *this;} /** *

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.

*/ inline const Aws::String& GetEventType() const{ return m_eventType; } /** *

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.

*/ inline bool EventTypeHasBeenSet() const { return m_eventTypeHasBeenSet; } /** *

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.

*/ inline void SetEventType(const Aws::String& value) { m_eventTypeHasBeenSet = true; m_eventType = value; } /** *

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.

*/ inline void SetEventType(Aws::String&& value) { m_eventTypeHasBeenSet = true; m_eventType = std::move(value); } /** *

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.

*/ inline void SetEventType(const char* value) { m_eventTypeHasBeenSet = true; m_eventType.assign(value); } /** *

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.

*/ inline Solution& WithEventType(const Aws::String& value) { SetEventType(value); return *this;} /** *

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.

*/ inline Solution& WithEventType(Aws::String&& value) { SetEventType(std::move(value)); return *this;} /** *

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.

*/ inline Solution& WithEventType(const char* value) { SetEventType(value); return *this;} /** *

Describes the configuration properties for the solution.

*/ inline const SolutionConfig& GetSolutionConfig() const{ return m_solutionConfig; } /** *

Describes the configuration properties for the solution.

*/ inline bool SolutionConfigHasBeenSet() const { return m_solutionConfigHasBeenSet; } /** *

Describes the configuration properties for the solution.

*/ inline void SetSolutionConfig(const SolutionConfig& value) { m_solutionConfigHasBeenSet = true; m_solutionConfig = value; } /** *

Describes the configuration properties for the solution.

*/ inline void SetSolutionConfig(SolutionConfig&& value) { m_solutionConfigHasBeenSet = true; m_solutionConfig = std::move(value); } /** *

Describes the configuration properties for the solution.

*/ inline Solution& WithSolutionConfig(const SolutionConfig& value) { SetSolutionConfig(value); return *this;} /** *

Describes the configuration properties for the solution.

*/ inline Solution& WithSolutionConfig(SolutionConfig&& value) { SetSolutionConfig(std::move(value)); return *this;} /** *

When performAutoML is true, specifies the best recipe found.

*/ inline const AutoMLResult& GetAutoMLResult() const{ return m_autoMLResult; } /** *

When performAutoML is true, specifies the best recipe found.

*/ inline bool AutoMLResultHasBeenSet() const { return m_autoMLResultHasBeenSet; } /** *

When performAutoML is true, specifies the best recipe found.

*/ inline void SetAutoMLResult(const AutoMLResult& value) { m_autoMLResultHasBeenSet = true; m_autoMLResult = value; } /** *

When performAutoML is true, specifies the best recipe found.

*/ inline void SetAutoMLResult(AutoMLResult&& value) { m_autoMLResultHasBeenSet = true; m_autoMLResult = std::move(value); } /** *

When performAutoML is true, specifies the best recipe found.

*/ inline Solution& WithAutoMLResult(const AutoMLResult& value) { SetAutoMLResult(value); return *this;} /** *

When performAutoML is true, specifies the best recipe found.

*/ inline Solution& WithAutoMLResult(AutoMLResult&& value) { SetAutoMLResult(std::move(value)); return *this;} /** *

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

    • *
*/ inline const Aws::String& GetStatus() const{ return m_status; } /** *

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

    • *
*/ inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; } /** *

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

    • *
*/ inline void SetStatus(const Aws::String& value) { m_statusHasBeenSet = true; m_status = value; } /** *

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

    • *
*/ inline void SetStatus(Aws::String&& value) { m_statusHasBeenSet = true; m_status = std::move(value); } /** *

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

    • *
*/ inline void SetStatus(const char* value) { m_statusHasBeenSet = true; m_status.assign(value); } /** *

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

    • *
*/ inline Solution& WithStatus(const Aws::String& value) { SetStatus(value); return *this;} /** *

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

    • *
*/ inline Solution& WithStatus(Aws::String&& value) { SetStatus(std::move(value)); return *this;} /** *

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

    • *
*/ inline Solution& WithStatus(const char* value) { SetStatus(value); return *this;} /** *

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

*/ inline const Aws::Utils::DateTime& GetCreationDateTime() const{ return m_creationDateTime; } /** *

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

*/ inline bool CreationDateTimeHasBeenSet() const { return m_creationDateTimeHasBeenSet; } /** *

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

*/ inline void SetCreationDateTime(const Aws::Utils::DateTime& value) { m_creationDateTimeHasBeenSet = true; m_creationDateTime = value; } /** *

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

*/ inline void SetCreationDateTime(Aws::Utils::DateTime&& value) { m_creationDateTimeHasBeenSet = true; m_creationDateTime = std::move(value); } /** *

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

*/ inline Solution& WithCreationDateTime(const Aws::Utils::DateTime& value) { SetCreationDateTime(value); return *this;} /** *

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

*/ inline Solution& WithCreationDateTime(Aws::Utils::DateTime&& value) { SetCreationDateTime(std::move(value)); return *this;} /** *

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

*/ inline const Aws::Utils::DateTime& GetLastUpdatedDateTime() const{ return m_lastUpdatedDateTime; } /** *

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

*/ inline bool LastUpdatedDateTimeHasBeenSet() const { return m_lastUpdatedDateTimeHasBeenSet; } /** *

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

*/ inline void SetLastUpdatedDateTime(const Aws::Utils::DateTime& value) { m_lastUpdatedDateTimeHasBeenSet = true; m_lastUpdatedDateTime = value; } /** *

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

*/ inline void SetLastUpdatedDateTime(Aws::Utils::DateTime&& value) { m_lastUpdatedDateTimeHasBeenSet = true; m_lastUpdatedDateTime = std::move(value); } /** *

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

*/ inline Solution& WithLastUpdatedDateTime(const Aws::Utils::DateTime& value) { SetLastUpdatedDateTime(value); return *this;} /** *

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

*/ inline Solution& WithLastUpdatedDateTime(Aws::Utils::DateTime&& value) { SetLastUpdatedDateTime(std::move(value)); return *this;} /** *

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

*/ inline const SolutionVersionSummary& GetLatestSolutionVersion() const{ return m_latestSolutionVersion; } /** *

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

*/ inline bool LatestSolutionVersionHasBeenSet() const { return m_latestSolutionVersionHasBeenSet; } /** *

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

*/ inline void SetLatestSolutionVersion(const SolutionVersionSummary& value) { m_latestSolutionVersionHasBeenSet = true; m_latestSolutionVersion = value; } /** *

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

*/ inline void SetLatestSolutionVersion(SolutionVersionSummary&& value) { m_latestSolutionVersionHasBeenSet = true; m_latestSolutionVersion = std::move(value); } /** *

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

*/ inline Solution& WithLatestSolutionVersion(const SolutionVersionSummary& value) { SetLatestSolutionVersion(value); return *this;} /** *

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

*/ inline Solution& WithLatestSolutionVersion(SolutionVersionSummary&& value) { SetLatestSolutionVersion(std::move(value)); return *this;} private: Aws::String m_name; bool m_nameHasBeenSet = false; Aws::String m_solutionArn; bool m_solutionArnHasBeenSet = false; bool m_performHPO; bool m_performHPOHasBeenSet = false; bool m_performAutoML; bool m_performAutoMLHasBeenSet = false; Aws::String m_recipeArn; bool m_recipeArnHasBeenSet = false; Aws::String m_datasetGroupArn; bool m_datasetGroupArnHasBeenSet = false; Aws::String m_eventType; bool m_eventTypeHasBeenSet = false; SolutionConfig m_solutionConfig; bool m_solutionConfigHasBeenSet = false; AutoMLResult m_autoMLResult; bool m_autoMLResultHasBeenSet = false; Aws::String m_status; bool m_statusHasBeenSet = false; Aws::Utils::DateTime m_creationDateTime; bool m_creationDateTimeHasBeenSet = false; Aws::Utils::DateTime m_lastUpdatedDateTime; bool m_lastUpdatedDateTimeHasBeenSet = false; SolutionVersionSummary m_latestSolutionVersion; bool m_latestSolutionVersionHasBeenSet = false; }; } // namespace Model } // namespace Personalize } // namespace Aws