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

The name of the image.

*/ inline const Aws::String& GetImageName() const{ return m_imageName; } /** *

The name of the image.

*/ inline bool ImageNameHasBeenSet() const { return m_imageNameHasBeenSet; } /** *

The name of the image.

*/ inline void SetImageName(const Aws::String& value) { m_imageNameHasBeenSet = true; m_imageName = value; } /** *

The name of the image.

*/ inline void SetImageName(Aws::String&& value) { m_imageNameHasBeenSet = true; m_imageName = std::move(value); } /** *

The name of the image.

*/ inline void SetImageName(const char* value) { m_imageNameHasBeenSet = true; m_imageName.assign(value); } /** *

The name of the image.

*/ inline UpdateImageVersionRequest& WithImageName(const Aws::String& value) { SetImageName(value); return *this;} /** *

The name of the image.

*/ inline UpdateImageVersionRequest& WithImageName(Aws::String&& value) { SetImageName(std::move(value)); return *this;} /** *

The name of the image.

*/ inline UpdateImageVersionRequest& WithImageName(const char* value) { SetImageName(value); return *this;} /** *

The alias of the image version.

*/ inline const Aws::String& GetAlias() const{ return m_alias; } /** *

The alias of the image version.

*/ inline bool AliasHasBeenSet() const { return m_aliasHasBeenSet; } /** *

The alias of the image version.

*/ inline void SetAlias(const Aws::String& value) { m_aliasHasBeenSet = true; m_alias = value; } /** *

The alias of the image version.

*/ inline void SetAlias(Aws::String&& value) { m_aliasHasBeenSet = true; m_alias = std::move(value); } /** *

The alias of the image version.

*/ inline void SetAlias(const char* value) { m_aliasHasBeenSet = true; m_alias.assign(value); } /** *

The alias of the image version.

*/ inline UpdateImageVersionRequest& WithAlias(const Aws::String& value) { SetAlias(value); return *this;} /** *

The alias of the image version.

*/ inline UpdateImageVersionRequest& WithAlias(Aws::String&& value) { SetAlias(std::move(value)); return *this;} /** *

The alias of the image version.

*/ inline UpdateImageVersionRequest& WithAlias(const char* value) { SetAlias(value); return *this;} /** *

The version of the image.

*/ inline int GetVersion() const{ return m_version; } /** *

The version of the image.

*/ inline bool VersionHasBeenSet() const { return m_versionHasBeenSet; } /** *

The version of the image.

*/ inline void SetVersion(int value) { m_versionHasBeenSet = true; m_version = value; } /** *

The version of the image.

*/ inline UpdateImageVersionRequest& WithVersion(int value) { SetVersion(value); return *this;} /** *

A list of aliases to add.

*/ inline const Aws::Vector& GetAliasesToAdd() const{ return m_aliasesToAdd; } /** *

A list of aliases to add.

*/ inline bool AliasesToAddHasBeenSet() const { return m_aliasesToAddHasBeenSet; } /** *

A list of aliases to add.

*/ inline void SetAliasesToAdd(const Aws::Vector& value) { m_aliasesToAddHasBeenSet = true; m_aliasesToAdd = value; } /** *

A list of aliases to add.

*/ inline void SetAliasesToAdd(Aws::Vector&& value) { m_aliasesToAddHasBeenSet = true; m_aliasesToAdd = std::move(value); } /** *

A list of aliases to add.

*/ inline UpdateImageVersionRequest& WithAliasesToAdd(const Aws::Vector& value) { SetAliasesToAdd(value); return *this;} /** *

A list of aliases to add.

*/ inline UpdateImageVersionRequest& WithAliasesToAdd(Aws::Vector&& value) { SetAliasesToAdd(std::move(value)); return *this;} /** *

A list of aliases to add.

*/ inline UpdateImageVersionRequest& AddAliasesToAdd(const Aws::String& value) { m_aliasesToAddHasBeenSet = true; m_aliasesToAdd.push_back(value); return *this; } /** *

A list of aliases to add.

*/ inline UpdateImageVersionRequest& AddAliasesToAdd(Aws::String&& value) { m_aliasesToAddHasBeenSet = true; m_aliasesToAdd.push_back(std::move(value)); return *this; } /** *

A list of aliases to add.

*/ inline UpdateImageVersionRequest& AddAliasesToAdd(const char* value) { m_aliasesToAddHasBeenSet = true; m_aliasesToAdd.push_back(value); return *this; } /** *

A list of aliases to delete.

*/ inline const Aws::Vector& GetAliasesToDelete() const{ return m_aliasesToDelete; } /** *

A list of aliases to delete.

*/ inline bool AliasesToDeleteHasBeenSet() const { return m_aliasesToDeleteHasBeenSet; } /** *

A list of aliases to delete.

*/ inline void SetAliasesToDelete(const Aws::Vector& value) { m_aliasesToDeleteHasBeenSet = true; m_aliasesToDelete = value; } /** *

A list of aliases to delete.

*/ inline void SetAliasesToDelete(Aws::Vector&& value) { m_aliasesToDeleteHasBeenSet = true; m_aliasesToDelete = std::move(value); } /** *

A list of aliases to delete.

*/ inline UpdateImageVersionRequest& WithAliasesToDelete(const Aws::Vector& value) { SetAliasesToDelete(value); return *this;} /** *

A list of aliases to delete.

*/ inline UpdateImageVersionRequest& WithAliasesToDelete(Aws::Vector&& value) { SetAliasesToDelete(std::move(value)); return *this;} /** *

A list of aliases to delete.

*/ inline UpdateImageVersionRequest& AddAliasesToDelete(const Aws::String& value) { m_aliasesToDeleteHasBeenSet = true; m_aliasesToDelete.push_back(value); return *this; } /** *

A list of aliases to delete.

*/ inline UpdateImageVersionRequest& AddAliasesToDelete(Aws::String&& value) { m_aliasesToDeleteHasBeenSet = true; m_aliasesToDelete.push_back(std::move(value)); return *this; } /** *

A list of aliases to delete.

*/ inline UpdateImageVersionRequest& AddAliasesToDelete(const char* value) { m_aliasesToDeleteHasBeenSet = true; m_aliasesToDelete.push_back(value); return *this; } /** *

The availability of the image version specified by the maintainer.

    *
  • NOT_PROVIDED: The maintainers did not provide a status for * image version stability.

  • STABLE: The image * version is stable.

  • TO_BE_ARCHIVED: The image * version is set to be archived. Custom image versions that are set to be archived * are automatically archived after three months.

  • * ARCHIVED: The image version is archived. Archived image versions * are not searchable and are no longer actively supported.

*/ inline const VendorGuidance& GetVendorGuidance() const{ return m_vendorGuidance; } /** *

The availability of the image version specified by the maintainer.

    *
  • NOT_PROVIDED: The maintainers did not provide a status for * image version stability.

  • STABLE: The image * version is stable.

  • TO_BE_ARCHIVED: The image * version is set to be archived. Custom image versions that are set to be archived * are automatically archived after three months.

  • * ARCHIVED: The image version is archived. Archived image versions * are not searchable and are no longer actively supported.

*/ inline bool VendorGuidanceHasBeenSet() const { return m_vendorGuidanceHasBeenSet; } /** *

The availability of the image version specified by the maintainer.

    *
  • NOT_PROVIDED: The maintainers did not provide a status for * image version stability.

  • STABLE: The image * version is stable.

  • TO_BE_ARCHIVED: The image * version is set to be archived. Custom image versions that are set to be archived * are automatically archived after three months.

  • * ARCHIVED: The image version is archived. Archived image versions * are not searchable and are no longer actively supported.

*/ inline void SetVendorGuidance(const VendorGuidance& value) { m_vendorGuidanceHasBeenSet = true; m_vendorGuidance = value; } /** *

The availability of the image version specified by the maintainer.

    *
  • NOT_PROVIDED: The maintainers did not provide a status for * image version stability.

  • STABLE: The image * version is stable.

  • TO_BE_ARCHIVED: The image * version is set to be archived. Custom image versions that are set to be archived * are automatically archived after three months.

  • * ARCHIVED: The image version is archived. Archived image versions * are not searchable and are no longer actively supported.

*/ inline void SetVendorGuidance(VendorGuidance&& value) { m_vendorGuidanceHasBeenSet = true; m_vendorGuidance = std::move(value); } /** *

The availability of the image version specified by the maintainer.

    *
  • NOT_PROVIDED: The maintainers did not provide a status for * image version stability.

  • STABLE: The image * version is stable.

  • TO_BE_ARCHIVED: The image * version is set to be archived. Custom image versions that are set to be archived * are automatically archived after three months.

  • * ARCHIVED: The image version is archived. Archived image versions * are not searchable and are no longer actively supported.

*/ inline UpdateImageVersionRequest& WithVendorGuidance(const VendorGuidance& value) { SetVendorGuidance(value); return *this;} /** *

The availability of the image version specified by the maintainer.

    *
  • NOT_PROVIDED: The maintainers did not provide a status for * image version stability.

  • STABLE: The image * version is stable.

  • TO_BE_ARCHIVED: The image * version is set to be archived. Custom image versions that are set to be archived * are automatically archived after three months.

  • * ARCHIVED: The image version is archived. Archived image versions * are not searchable and are no longer actively supported.

*/ inline UpdateImageVersionRequest& WithVendorGuidance(VendorGuidance&& value) { SetVendorGuidance(std::move(value)); return *this;} /** *

Indicates SageMaker job type compatibility.

  • * TRAINING: The image version is compatible with SageMaker training * jobs.

  • INFERENCE: The image version is compatible * with SageMaker inference jobs.

  • NOTEBOOK_KERNEL: * The image version is compatible with SageMaker notebook kernels.

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

Indicates SageMaker job type compatibility.

  • * TRAINING: The image version is compatible with SageMaker training * jobs.

  • INFERENCE: The image version is compatible * with SageMaker inference jobs.

  • NOTEBOOK_KERNEL: * The image version is compatible with SageMaker notebook kernels.

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

Indicates SageMaker job type compatibility.

  • * TRAINING: The image version is compatible with SageMaker training * jobs.

  • INFERENCE: The image version is compatible * with SageMaker inference jobs.

  • NOTEBOOK_KERNEL: * The image version is compatible with SageMaker notebook kernels.

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

Indicates SageMaker job type compatibility.

  • * TRAINING: The image version is compatible with SageMaker training * jobs.

  • INFERENCE: The image version is compatible * with SageMaker inference jobs.

  • NOTEBOOK_KERNEL: * The image version is compatible with SageMaker notebook kernels.

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

Indicates SageMaker job type compatibility.

  • * TRAINING: The image version is compatible with SageMaker training * jobs.

  • INFERENCE: The image version is compatible * with SageMaker inference jobs.

  • NOTEBOOK_KERNEL: * The image version is compatible with SageMaker notebook kernels.

*/ inline UpdateImageVersionRequest& WithJobType(const JobType& value) { SetJobType(value); return *this;} /** *

Indicates SageMaker job type compatibility.

  • * TRAINING: The image version is compatible with SageMaker training * jobs.

  • INFERENCE: The image version is compatible * with SageMaker inference jobs.

  • NOTEBOOK_KERNEL: * The image version is compatible with SageMaker notebook kernels.

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

The machine learning framework vended in the image version.

*/ inline const Aws::String& GetMLFramework() const{ return m_mLFramework; } /** *

The machine learning framework vended in the image version.

*/ inline bool MLFrameworkHasBeenSet() const { return m_mLFrameworkHasBeenSet; } /** *

The machine learning framework vended in the image version.

*/ inline void SetMLFramework(const Aws::String& value) { m_mLFrameworkHasBeenSet = true; m_mLFramework = value; } /** *

The machine learning framework vended in the image version.

*/ inline void SetMLFramework(Aws::String&& value) { m_mLFrameworkHasBeenSet = true; m_mLFramework = std::move(value); } /** *

The machine learning framework vended in the image version.

*/ inline void SetMLFramework(const char* value) { m_mLFrameworkHasBeenSet = true; m_mLFramework.assign(value); } /** *

The machine learning framework vended in the image version.

*/ inline UpdateImageVersionRequest& WithMLFramework(const Aws::String& value) { SetMLFramework(value); return *this;} /** *

The machine learning framework vended in the image version.

*/ inline UpdateImageVersionRequest& WithMLFramework(Aws::String&& value) { SetMLFramework(std::move(value)); return *this;} /** *

The machine learning framework vended in the image version.

*/ inline UpdateImageVersionRequest& WithMLFramework(const char* value) { SetMLFramework(value); return *this;} /** *

The supported programming language and its version.

*/ inline const Aws::String& GetProgrammingLang() const{ return m_programmingLang; } /** *

The supported programming language and its version.

*/ inline bool ProgrammingLangHasBeenSet() const { return m_programmingLangHasBeenSet; } /** *

The supported programming language and its version.

*/ inline void SetProgrammingLang(const Aws::String& value) { m_programmingLangHasBeenSet = true; m_programmingLang = value; } /** *

The supported programming language and its version.

*/ inline void SetProgrammingLang(Aws::String&& value) { m_programmingLangHasBeenSet = true; m_programmingLang = std::move(value); } /** *

The supported programming language and its version.

*/ inline void SetProgrammingLang(const char* value) { m_programmingLangHasBeenSet = true; m_programmingLang.assign(value); } /** *

The supported programming language and its version.

*/ inline UpdateImageVersionRequest& WithProgrammingLang(const Aws::String& value) { SetProgrammingLang(value); return *this;} /** *

The supported programming language and its version.

*/ inline UpdateImageVersionRequest& WithProgrammingLang(Aws::String&& value) { SetProgrammingLang(std::move(value)); return *this;} /** *

The supported programming language and its version.

*/ inline UpdateImageVersionRequest& WithProgrammingLang(const char* value) { SetProgrammingLang(value); return *this;} /** *

Indicates CPU or GPU compatibility.

  • CPU: The * image version is compatible with CPU.

  • GPU: The * image version is compatible with GPU.

*/ inline const Processor& GetProcessor() const{ return m_processor; } /** *

Indicates CPU or GPU compatibility.

  • CPU: The * image version is compatible with CPU.

  • GPU: The * image version is compatible with GPU.

*/ inline bool ProcessorHasBeenSet() const { return m_processorHasBeenSet; } /** *

Indicates CPU or GPU compatibility.

  • CPU: The * image version is compatible with CPU.

  • GPU: The * image version is compatible with GPU.

*/ inline void SetProcessor(const Processor& value) { m_processorHasBeenSet = true; m_processor = value; } /** *

Indicates CPU or GPU compatibility.

  • CPU: The * image version is compatible with CPU.

  • GPU: The * image version is compatible with GPU.

*/ inline void SetProcessor(Processor&& value) { m_processorHasBeenSet = true; m_processor = std::move(value); } /** *

Indicates CPU or GPU compatibility.

  • CPU: The * image version is compatible with CPU.

  • GPU: The * image version is compatible with GPU.

*/ inline UpdateImageVersionRequest& WithProcessor(const Processor& value) { SetProcessor(value); return *this;} /** *

Indicates CPU or GPU compatibility.

  • CPU: The * image version is compatible with CPU.

  • GPU: The * image version is compatible with GPU.

*/ inline UpdateImageVersionRequest& WithProcessor(Processor&& value) { SetProcessor(std::move(value)); return *this;} /** *

Indicates Horovod compatibility.

*/ inline bool GetHorovod() const{ return m_horovod; } /** *

Indicates Horovod compatibility.

*/ inline bool HorovodHasBeenSet() const { return m_horovodHasBeenSet; } /** *

Indicates Horovod compatibility.

*/ inline void SetHorovod(bool value) { m_horovodHasBeenSet = true; m_horovod = value; } /** *

Indicates Horovod compatibility.

*/ inline UpdateImageVersionRequest& WithHorovod(bool value) { SetHorovod(value); return *this;} /** *

The maintainer description of the image version.

*/ inline const Aws::String& GetReleaseNotes() const{ return m_releaseNotes; } /** *

The maintainer description of the image version.

*/ inline bool ReleaseNotesHasBeenSet() const { return m_releaseNotesHasBeenSet; } /** *

The maintainer description of the image version.

*/ inline void SetReleaseNotes(const Aws::String& value) { m_releaseNotesHasBeenSet = true; m_releaseNotes = value; } /** *

The maintainer description of the image version.

*/ inline void SetReleaseNotes(Aws::String&& value) { m_releaseNotesHasBeenSet = true; m_releaseNotes = std::move(value); } /** *

The maintainer description of the image version.

*/ inline void SetReleaseNotes(const char* value) { m_releaseNotesHasBeenSet = true; m_releaseNotes.assign(value); } /** *

The maintainer description of the image version.

*/ inline UpdateImageVersionRequest& WithReleaseNotes(const Aws::String& value) { SetReleaseNotes(value); return *this;} /** *

The maintainer description of the image version.

*/ inline UpdateImageVersionRequest& WithReleaseNotes(Aws::String&& value) { SetReleaseNotes(std::move(value)); return *this;} /** *

The maintainer description of the image version.

*/ inline UpdateImageVersionRequest& WithReleaseNotes(const char* value) { SetReleaseNotes(value); return *this;} private: Aws::String m_imageName; bool m_imageNameHasBeenSet = false; Aws::String m_alias; bool m_aliasHasBeenSet = false; int m_version; bool m_versionHasBeenSet = false; Aws::Vector m_aliasesToAdd; bool m_aliasesToAddHasBeenSet = false; Aws::Vector m_aliasesToDelete; bool m_aliasesToDeleteHasBeenSet = false; VendorGuidance m_vendorGuidance; bool m_vendorGuidanceHasBeenSet = false; JobType m_jobType; bool m_jobTypeHasBeenSet = false; Aws::String m_mLFramework; bool m_mLFrameworkHasBeenSet = false; Aws::String m_programmingLang; bool m_programmingLangHasBeenSet = false; Processor m_processor; bool m_processorHasBeenSet = false; bool m_horovod; bool m_horovodHasBeenSet = false; Aws::String m_releaseNotes; bool m_releaseNotesHasBeenSet = false; }; } // namespace Model } // namespace SageMaker } // namespace Aws