/** * 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 { template class AmazonWebServiceResult; namespace Utils { namespace Json { class JsonValue; } // namespace Json } // namespace Utils namespace SageMaker { namespace Model { class DescribeImageVersionResult { public: AWS_SAGEMAKER_API DescribeImageVersionResult(); AWS_SAGEMAKER_API DescribeImageVersionResult(const Aws::AmazonWebServiceResult& result); AWS_SAGEMAKER_API DescribeImageVersionResult& operator=(const Aws::AmazonWebServiceResult& result); /** *

The registry path of the container image on which this image version is * based.

*/ inline const Aws::String& GetBaseImage() const{ return m_baseImage; } /** *

The registry path of the container image on which this image version is * based.

*/ inline void SetBaseImage(const Aws::String& value) { m_baseImage = value; } /** *

The registry path of the container image on which this image version is * based.

*/ inline void SetBaseImage(Aws::String&& value) { m_baseImage = std::move(value); } /** *

The registry path of the container image on which this image version is * based.

*/ inline void SetBaseImage(const char* value) { m_baseImage.assign(value); } /** *

The registry path of the container image on which this image version is * based.

*/ inline DescribeImageVersionResult& WithBaseImage(const Aws::String& value) { SetBaseImage(value); return *this;} /** *

The registry path of the container image on which this image version is * based.

*/ inline DescribeImageVersionResult& WithBaseImage(Aws::String&& value) { SetBaseImage(std::move(value)); return *this;} /** *

The registry path of the container image on which this image version is * based.

*/ inline DescribeImageVersionResult& WithBaseImage(const char* value) { SetBaseImage(value); return *this;} /** *

The registry path of the container image that contains this image * version.

*/ inline const Aws::String& GetContainerImage() const{ return m_containerImage; } /** *

The registry path of the container image that contains this image * version.

*/ inline void SetContainerImage(const Aws::String& value) { m_containerImage = value; } /** *

The registry path of the container image that contains this image * version.

*/ inline void SetContainerImage(Aws::String&& value) { m_containerImage = std::move(value); } /** *

The registry path of the container image that contains this image * version.

*/ inline void SetContainerImage(const char* value) { m_containerImage.assign(value); } /** *

The registry path of the container image that contains this image * version.

*/ inline DescribeImageVersionResult& WithContainerImage(const Aws::String& value) { SetContainerImage(value); return *this;} /** *

The registry path of the container image that contains this image * version.

*/ inline DescribeImageVersionResult& WithContainerImage(Aws::String&& value) { SetContainerImage(std::move(value)); return *this;} /** *

The registry path of the container image that contains this image * version.

*/ inline DescribeImageVersionResult& WithContainerImage(const char* value) { SetContainerImage(value); return *this;} /** *

When the version was created.

*/ inline const Aws::Utils::DateTime& GetCreationTime() const{ return m_creationTime; } /** *

When the version was created.

*/ inline void SetCreationTime(const Aws::Utils::DateTime& value) { m_creationTime = value; } /** *

When the version was created.

*/ inline void SetCreationTime(Aws::Utils::DateTime&& value) { m_creationTime = std::move(value); } /** *

When the version was created.

*/ inline DescribeImageVersionResult& WithCreationTime(const Aws::Utils::DateTime& value) { SetCreationTime(value); return *this;} /** *

When the version was created.

*/ inline DescribeImageVersionResult& WithCreationTime(Aws::Utils::DateTime&& value) { SetCreationTime(std::move(value)); return *this;} /** *

When a create or delete operation fails, the reason for the failure.

*/ inline const Aws::String& GetFailureReason() const{ return m_failureReason; } /** *

When a create or delete operation fails, the reason for the failure.

*/ inline void SetFailureReason(const Aws::String& value) { m_failureReason = value; } /** *

When a create or delete operation fails, the reason for the failure.

*/ inline void SetFailureReason(Aws::String&& value) { m_failureReason = std::move(value); } /** *

When a create or delete operation fails, the reason for the failure.

*/ inline void SetFailureReason(const char* value) { m_failureReason.assign(value); } /** *

When a create or delete operation fails, the reason for the failure.

*/ inline DescribeImageVersionResult& WithFailureReason(const Aws::String& value) { SetFailureReason(value); return *this;} /** *

When a create or delete operation fails, the reason for the failure.

*/ inline DescribeImageVersionResult& WithFailureReason(Aws::String&& value) { SetFailureReason(std::move(value)); return *this;} /** *

When a create or delete operation fails, the reason for the failure.

*/ inline DescribeImageVersionResult& WithFailureReason(const char* value) { SetFailureReason(value); return *this;} /** *

The ARN of the image the version is based on.

*/ inline const Aws::String& GetImageArn() const{ return m_imageArn; } /** *

The ARN of the image the version is based on.

*/ inline void SetImageArn(const Aws::String& value) { m_imageArn = value; } /** *

The ARN of the image the version is based on.

*/ inline void SetImageArn(Aws::String&& value) { m_imageArn = std::move(value); } /** *

The ARN of the image the version is based on.

*/ inline void SetImageArn(const char* value) { m_imageArn.assign(value); } /** *

The ARN of the image the version is based on.

*/ inline DescribeImageVersionResult& WithImageArn(const Aws::String& value) { SetImageArn(value); return *this;} /** *

The ARN of the image the version is based on.

*/ inline DescribeImageVersionResult& WithImageArn(Aws::String&& value) { SetImageArn(std::move(value)); return *this;} /** *

The ARN of the image the version is based on.

*/ inline DescribeImageVersionResult& WithImageArn(const char* value) { SetImageArn(value); return *this;} /** *

The ARN of the version.

*/ inline const Aws::String& GetImageVersionArn() const{ return m_imageVersionArn; } /** *

The ARN of the version.

*/ inline void SetImageVersionArn(const Aws::String& value) { m_imageVersionArn = value; } /** *

The ARN of the version.

*/ inline void SetImageVersionArn(Aws::String&& value) { m_imageVersionArn = std::move(value); } /** *

The ARN of the version.

*/ inline void SetImageVersionArn(const char* value) { m_imageVersionArn.assign(value); } /** *

The ARN of the version.

*/ inline DescribeImageVersionResult& WithImageVersionArn(const Aws::String& value) { SetImageVersionArn(value); return *this;} /** *

The ARN of the version.

*/ inline DescribeImageVersionResult& WithImageVersionArn(Aws::String&& value) { SetImageVersionArn(std::move(value)); return *this;} /** *

The ARN of the version.

*/ inline DescribeImageVersionResult& WithImageVersionArn(const char* value) { SetImageVersionArn(value); return *this;} /** *

The status of the version.

*/ inline const ImageVersionStatus& GetImageVersionStatus() const{ return m_imageVersionStatus; } /** *

The status of the version.

*/ inline void SetImageVersionStatus(const ImageVersionStatus& value) { m_imageVersionStatus = value; } /** *

The status of the version.

*/ inline void SetImageVersionStatus(ImageVersionStatus&& value) { m_imageVersionStatus = std::move(value); } /** *

The status of the version.

*/ inline DescribeImageVersionResult& WithImageVersionStatus(const ImageVersionStatus& value) { SetImageVersionStatus(value); return *this;} /** *

The status of the version.

*/ inline DescribeImageVersionResult& WithImageVersionStatus(ImageVersionStatus&& value) { SetImageVersionStatus(std::move(value)); return *this;} /** *

When the version was last modified.

*/ inline const Aws::Utils::DateTime& GetLastModifiedTime() const{ return m_lastModifiedTime; } /** *

When the version was last modified.

*/ inline void SetLastModifiedTime(const Aws::Utils::DateTime& value) { m_lastModifiedTime = value; } /** *

When the version was last modified.

*/ inline void SetLastModifiedTime(Aws::Utils::DateTime&& value) { m_lastModifiedTime = std::move(value); } /** *

When the version was last modified.

*/ inline DescribeImageVersionResult& WithLastModifiedTime(const Aws::Utils::DateTime& value) { SetLastModifiedTime(value); return *this;} /** *

When the version was last modified.

*/ inline DescribeImageVersionResult& WithLastModifiedTime(Aws::Utils::DateTime&& value) { SetLastModifiedTime(std::move(value)); return *this;} /** *

The version number.

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

The version number.

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

The version number.

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

The stability 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 stability 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_vendorGuidance = value; } /** *

The stability 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_vendorGuidance = std::move(value); } /** *

The stability 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 DescribeImageVersionResult& WithVendorGuidance(const VendorGuidance& value) { SetVendorGuidance(value); return *this;} /** *

The stability 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 DescribeImageVersionResult& 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 void SetJobType(const JobType& value) { 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_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 DescribeImageVersionResult& 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 DescribeImageVersionResult& 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 void SetMLFramework(const Aws::String& value) { m_mLFramework = value; } /** *

The machine learning framework vended in the image version.

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

The machine learning framework vended in the image version.

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

The machine learning framework vended in the image version.

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

The machine learning framework vended in the image version.

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

The machine learning framework vended in the image version.

*/ inline DescribeImageVersionResult& 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 void SetProgrammingLang(const Aws::String& value) { m_programmingLang = value; } /** *

The supported programming language and its version.

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

The supported programming language and its version.

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

The supported programming language and its version.

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

The supported programming language and its version.

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

The supported programming language and its version.

*/ inline DescribeImageVersionResult& 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 void SetProcessor(const Processor& value) { 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_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 DescribeImageVersionResult& 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 DescribeImageVersionResult& WithProcessor(Processor&& value) { SetProcessor(std::move(value)); return *this;} /** *

Indicates Horovod compatibility.

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

Indicates Horovod compatibility.

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

Indicates Horovod compatibility.

*/ inline DescribeImageVersionResult& 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 void SetReleaseNotes(const Aws::String& value) { m_releaseNotes = value; } /** *

The maintainer description of the image version.

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

The maintainer description of the image version.

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

The maintainer description of the image version.

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

The maintainer description of the image version.

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

The maintainer description of the image version.

*/ inline DescribeImageVersionResult& WithReleaseNotes(const char* value) { SetReleaseNotes(value); return *this;} inline const Aws::String& GetRequestId() const{ return m_requestId; } inline void SetRequestId(const Aws::String& value) { m_requestId = value; } inline void SetRequestId(Aws::String&& value) { m_requestId = std::move(value); } inline void SetRequestId(const char* value) { m_requestId.assign(value); } inline DescribeImageVersionResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} inline DescribeImageVersionResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} inline DescribeImageVersionResult& WithRequestId(const char* value) { SetRequestId(value); return *this;} private: Aws::String m_baseImage; Aws::String m_containerImage; Aws::Utils::DateTime m_creationTime; Aws::String m_failureReason; Aws::String m_imageArn; Aws::String m_imageVersionArn; ImageVersionStatus m_imageVersionStatus; Aws::Utils::DateTime m_lastModifiedTime; int m_version; VendorGuidance m_vendorGuidance; JobType m_jobType; Aws::String m_mLFramework; Aws::String m_programmingLang; Processor m_processor; bool m_horovod; Aws::String m_releaseNotes; Aws::String m_requestId; }; } // namespace Model } // namespace SageMaker } // namespace Aws