AWS SDK for C++  1.9.107
AWS SDK for C++
Public Member Functions | List of all members
Aws::Personalize::Model::CreateSolutionRequest Class Reference

#include <CreateSolutionRequest.h>

+ Inheritance diagram for Aws::Personalize::Model::CreateSolutionRequest:

Public Member Functions

 CreateSolutionRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CreateSolutionRequestWithName (const Aws::String &value)
 
CreateSolutionRequestWithName (Aws::String &&value)
 
CreateSolutionRequestWithName (const char *value)
 
bool GetPerformHPO () const
 
bool PerformHPOHasBeenSet () const
 
void SetPerformHPO (bool value)
 
CreateSolutionRequestWithPerformHPO (bool value)
 
bool GetPerformAutoML () const
 
bool PerformAutoMLHasBeenSet () const
 
void SetPerformAutoML (bool value)
 
CreateSolutionRequestWithPerformAutoML (bool value)
 
const Aws::StringGetRecipeArn () const
 
bool RecipeArnHasBeenSet () const
 
void SetRecipeArn (const Aws::String &value)
 
void SetRecipeArn (Aws::String &&value)
 
void SetRecipeArn (const char *value)
 
CreateSolutionRequestWithRecipeArn (const Aws::String &value)
 
CreateSolutionRequestWithRecipeArn (Aws::String &&value)
 
CreateSolutionRequestWithRecipeArn (const char *value)
 
const Aws::StringGetDatasetGroupArn () const
 
bool DatasetGroupArnHasBeenSet () const
 
void SetDatasetGroupArn (const Aws::String &value)
 
void SetDatasetGroupArn (Aws::String &&value)
 
void SetDatasetGroupArn (const char *value)
 
CreateSolutionRequestWithDatasetGroupArn (const Aws::String &value)
 
CreateSolutionRequestWithDatasetGroupArn (Aws::String &&value)
 
CreateSolutionRequestWithDatasetGroupArn (const char *value)
 
const Aws::StringGetEventType () const
 
bool EventTypeHasBeenSet () const
 
void SetEventType (const Aws::String &value)
 
void SetEventType (Aws::String &&value)
 
void SetEventType (const char *value)
 
CreateSolutionRequestWithEventType (const Aws::String &value)
 
CreateSolutionRequestWithEventType (Aws::String &&value)
 
CreateSolutionRequestWithEventType (const char *value)
 
const SolutionConfigGetSolutionConfig () const
 
bool SolutionConfigHasBeenSet () const
 
void SetSolutionConfig (const SolutionConfig &value)
 
void SetSolutionConfig (SolutionConfig &&value)
 
CreateSolutionRequestWithSolutionConfig (const SolutionConfig &value)
 
CreateSolutionRequestWithSolutionConfig (SolutionConfig &&value)
 
- Public Member Functions inherited from Aws::Personalize::PersonalizeRequest
virtual ~PersonalizeRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 22 of file CreateSolutionRequest.h.

Constructor & Destructor Documentation

◆ CreateSolutionRequest()

Aws::Personalize::Model::CreateSolutionRequest::CreateSolutionRequest ( )

Member Function Documentation

◆ DatasetGroupArnHasBeenSet()

bool Aws::Personalize::Model::CreateSolutionRequest::DatasetGroupArnHasBeenSet ( ) const
inline

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

Definition at line 220 of file CreateSolutionRequest.h.

◆ EventTypeHasBeenSet()

bool Aws::Personalize::Model::CreateSolutionRequest::EventTypeHasBeenSet ( ) const
inline

When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.

If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.

Definition at line 275 of file CreateSolutionRequest.h.

◆ GetDatasetGroupArn()

const Aws::String& Aws::Personalize::Model::CreateSolutionRequest::GetDatasetGroupArn ( ) const
inline

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

Definition at line 214 of file CreateSolutionRequest.h.

◆ GetEventType()

const Aws::String& Aws::Personalize::Model::CreateSolutionRequest::GetEventType ( ) const
inline

When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.

If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.

Definition at line 266 of file CreateSolutionRequest.h.

◆ GetName()

const Aws::String& Aws::Personalize::Model::CreateSolutionRequest::GetName ( ) const
inline

The name for the solution.

Definition at line 41 of file CreateSolutionRequest.h.

◆ GetPerformAutoML()

bool Aws::Personalize::Model::CreateSolutionRequest::GetPerformAutoML ( ) const
inline

Whether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn.

When set to true, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.

Definition at line 122 of file CreateSolutionRequest.h.

◆ GetPerformHPO()

bool Aws::Personalize::Model::CreateSolutionRequest::GetPerformHPO ( ) const
inline

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

When performing AutoML, this parameter is always true and you should not set it to false.

Definition at line 85 of file CreateSolutionRequest.h.

◆ GetRecipeArn()

const Aws::String& Aws::Personalize::Model::CreateSolutionRequest::GetRecipeArn ( ) const
inline

The ARN of the recipe to use for model training. Only specified when performAutoML is false.

Definition at line 165 of file CreateSolutionRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Personalize::Model::CreateSolutionRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::Personalize::Model::CreateSolutionRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file CreateSolutionRequest.h.

◆ GetSolutionConfig()

const SolutionConfig& Aws::Personalize::Model::CreateSolutionRequest::GetSolutionConfig ( ) const
inline

The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.

Amazon Personalize doesn't support configuring the hpoObjective at this time.

Definition at line 338 of file CreateSolutionRequest.h.

◆ NameHasBeenSet()

bool Aws::Personalize::Model::CreateSolutionRequest::NameHasBeenSet ( ) const
inline

The name for the solution.

Definition at line 46 of file CreateSolutionRequest.h.

◆ PerformAutoMLHasBeenSet()

bool Aws::Personalize::Model::CreateSolutionRequest::PerformAutoMLHasBeenSet ( ) const
inline

Whether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn.

When set to true, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.

Definition at line 134 of file CreateSolutionRequest.h.

◆ PerformHPOHasBeenSet()

bool Aws::Personalize::Model::CreateSolutionRequest::PerformHPOHasBeenSet ( ) const
inline

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

When performing AutoML, this parameter is always true and you should not set it to false.

Definition at line 93 of file CreateSolutionRequest.h.

◆ RecipeArnHasBeenSet()

bool Aws::Personalize::Model::CreateSolutionRequest::RecipeArnHasBeenSet ( ) const
inline

The ARN of the recipe to use for model training. Only specified when performAutoML is false.

Definition at line 171 of file CreateSolutionRequest.h.

◆ SerializePayload()

Aws::String Aws::Personalize::Model::CreateSolutionRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDatasetGroupArn() [1/3]

void Aws::Personalize::Model::CreateSolutionRequest::SetDatasetGroupArn ( Aws::String &&  value)
inline

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

Definition at line 232 of file CreateSolutionRequest.h.

◆ SetDatasetGroupArn() [2/3]

void Aws::Personalize::Model::CreateSolutionRequest::SetDatasetGroupArn ( const Aws::String value)
inline

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

Definition at line 226 of file CreateSolutionRequest.h.

◆ SetDatasetGroupArn() [3/3]

void Aws::Personalize::Model::CreateSolutionRequest::SetDatasetGroupArn ( const char *  value)
inline

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

Definition at line 238 of file CreateSolutionRequest.h.

◆ SetEventType() [1/3]

void Aws::Personalize::Model::CreateSolutionRequest::SetEventType ( Aws::String &&  value)
inline

When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.

If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.

Definition at line 293 of file CreateSolutionRequest.h.

◆ SetEventType() [2/3]

void Aws::Personalize::Model::CreateSolutionRequest::SetEventType ( const Aws::String value)
inline

When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.

If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.

Definition at line 284 of file CreateSolutionRequest.h.

◆ SetEventType() [3/3]

void Aws::Personalize::Model::CreateSolutionRequest::SetEventType ( const char *  value)
inline

When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.

If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.

Definition at line 302 of file CreateSolutionRequest.h.

◆ SetName() [1/3]

void Aws::Personalize::Model::CreateSolutionRequest::SetName ( Aws::String &&  value)
inline

The name for the solution.

Definition at line 56 of file CreateSolutionRequest.h.

◆ SetName() [2/3]

void Aws::Personalize::Model::CreateSolutionRequest::SetName ( const Aws::String value)
inline

The name for the solution.

Definition at line 51 of file CreateSolutionRequest.h.

◆ SetName() [3/3]

void Aws::Personalize::Model::CreateSolutionRequest::SetName ( const char *  value)
inline

The name for the solution.

Definition at line 61 of file CreateSolutionRequest.h.

◆ SetPerformAutoML()

void Aws::Personalize::Model::CreateSolutionRequest::SetPerformAutoML ( bool  value)
inline

Whether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn.

When set to true, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.

Definition at line 146 of file CreateSolutionRequest.h.

◆ SetPerformHPO()

void Aws::Personalize::Model::CreateSolutionRequest::SetPerformHPO ( bool  value)
inline

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

When performing AutoML, this parameter is always true and you should not set it to false.

Definition at line 101 of file CreateSolutionRequest.h.

◆ SetRecipeArn() [1/3]

void Aws::Personalize::Model::CreateSolutionRequest::SetRecipeArn ( Aws::String &&  value)
inline

The ARN of the recipe to use for model training. Only specified when performAutoML is false.

Definition at line 183 of file CreateSolutionRequest.h.

◆ SetRecipeArn() [2/3]

void Aws::Personalize::Model::CreateSolutionRequest::SetRecipeArn ( const Aws::String value)
inline

The ARN of the recipe to use for model training. Only specified when performAutoML is false.

Definition at line 177 of file CreateSolutionRequest.h.

◆ SetRecipeArn() [3/3]

void Aws::Personalize::Model::CreateSolutionRequest::SetRecipeArn ( const char *  value)
inline

The ARN of the recipe to use for model training. Only specified when performAutoML is false.

Definition at line 189 of file CreateSolutionRequest.h.

◆ SetSolutionConfig() [1/2]

void Aws::Personalize::Model::CreateSolutionRequest::SetSolutionConfig ( const SolutionConfig value)
inline

The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.

Amazon Personalize doesn't support configuring the hpoObjective at this time.

Definition at line 354 of file CreateSolutionRequest.h.

◆ SetSolutionConfig() [2/2]

void Aws::Personalize::Model::CreateSolutionRequest::SetSolutionConfig ( SolutionConfig &&  value)
inline

The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.

Amazon Personalize doesn't support configuring the hpoObjective at this time.

Definition at line 362 of file CreateSolutionRequest.h.

◆ SolutionConfigHasBeenSet()

bool Aws::Personalize::Model::CreateSolutionRequest::SolutionConfigHasBeenSet ( ) const
inline

The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.

Amazon Personalize doesn't support configuring the hpoObjective at this time.

Definition at line 346 of file CreateSolutionRequest.h.

◆ WithDatasetGroupArn() [1/3]

CreateSolutionRequest& Aws::Personalize::Model::CreateSolutionRequest::WithDatasetGroupArn ( Aws::String &&  value)
inline

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

Definition at line 250 of file CreateSolutionRequest.h.

◆ WithDatasetGroupArn() [2/3]

CreateSolutionRequest& Aws::Personalize::Model::CreateSolutionRequest::WithDatasetGroupArn ( const Aws::String value)
inline

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

Definition at line 244 of file CreateSolutionRequest.h.

◆ WithDatasetGroupArn() [3/3]

CreateSolutionRequest& Aws::Personalize::Model::CreateSolutionRequest::WithDatasetGroupArn ( const char *  value)
inline

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

Definition at line 256 of file CreateSolutionRequest.h.

◆ WithEventType() [1/3]

CreateSolutionRequest& Aws::Personalize::Model::CreateSolutionRequest::WithEventType ( Aws::String &&  value)
inline

When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.

If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.

Definition at line 320 of file CreateSolutionRequest.h.

◆ WithEventType() [2/3]

CreateSolutionRequest& Aws::Personalize::Model::CreateSolutionRequest::WithEventType ( const Aws::String value)
inline

When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.

If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.

Definition at line 311 of file CreateSolutionRequest.h.

◆ WithEventType() [3/3]

CreateSolutionRequest& Aws::Personalize::Model::CreateSolutionRequest::WithEventType ( const char *  value)
inline

When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.

If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.

Definition at line 329 of file CreateSolutionRequest.h.

◆ WithName() [1/3]

CreateSolutionRequest& Aws::Personalize::Model::CreateSolutionRequest::WithName ( Aws::String &&  value)
inline

The name for the solution.

Definition at line 71 of file CreateSolutionRequest.h.

◆ WithName() [2/3]

CreateSolutionRequest& Aws::Personalize::Model::CreateSolutionRequest::WithName ( const Aws::String value)
inline

The name for the solution.

Definition at line 66 of file CreateSolutionRequest.h.

◆ WithName() [3/3]

CreateSolutionRequest& Aws::Personalize::Model::CreateSolutionRequest::WithName ( const char *  value)
inline

The name for the solution.

Definition at line 76 of file CreateSolutionRequest.h.

◆ WithPerformAutoML()

CreateSolutionRequest& Aws::Personalize::Model::CreateSolutionRequest::WithPerformAutoML ( bool  value)
inline

Whether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn.

When set to true, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.

Definition at line 158 of file CreateSolutionRequest.h.

◆ WithPerformHPO()

CreateSolutionRequest& Aws::Personalize::Model::CreateSolutionRequest::WithPerformHPO ( bool  value)
inline

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

When performing AutoML, this parameter is always true and you should not set it to false.

Definition at line 109 of file CreateSolutionRequest.h.

◆ WithRecipeArn() [1/3]

CreateSolutionRequest& Aws::Personalize::Model::CreateSolutionRequest::WithRecipeArn ( Aws::String &&  value)
inline

The ARN of the recipe to use for model training. Only specified when performAutoML is false.

Definition at line 201 of file CreateSolutionRequest.h.

◆ WithRecipeArn() [2/3]

CreateSolutionRequest& Aws::Personalize::Model::CreateSolutionRequest::WithRecipeArn ( const Aws::String value)
inline

The ARN of the recipe to use for model training. Only specified when performAutoML is false.

Definition at line 195 of file CreateSolutionRequest.h.

◆ WithRecipeArn() [3/3]

CreateSolutionRequest& Aws::Personalize::Model::CreateSolutionRequest::WithRecipeArn ( const char *  value)
inline

The ARN of the recipe to use for model training. Only specified when performAutoML is false.

Definition at line 207 of file CreateSolutionRequest.h.

◆ WithSolutionConfig() [1/2]

CreateSolutionRequest& Aws::Personalize::Model::CreateSolutionRequest::WithSolutionConfig ( const SolutionConfig value)
inline

The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.

Amazon Personalize doesn't support configuring the hpoObjective at this time.

Definition at line 370 of file CreateSolutionRequest.h.

◆ WithSolutionConfig() [2/2]

CreateSolutionRequest& Aws::Personalize::Model::CreateSolutionRequest::WithSolutionConfig ( SolutionConfig &&  value)
inline

The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.

Amazon Personalize doesn't support configuring the hpoObjective at this time.

Definition at line 378 of file CreateSolutionRequest.h.


The documentation for this class was generated from the following file: