/** * 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 #include #include #include namespace Aws { namespace SageMaker { namespace Model { /** */ class CreateInferenceRecommendationsJobRequest : public SageMakerRequest { public: AWS_SAGEMAKER_API CreateInferenceRecommendationsJobRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "CreateInferenceRecommendationsJob"; } AWS_SAGEMAKER_API Aws::String SerializePayload() const override; AWS_SAGEMAKER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

A name for the recommendation job. The name must be unique within the Amazon * Web Services Region and within your Amazon Web Services account. The job name is * passed down to the resources created by the recommendation job. The names of * resources (such as the model, endpoint configuration, endpoint, and compilation) * that are prefixed with the job name are truncated at 40 characters.

*/ inline const Aws::String& GetJobName() const{ return m_jobName; } /** *

A name for the recommendation job. The name must be unique within the Amazon * Web Services Region and within your Amazon Web Services account. The job name is * passed down to the resources created by the recommendation job. The names of * resources (such as the model, endpoint configuration, endpoint, and compilation) * that are prefixed with the job name are truncated at 40 characters.

*/ inline bool JobNameHasBeenSet() const { return m_jobNameHasBeenSet; } /** *

A name for the recommendation job. The name must be unique within the Amazon * Web Services Region and within your Amazon Web Services account. The job name is * passed down to the resources created by the recommendation job. The names of * resources (such as the model, endpoint configuration, endpoint, and compilation) * that are prefixed with the job name are truncated at 40 characters.

*/ inline void SetJobName(const Aws::String& value) { m_jobNameHasBeenSet = true; m_jobName = value; } /** *

A name for the recommendation job. The name must be unique within the Amazon * Web Services Region and within your Amazon Web Services account. The job name is * passed down to the resources created by the recommendation job. The names of * resources (such as the model, endpoint configuration, endpoint, and compilation) * that are prefixed with the job name are truncated at 40 characters.

*/ inline void SetJobName(Aws::String&& value) { m_jobNameHasBeenSet = true; m_jobName = std::move(value); } /** *

A name for the recommendation job. The name must be unique within the Amazon * Web Services Region and within your Amazon Web Services account. The job name is * passed down to the resources created by the recommendation job. The names of * resources (such as the model, endpoint configuration, endpoint, and compilation) * that are prefixed with the job name are truncated at 40 characters.

*/ inline void SetJobName(const char* value) { m_jobNameHasBeenSet = true; m_jobName.assign(value); } /** *

A name for the recommendation job. The name must be unique within the Amazon * Web Services Region and within your Amazon Web Services account. The job name is * passed down to the resources created by the recommendation job. The names of * resources (such as the model, endpoint configuration, endpoint, and compilation) * that are prefixed with the job name are truncated at 40 characters.

*/ inline CreateInferenceRecommendationsJobRequest& WithJobName(const Aws::String& value) { SetJobName(value); return *this;} /** *

A name for the recommendation job. The name must be unique within the Amazon * Web Services Region and within your Amazon Web Services account. The job name is * passed down to the resources created by the recommendation job. The names of * resources (such as the model, endpoint configuration, endpoint, and compilation) * that are prefixed with the job name are truncated at 40 characters.

*/ inline CreateInferenceRecommendationsJobRequest& WithJobName(Aws::String&& value) { SetJobName(std::move(value)); return *this;} /** *

A name for the recommendation job. The name must be unique within the Amazon * Web Services Region and within your Amazon Web Services account. The job name is * passed down to the resources created by the recommendation job. The names of * resources (such as the model, endpoint configuration, endpoint, and compilation) * that are prefixed with the job name are truncated at 40 characters.

*/ inline CreateInferenceRecommendationsJobRequest& WithJobName(const char* value) { SetJobName(value); return *this;} /** *

Defines the type of recommendation job. Specify Default to * initiate an instance recommendation and Advanced to initiate a load * test. If left unspecified, Amazon SageMaker Inference Recommender will run an * instance recommendation (DEFAULT) job.

*/ inline const RecommendationJobType& GetJobType() const{ return m_jobType; } /** *

Defines the type of recommendation job. Specify Default to * initiate an instance recommendation and Advanced to initiate a load * test. If left unspecified, Amazon SageMaker Inference Recommender will run an * instance recommendation (DEFAULT) job.

*/ inline bool JobTypeHasBeenSet() const { return m_jobTypeHasBeenSet; } /** *

Defines the type of recommendation job. Specify Default to * initiate an instance recommendation and Advanced to initiate a load * test. If left unspecified, Amazon SageMaker Inference Recommender will run an * instance recommendation (DEFAULT) job.

*/ inline void SetJobType(const RecommendationJobType& value) { m_jobTypeHasBeenSet = true; m_jobType = value; } /** *

Defines the type of recommendation job. Specify Default to * initiate an instance recommendation and Advanced to initiate a load * test. If left unspecified, Amazon SageMaker Inference Recommender will run an * instance recommendation (DEFAULT) job.

*/ inline void SetJobType(RecommendationJobType&& value) { m_jobTypeHasBeenSet = true; m_jobType = std::move(value); } /** *

Defines the type of recommendation job. Specify Default to * initiate an instance recommendation and Advanced to initiate a load * test. If left unspecified, Amazon SageMaker Inference Recommender will run an * instance recommendation (DEFAULT) job.

*/ inline CreateInferenceRecommendationsJobRequest& WithJobType(const RecommendationJobType& value) { SetJobType(value); return *this;} /** *

Defines the type of recommendation job. Specify Default to * initiate an instance recommendation and Advanced to initiate a load * test. If left unspecified, Amazon SageMaker Inference Recommender will run an * instance recommendation (DEFAULT) job.

*/ inline CreateInferenceRecommendationsJobRequest& WithJobType(RecommendationJobType&& value) { SetJobType(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker * to perform tasks on your behalf.

*/ inline const Aws::String& GetRoleArn() const{ return m_roleArn; } /** *

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker * to perform tasks on your behalf.

*/ inline bool RoleArnHasBeenSet() const { return m_roleArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker * to perform tasks on your behalf.

*/ inline void SetRoleArn(const Aws::String& value) { m_roleArnHasBeenSet = true; m_roleArn = value; } /** *

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker * to perform tasks on your behalf.

*/ inline void SetRoleArn(Aws::String&& value) { m_roleArnHasBeenSet = true; m_roleArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker * to perform tasks on your behalf.

*/ inline void SetRoleArn(const char* value) { m_roleArnHasBeenSet = true; m_roleArn.assign(value); } /** *

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker * to perform tasks on your behalf.

*/ inline CreateInferenceRecommendationsJobRequest& WithRoleArn(const Aws::String& value) { SetRoleArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker * to perform tasks on your behalf.

*/ inline CreateInferenceRecommendationsJobRequest& WithRoleArn(Aws::String&& value) { SetRoleArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker * to perform tasks on your behalf.

*/ inline CreateInferenceRecommendationsJobRequest& WithRoleArn(const char* value) { SetRoleArn(value); return *this;} /** *

Provides information about the versioned model package Amazon Resource Name * (ARN), the traffic pattern, and endpoint configurations.

*/ inline const RecommendationJobInputConfig& GetInputConfig() const{ return m_inputConfig; } /** *

Provides information about the versioned model package Amazon Resource Name * (ARN), the traffic pattern, and endpoint configurations.

*/ inline bool InputConfigHasBeenSet() const { return m_inputConfigHasBeenSet; } /** *

Provides information about the versioned model package Amazon Resource Name * (ARN), the traffic pattern, and endpoint configurations.

*/ inline void SetInputConfig(const RecommendationJobInputConfig& value) { m_inputConfigHasBeenSet = true; m_inputConfig = value; } /** *

Provides information about the versioned model package Amazon Resource Name * (ARN), the traffic pattern, and endpoint configurations.

*/ inline void SetInputConfig(RecommendationJobInputConfig&& value) { m_inputConfigHasBeenSet = true; m_inputConfig = std::move(value); } /** *

Provides information about the versioned model package Amazon Resource Name * (ARN), the traffic pattern, and endpoint configurations.

*/ inline CreateInferenceRecommendationsJobRequest& WithInputConfig(const RecommendationJobInputConfig& value) { SetInputConfig(value); return *this;} /** *

Provides information about the versioned model package Amazon Resource Name * (ARN), the traffic pattern, and endpoint configurations.

*/ inline CreateInferenceRecommendationsJobRequest& WithInputConfig(RecommendationJobInputConfig&& value) { SetInputConfig(std::move(value)); return *this;} /** *

Description of the recommendation job.

*/ inline const Aws::String& GetJobDescription() const{ return m_jobDescription; } /** *

Description of the recommendation job.

*/ inline bool JobDescriptionHasBeenSet() const { return m_jobDescriptionHasBeenSet; } /** *

Description of the recommendation job.

*/ inline void SetJobDescription(const Aws::String& value) { m_jobDescriptionHasBeenSet = true; m_jobDescription = value; } /** *

Description of the recommendation job.

*/ inline void SetJobDescription(Aws::String&& value) { m_jobDescriptionHasBeenSet = true; m_jobDescription = std::move(value); } /** *

Description of the recommendation job.

*/ inline void SetJobDescription(const char* value) { m_jobDescriptionHasBeenSet = true; m_jobDescription.assign(value); } /** *

Description of the recommendation job.

*/ inline CreateInferenceRecommendationsJobRequest& WithJobDescription(const Aws::String& value) { SetJobDescription(value); return *this;} /** *

Description of the recommendation job.

*/ inline CreateInferenceRecommendationsJobRequest& WithJobDescription(Aws::String&& value) { SetJobDescription(std::move(value)); return *this;} /** *

Description of the recommendation job.

*/ inline CreateInferenceRecommendationsJobRequest& WithJobDescription(const char* value) { SetJobDescription(value); return *this;} /** *

A set of conditions for stopping a recommendation job. If any of the * conditions are met, the job is automatically stopped.

*/ inline const RecommendationJobStoppingConditions& GetStoppingConditions() const{ return m_stoppingConditions; } /** *

A set of conditions for stopping a recommendation job. If any of the * conditions are met, the job is automatically stopped.

*/ inline bool StoppingConditionsHasBeenSet() const { return m_stoppingConditionsHasBeenSet; } /** *

A set of conditions for stopping a recommendation job. If any of the * conditions are met, the job is automatically stopped.

*/ inline void SetStoppingConditions(const RecommendationJobStoppingConditions& value) { m_stoppingConditionsHasBeenSet = true; m_stoppingConditions = value; } /** *

A set of conditions for stopping a recommendation job. If any of the * conditions are met, the job is automatically stopped.

*/ inline void SetStoppingConditions(RecommendationJobStoppingConditions&& value) { m_stoppingConditionsHasBeenSet = true; m_stoppingConditions = std::move(value); } /** *

A set of conditions for stopping a recommendation job. If any of the * conditions are met, the job is automatically stopped.

*/ inline CreateInferenceRecommendationsJobRequest& WithStoppingConditions(const RecommendationJobStoppingConditions& value) { SetStoppingConditions(value); return *this;} /** *

A set of conditions for stopping a recommendation job. If any of the * conditions are met, the job is automatically stopped.

*/ inline CreateInferenceRecommendationsJobRequest& WithStoppingConditions(RecommendationJobStoppingConditions&& value) { SetStoppingConditions(std::move(value)); return *this;} /** *

Provides information about the output artifacts and the KMS key to use for * Amazon S3 server-side encryption.

*/ inline const RecommendationJobOutputConfig& GetOutputConfig() const{ return m_outputConfig; } /** *

Provides information about the output artifacts and the KMS key to use for * Amazon S3 server-side encryption.

*/ inline bool OutputConfigHasBeenSet() const { return m_outputConfigHasBeenSet; } /** *

Provides information about the output artifacts and the KMS key to use for * Amazon S3 server-side encryption.

*/ inline void SetOutputConfig(const RecommendationJobOutputConfig& value) { m_outputConfigHasBeenSet = true; m_outputConfig = value; } /** *

Provides information about the output artifacts and the KMS key to use for * Amazon S3 server-side encryption.

*/ inline void SetOutputConfig(RecommendationJobOutputConfig&& value) { m_outputConfigHasBeenSet = true; m_outputConfig = std::move(value); } /** *

Provides information about the output artifacts and the KMS key to use for * Amazon S3 server-side encryption.

*/ inline CreateInferenceRecommendationsJobRequest& WithOutputConfig(const RecommendationJobOutputConfig& value) { SetOutputConfig(value); return *this;} /** *

Provides information about the output artifacts and the KMS key to use for * Amazon S3 server-side encryption.

*/ inline CreateInferenceRecommendationsJobRequest& WithOutputConfig(RecommendationJobOutputConfig&& value) { SetOutputConfig(std::move(value)); return *this;} /** *

The metadata that you apply to Amazon Web Services resources to help you * categorize and organize them. Each tag consists of a key and a value, both of * which you define. For more information, see Tagging * Amazon Web Services Resources in the Amazon Web Services General * Reference.

*/ inline const Aws::Vector& GetTags() const{ return m_tags; } /** *

The metadata that you apply to Amazon Web Services resources to help you * categorize and organize them. Each tag consists of a key and a value, both of * which you define. For more information, see Tagging * Amazon Web Services Resources in the Amazon Web Services General * Reference.

*/ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** *

The metadata that you apply to Amazon Web Services resources to help you * categorize and organize them. Each tag consists of a key and a value, both of * which you define. For more information, see Tagging * Amazon Web Services Resources in the Amazon Web Services General * Reference.

*/ inline void SetTags(const Aws::Vector& value) { m_tagsHasBeenSet = true; m_tags = value; } /** *

The metadata that you apply to Amazon Web Services resources to help you * categorize and organize them. Each tag consists of a key and a value, both of * which you define. For more information, see Tagging * Amazon Web Services Resources in the Amazon Web Services General * Reference.

*/ inline void SetTags(Aws::Vector&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } /** *

The metadata that you apply to Amazon Web Services resources to help you * categorize and organize them. Each tag consists of a key and a value, both of * which you define. For more information, see Tagging * Amazon Web Services Resources in the Amazon Web Services General * Reference.

*/ inline CreateInferenceRecommendationsJobRequest& WithTags(const Aws::Vector& value) { SetTags(value); return *this;} /** *

The metadata that you apply to Amazon Web Services resources to help you * categorize and organize them. Each tag consists of a key and a value, both of * which you define. For more information, see Tagging * Amazon Web Services Resources in the Amazon Web Services General * Reference.

*/ inline CreateInferenceRecommendationsJobRequest& WithTags(Aws::Vector&& value) { SetTags(std::move(value)); return *this;} /** *

The metadata that you apply to Amazon Web Services resources to help you * categorize and organize them. Each tag consists of a key and a value, both of * which you define. For more information, see Tagging * Amazon Web Services Resources in the Amazon Web Services General * Reference.

*/ inline CreateInferenceRecommendationsJobRequest& AddTags(const Tag& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; } /** *

The metadata that you apply to Amazon Web Services resources to help you * categorize and organize them. Each tag consists of a key and a value, both of * which you define. For more information, see Tagging * Amazon Web Services Resources in the Amazon Web Services General * Reference.

*/ inline CreateInferenceRecommendationsJobRequest& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; } private: Aws::String m_jobName; bool m_jobNameHasBeenSet = false; RecommendationJobType m_jobType; bool m_jobTypeHasBeenSet = false; Aws::String m_roleArn; bool m_roleArnHasBeenSet = false; RecommendationJobInputConfig m_inputConfig; bool m_inputConfigHasBeenSet = false; Aws::String m_jobDescription; bool m_jobDescriptionHasBeenSet = false; RecommendationJobStoppingConditions m_stoppingConditions; bool m_stoppingConditionsHasBeenSet = false; RecommendationJobOutputConfig m_outputConfig; bool m_outputConfigHasBeenSet = false; Aws::Vector m_tags; bool m_tagsHasBeenSet = false; }; } // namespace Model } // namespace SageMaker } // namespace Aws