/** * 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 namespace Aws { namespace SageMaker { namespace Model { /** */ class CreateAlgorithmRequest : public SageMakerRequest { public: AWS_SAGEMAKER_API CreateAlgorithmRequest(); // 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 "CreateAlgorithm"; } AWS_SAGEMAKER_API Aws::String SerializePayload() const override; AWS_SAGEMAKER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The name of the algorithm.

*/ inline const Aws::String& GetAlgorithmName() const{ return m_algorithmName; } /** *

The name of the algorithm.

*/ inline bool AlgorithmNameHasBeenSet() const { return m_algorithmNameHasBeenSet; } /** *

The name of the algorithm.

*/ inline void SetAlgorithmName(const Aws::String& value) { m_algorithmNameHasBeenSet = true; m_algorithmName = value; } /** *

The name of the algorithm.

*/ inline void SetAlgorithmName(Aws::String&& value) { m_algorithmNameHasBeenSet = true; m_algorithmName = std::move(value); } /** *

The name of the algorithm.

*/ inline void SetAlgorithmName(const char* value) { m_algorithmNameHasBeenSet = true; m_algorithmName.assign(value); } /** *

The name of the algorithm.

*/ inline CreateAlgorithmRequest& WithAlgorithmName(const Aws::String& value) { SetAlgorithmName(value); return *this;} /** *

The name of the algorithm.

*/ inline CreateAlgorithmRequest& WithAlgorithmName(Aws::String&& value) { SetAlgorithmName(std::move(value)); return *this;} /** *

The name of the algorithm.

*/ inline CreateAlgorithmRequest& WithAlgorithmName(const char* value) { SetAlgorithmName(value); return *this;} /** *

A description of the algorithm.

*/ inline const Aws::String& GetAlgorithmDescription() const{ return m_algorithmDescription; } /** *

A description of the algorithm.

*/ inline bool AlgorithmDescriptionHasBeenSet() const { return m_algorithmDescriptionHasBeenSet; } /** *

A description of the algorithm.

*/ inline void SetAlgorithmDescription(const Aws::String& value) { m_algorithmDescriptionHasBeenSet = true; m_algorithmDescription = value; } /** *

A description of the algorithm.

*/ inline void SetAlgorithmDescription(Aws::String&& value) { m_algorithmDescriptionHasBeenSet = true; m_algorithmDescription = std::move(value); } /** *

A description of the algorithm.

*/ inline void SetAlgorithmDescription(const char* value) { m_algorithmDescriptionHasBeenSet = true; m_algorithmDescription.assign(value); } /** *

A description of the algorithm.

*/ inline CreateAlgorithmRequest& WithAlgorithmDescription(const Aws::String& value) { SetAlgorithmDescription(value); return *this;} /** *

A description of the algorithm.

*/ inline CreateAlgorithmRequest& WithAlgorithmDescription(Aws::String&& value) { SetAlgorithmDescription(std::move(value)); return *this;} /** *

A description of the algorithm.

*/ inline CreateAlgorithmRequest& WithAlgorithmDescription(const char* value) { SetAlgorithmDescription(value); return *this;} /** *

Specifies details about training jobs run by this algorithm, including the * following:

  • The Amazon ECR path of the container and the version * digest of the algorithm.

  • The hyperparameters that the * algorithm supports.

  • The instance types that the algorithm * supports for training.

  • Whether the algorithm supports * distributed training.

  • The metrics that the algorithm emits to * Amazon CloudWatch.

  • Which metrics that the algorithm emits can * be used as the objective metric for hyperparameter tuning jobs.

  • *

    The input channels that the algorithm supports for training data. For * example, an algorithm might support train, validation, * and test channels.

*/ inline const TrainingSpecification& GetTrainingSpecification() const{ return m_trainingSpecification; } /** *

Specifies details about training jobs run by this algorithm, including the * following:

  • The Amazon ECR path of the container and the version * digest of the algorithm.

  • The hyperparameters that the * algorithm supports.

  • The instance types that the algorithm * supports for training.

  • Whether the algorithm supports * distributed training.

  • The metrics that the algorithm emits to * Amazon CloudWatch.

  • Which metrics that the algorithm emits can * be used as the objective metric for hyperparameter tuning jobs.

  • *

    The input channels that the algorithm supports for training data. For * example, an algorithm might support train, validation, * and test channels.

*/ inline bool TrainingSpecificationHasBeenSet() const { return m_trainingSpecificationHasBeenSet; } /** *

Specifies details about training jobs run by this algorithm, including the * following:

  • The Amazon ECR path of the container and the version * digest of the algorithm.

  • The hyperparameters that the * algorithm supports.

  • The instance types that the algorithm * supports for training.

  • Whether the algorithm supports * distributed training.

  • The metrics that the algorithm emits to * Amazon CloudWatch.

  • Which metrics that the algorithm emits can * be used as the objective metric for hyperparameter tuning jobs.

  • *

    The input channels that the algorithm supports for training data. For * example, an algorithm might support train, validation, * and test channels.

*/ inline void SetTrainingSpecification(const TrainingSpecification& value) { m_trainingSpecificationHasBeenSet = true; m_trainingSpecification = value; } /** *

Specifies details about training jobs run by this algorithm, including the * following:

  • The Amazon ECR path of the container and the version * digest of the algorithm.

  • The hyperparameters that the * algorithm supports.

  • The instance types that the algorithm * supports for training.

  • Whether the algorithm supports * distributed training.

  • The metrics that the algorithm emits to * Amazon CloudWatch.

  • Which metrics that the algorithm emits can * be used as the objective metric for hyperparameter tuning jobs.

  • *

    The input channels that the algorithm supports for training data. For * example, an algorithm might support train, validation, * and test channels.

*/ inline void SetTrainingSpecification(TrainingSpecification&& value) { m_trainingSpecificationHasBeenSet = true; m_trainingSpecification = std::move(value); } /** *

Specifies details about training jobs run by this algorithm, including the * following:

  • The Amazon ECR path of the container and the version * digest of the algorithm.

  • The hyperparameters that the * algorithm supports.

  • The instance types that the algorithm * supports for training.

  • Whether the algorithm supports * distributed training.

  • The metrics that the algorithm emits to * Amazon CloudWatch.

  • Which metrics that the algorithm emits can * be used as the objective metric for hyperparameter tuning jobs.

  • *

    The input channels that the algorithm supports for training data. For * example, an algorithm might support train, validation, * and test channels.

*/ inline CreateAlgorithmRequest& WithTrainingSpecification(const TrainingSpecification& value) { SetTrainingSpecification(value); return *this;} /** *

Specifies details about training jobs run by this algorithm, including the * following:

  • The Amazon ECR path of the container and the version * digest of the algorithm.

  • The hyperparameters that the * algorithm supports.

  • The instance types that the algorithm * supports for training.

  • Whether the algorithm supports * distributed training.

  • The metrics that the algorithm emits to * Amazon CloudWatch.

  • Which metrics that the algorithm emits can * be used as the objective metric for hyperparameter tuning jobs.

  • *

    The input channels that the algorithm supports for training data. For * example, an algorithm might support train, validation, * and test channels.

*/ inline CreateAlgorithmRequest& WithTrainingSpecification(TrainingSpecification&& value) { SetTrainingSpecification(std::move(value)); return *this;} /** *

Specifies details about inference jobs that the algorithm runs, including the * following:

  • The Amazon ECR paths of containers that contain the * inference code and model artifacts.

  • The instance types that * the algorithm supports for transform jobs and real-time endpoints used for * inference.

  • The input and output content formats that the * algorithm supports for inference.

*/ inline const InferenceSpecification& GetInferenceSpecification() const{ return m_inferenceSpecification; } /** *

Specifies details about inference jobs that the algorithm runs, including the * following:

  • The Amazon ECR paths of containers that contain the * inference code and model artifacts.

  • The instance types that * the algorithm supports for transform jobs and real-time endpoints used for * inference.

  • The input and output content formats that the * algorithm supports for inference.

*/ inline bool InferenceSpecificationHasBeenSet() const { return m_inferenceSpecificationHasBeenSet; } /** *

Specifies details about inference jobs that the algorithm runs, including the * following:

  • The Amazon ECR paths of containers that contain the * inference code and model artifacts.

  • The instance types that * the algorithm supports for transform jobs and real-time endpoints used for * inference.

  • The input and output content formats that the * algorithm supports for inference.

*/ inline void SetInferenceSpecification(const InferenceSpecification& value) { m_inferenceSpecificationHasBeenSet = true; m_inferenceSpecification = value; } /** *

Specifies details about inference jobs that the algorithm runs, including the * following:

  • The Amazon ECR paths of containers that contain the * inference code and model artifacts.

  • The instance types that * the algorithm supports for transform jobs and real-time endpoints used for * inference.

  • The input and output content formats that the * algorithm supports for inference.

*/ inline void SetInferenceSpecification(InferenceSpecification&& value) { m_inferenceSpecificationHasBeenSet = true; m_inferenceSpecification = std::move(value); } /** *

Specifies details about inference jobs that the algorithm runs, including the * following:

  • The Amazon ECR paths of containers that contain the * inference code and model artifacts.

  • The instance types that * the algorithm supports for transform jobs and real-time endpoints used for * inference.

  • The input and output content formats that the * algorithm supports for inference.

*/ inline CreateAlgorithmRequest& WithInferenceSpecification(const InferenceSpecification& value) { SetInferenceSpecification(value); return *this;} /** *

Specifies details about inference jobs that the algorithm runs, including the * following:

  • The Amazon ECR paths of containers that contain the * inference code and model artifacts.

  • The instance types that * the algorithm supports for transform jobs and real-time endpoints used for * inference.

  • The input and output content formats that the * algorithm supports for inference.

*/ inline CreateAlgorithmRequest& WithInferenceSpecification(InferenceSpecification&& value) { SetInferenceSpecification(std::move(value)); return *this;} /** *

Specifies configurations for one or more training jobs and that SageMaker * runs to test the algorithm's training code and, optionally, one or more batch * transform jobs that SageMaker runs to test the algorithm's inference code.

*/ inline const AlgorithmValidationSpecification& GetValidationSpecification() const{ return m_validationSpecification; } /** *

Specifies configurations for one or more training jobs and that SageMaker * runs to test the algorithm's training code and, optionally, one or more batch * transform jobs that SageMaker runs to test the algorithm's inference code.

*/ inline bool ValidationSpecificationHasBeenSet() const { return m_validationSpecificationHasBeenSet; } /** *

Specifies configurations for one or more training jobs and that SageMaker * runs to test the algorithm's training code and, optionally, one or more batch * transform jobs that SageMaker runs to test the algorithm's inference code.

*/ inline void SetValidationSpecification(const AlgorithmValidationSpecification& value) { m_validationSpecificationHasBeenSet = true; m_validationSpecification = value; } /** *

Specifies configurations for one or more training jobs and that SageMaker * runs to test the algorithm's training code and, optionally, one or more batch * transform jobs that SageMaker runs to test the algorithm's inference code.

*/ inline void SetValidationSpecification(AlgorithmValidationSpecification&& value) { m_validationSpecificationHasBeenSet = true; m_validationSpecification = std::move(value); } /** *

Specifies configurations for one or more training jobs and that SageMaker * runs to test the algorithm's training code and, optionally, one or more batch * transform jobs that SageMaker runs to test the algorithm's inference code.

*/ inline CreateAlgorithmRequest& WithValidationSpecification(const AlgorithmValidationSpecification& value) { SetValidationSpecification(value); return *this;} /** *

Specifies configurations for one or more training jobs and that SageMaker * runs to test the algorithm's training code and, optionally, one or more batch * transform jobs that SageMaker runs to test the algorithm's inference code.

*/ inline CreateAlgorithmRequest& WithValidationSpecification(AlgorithmValidationSpecification&& value) { SetValidationSpecification(std::move(value)); return *this;} /** *

Whether to certify the algorithm so that it can be listed in Amazon Web * Services Marketplace.

*/ inline bool GetCertifyForMarketplace() const{ return m_certifyForMarketplace; } /** *

Whether to certify the algorithm so that it can be listed in Amazon Web * Services Marketplace.

*/ inline bool CertifyForMarketplaceHasBeenSet() const { return m_certifyForMarketplaceHasBeenSet; } /** *

Whether to certify the algorithm so that it can be listed in Amazon Web * Services Marketplace.

*/ inline void SetCertifyForMarketplace(bool value) { m_certifyForMarketplaceHasBeenSet = true; m_certifyForMarketplace = value; } /** *

Whether to certify the algorithm so that it can be listed in Amazon Web * Services Marketplace.

*/ inline CreateAlgorithmRequest& WithCertifyForMarketplace(bool value) { SetCertifyForMarketplace(value); return *this;} /** *

An array of key-value pairs. You can use tags to categorize your Amazon Web * Services resources in different ways, for example, by purpose, owner, or * environment. For more information, see Tagging * Amazon Web Services Resources.

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

An array of key-value pairs. You can use tags to categorize your Amazon Web * Services resources in different ways, for example, by purpose, owner, or * environment. For more information, see Tagging * Amazon Web Services Resources.

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

An array of key-value pairs. You can use tags to categorize your Amazon Web * Services resources in different ways, for example, by purpose, owner, or * environment. For more information, see Tagging * Amazon Web Services Resources.

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

An array of key-value pairs. You can use tags to categorize your Amazon Web * Services resources in different ways, for example, by purpose, owner, or * environment. For more information, see Tagging * Amazon Web Services Resources.

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

An array of key-value pairs. You can use tags to categorize your Amazon Web * Services resources in different ways, for example, by purpose, owner, or * environment. For more information, see Tagging * Amazon Web Services Resources.

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

An array of key-value pairs. You can use tags to categorize your Amazon Web * Services resources in different ways, for example, by purpose, owner, or * environment. For more information, see Tagging * Amazon Web Services Resources.

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

An array of key-value pairs. You can use tags to categorize your Amazon Web * Services resources in different ways, for example, by purpose, owner, or * environment. For more information, see Tagging * Amazon Web Services Resources.

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

An array of key-value pairs. You can use tags to categorize your Amazon Web * Services resources in different ways, for example, by purpose, owner, or * environment. For more information, see Tagging * Amazon Web Services Resources.

*/ inline CreateAlgorithmRequest& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; } private: Aws::String m_algorithmName; bool m_algorithmNameHasBeenSet = false; Aws::String m_algorithmDescription; bool m_algorithmDescriptionHasBeenSet = false; TrainingSpecification m_trainingSpecification; bool m_trainingSpecificationHasBeenSet = false; InferenceSpecification m_inferenceSpecification; bool m_inferenceSpecificationHasBeenSet = false; AlgorithmValidationSpecification m_validationSpecification; bool m_validationSpecificationHasBeenSet = false; bool m_certifyForMarketplace; bool m_certifyForMarketplaceHasBeenSet = false; Aws::Vector m_tags; bool m_tagsHasBeenSet = false; }; } // namespace Model } // namespace SageMaker } // namespace Aws