/** * 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 Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace SageMaker { namespace Model { /** *

An Amazon SageMaker Model Card.

See Also:

AWS * API Reference

*/ class ModelCard { public: AWS_SAGEMAKER_API ModelCard(); AWS_SAGEMAKER_API ModelCard(Aws::Utils::Json::JsonView jsonValue); AWS_SAGEMAKER_API ModelCard& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_SAGEMAKER_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The Amazon Resource Name (ARN) of the model card.

*/ inline const Aws::String& GetModelCardArn() const{ return m_modelCardArn; } /** *

The Amazon Resource Name (ARN) of the model card.

*/ inline bool ModelCardArnHasBeenSet() const { return m_modelCardArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the model card.

*/ inline void SetModelCardArn(const Aws::String& value) { m_modelCardArnHasBeenSet = true; m_modelCardArn = value; } /** *

The Amazon Resource Name (ARN) of the model card.

*/ inline void SetModelCardArn(Aws::String&& value) { m_modelCardArnHasBeenSet = true; m_modelCardArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of the model card.

*/ inline void SetModelCardArn(const char* value) { m_modelCardArnHasBeenSet = true; m_modelCardArn.assign(value); } /** *

The Amazon Resource Name (ARN) of the model card.

*/ inline ModelCard& WithModelCardArn(const Aws::String& value) { SetModelCardArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the model card.

*/ inline ModelCard& WithModelCardArn(Aws::String&& value) { SetModelCardArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the model card.

*/ inline ModelCard& WithModelCardArn(const char* value) { SetModelCardArn(value); return *this;} /** *

The unique name of the model card.

*/ inline const Aws::String& GetModelCardName() const{ return m_modelCardName; } /** *

The unique name of the model card.

*/ inline bool ModelCardNameHasBeenSet() const { return m_modelCardNameHasBeenSet; } /** *

The unique name of the model card.

*/ inline void SetModelCardName(const Aws::String& value) { m_modelCardNameHasBeenSet = true; m_modelCardName = value; } /** *

The unique name of the model card.

*/ inline void SetModelCardName(Aws::String&& value) { m_modelCardNameHasBeenSet = true; m_modelCardName = std::move(value); } /** *

The unique name of the model card.

*/ inline void SetModelCardName(const char* value) { m_modelCardNameHasBeenSet = true; m_modelCardName.assign(value); } /** *

The unique name of the model card.

*/ inline ModelCard& WithModelCardName(const Aws::String& value) { SetModelCardName(value); return *this;} /** *

The unique name of the model card.

*/ inline ModelCard& WithModelCardName(Aws::String&& value) { SetModelCardName(std::move(value)); return *this;} /** *

The unique name of the model card.

*/ inline ModelCard& WithModelCardName(const char* value) { SetModelCardName(value); return *this;} /** *

The version of the model card.

*/ inline int GetModelCardVersion() const{ return m_modelCardVersion; } /** *

The version of the model card.

*/ inline bool ModelCardVersionHasBeenSet() const { return m_modelCardVersionHasBeenSet; } /** *

The version of the model card.

*/ inline void SetModelCardVersion(int value) { m_modelCardVersionHasBeenSet = true; m_modelCardVersion = value; } /** *

The version of the model card.

*/ inline ModelCard& WithModelCardVersion(int value) { SetModelCardVersion(value); return *this;} /** *

The content of the model card. Content uses the model * card JSON schema and provided as a string.

*/ inline const Aws::String& GetContent() const{ return m_content; } /** *

The content of the model card. Content uses the model * card JSON schema and provided as a string.

*/ inline bool ContentHasBeenSet() const { return m_contentHasBeenSet; } /** *

The content of the model card. Content uses the model * card JSON schema and provided as a string.

*/ inline void SetContent(const Aws::String& value) { m_contentHasBeenSet = true; m_content = value; } /** *

The content of the model card. Content uses the model * card JSON schema and provided as a string.

*/ inline void SetContent(Aws::String&& value) { m_contentHasBeenSet = true; m_content = std::move(value); } /** *

The content of the model card. Content uses the model * card JSON schema and provided as a string.

*/ inline void SetContent(const char* value) { m_contentHasBeenSet = true; m_content.assign(value); } /** *

The content of the model card. Content uses the model * card JSON schema and provided as a string.

*/ inline ModelCard& WithContent(const Aws::String& value) { SetContent(value); return *this;} /** *

The content of the model card. Content uses the model * card JSON schema and provided as a string.

*/ inline ModelCard& WithContent(Aws::String&& value) { SetContent(std::move(value)); return *this;} /** *

The content of the model card. Content uses the model * card JSON schema and provided as a string.

*/ inline ModelCard& WithContent(const char* value) { SetContent(value); return *this;} /** *

The approval status of the model card within your organization. Different * organizations might have different criteria for model card review and * approval.

  • Draft: The model card is a work in * progress.

  • PendingReview: The model card is * pending review.

  • Approved: The model card is * approved.

  • Archived: The model card is archived. * No more updates should be made to the model card, but it can still be * exported.

*/ inline const ModelCardStatus& GetModelCardStatus() const{ return m_modelCardStatus; } /** *

The approval status of the model card within your organization. Different * organizations might have different criteria for model card review and * approval.

  • Draft: The model card is a work in * progress.

  • PendingReview: The model card is * pending review.

  • Approved: The model card is * approved.

  • Archived: The model card is archived. * No more updates should be made to the model card, but it can still be * exported.

*/ inline bool ModelCardStatusHasBeenSet() const { return m_modelCardStatusHasBeenSet; } /** *

The approval status of the model card within your organization. Different * organizations might have different criteria for model card review and * approval.

  • Draft: The model card is a work in * progress.

  • PendingReview: The model card is * pending review.

  • Approved: The model card is * approved.

  • Archived: The model card is archived. * No more updates should be made to the model card, but it can still be * exported.

*/ inline void SetModelCardStatus(const ModelCardStatus& value) { m_modelCardStatusHasBeenSet = true; m_modelCardStatus = value; } /** *

The approval status of the model card within your organization. Different * organizations might have different criteria for model card review and * approval.

  • Draft: The model card is a work in * progress.

  • PendingReview: The model card is * pending review.

  • Approved: The model card is * approved.

  • Archived: The model card is archived. * No more updates should be made to the model card, but it can still be * exported.

*/ inline void SetModelCardStatus(ModelCardStatus&& value) { m_modelCardStatusHasBeenSet = true; m_modelCardStatus = std::move(value); } /** *

The approval status of the model card within your organization. Different * organizations might have different criteria for model card review and * approval.

  • Draft: The model card is a work in * progress.

  • PendingReview: The model card is * pending review.

  • Approved: The model card is * approved.

  • Archived: The model card is archived. * No more updates should be made to the model card, but it can still be * exported.

*/ inline ModelCard& WithModelCardStatus(const ModelCardStatus& value) { SetModelCardStatus(value); return *this;} /** *

The approval status of the model card within your organization. Different * organizations might have different criteria for model card review and * approval.

  • Draft: The model card is a work in * progress.

  • PendingReview: The model card is * pending review.

  • Approved: The model card is * approved.

  • Archived: The model card is archived. * No more updates should be made to the model card, but it can still be * exported.

*/ inline ModelCard& WithModelCardStatus(ModelCardStatus&& value) { SetModelCardStatus(std::move(value)); return *this;} /** *

The security configuration used to protect model card data.

*/ inline const ModelCardSecurityConfig& GetSecurityConfig() const{ return m_securityConfig; } /** *

The security configuration used to protect model card data.

*/ inline bool SecurityConfigHasBeenSet() const { return m_securityConfigHasBeenSet; } /** *

The security configuration used to protect model card data.

*/ inline void SetSecurityConfig(const ModelCardSecurityConfig& value) { m_securityConfigHasBeenSet = true; m_securityConfig = value; } /** *

The security configuration used to protect model card data.

*/ inline void SetSecurityConfig(ModelCardSecurityConfig&& value) { m_securityConfigHasBeenSet = true; m_securityConfig = std::move(value); } /** *

The security configuration used to protect model card data.

*/ inline ModelCard& WithSecurityConfig(const ModelCardSecurityConfig& value) { SetSecurityConfig(value); return *this;} /** *

The security configuration used to protect model card data.

*/ inline ModelCard& WithSecurityConfig(ModelCardSecurityConfig&& value) { SetSecurityConfig(std::move(value)); return *this;} /** *

The date and time that the model card was created.

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

The date and time that the model card was created.

*/ inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; } /** *

The date and time that the model card was created.

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

The date and time that the model card was created.

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

The date and time that the model card was created.

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

The date and time that the model card was created.

*/ inline ModelCard& WithCreationTime(Aws::Utils::DateTime&& value) { SetCreationTime(std::move(value)); return *this;} inline const UserContext& GetCreatedBy() const{ return m_createdBy; } inline bool CreatedByHasBeenSet() const { return m_createdByHasBeenSet; } inline void SetCreatedBy(const UserContext& value) { m_createdByHasBeenSet = true; m_createdBy = value; } inline void SetCreatedBy(UserContext&& value) { m_createdByHasBeenSet = true; m_createdBy = std::move(value); } inline ModelCard& WithCreatedBy(const UserContext& value) { SetCreatedBy(value); return *this;} inline ModelCard& WithCreatedBy(UserContext&& value) { SetCreatedBy(std::move(value)); return *this;} /** *

The date and time that the model card was last modified.

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

The date and time that the model card was last modified.

*/ inline bool LastModifiedTimeHasBeenSet() const { return m_lastModifiedTimeHasBeenSet; } /** *

The date and time that the model card was last modified.

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

The date and time that the model card was last modified.

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

The date and time that the model card was last modified.

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

The date and time that the model card was last modified.

*/ inline ModelCard& WithLastModifiedTime(Aws::Utils::DateTime&& value) { SetLastModifiedTime(std::move(value)); return *this;} inline const UserContext& GetLastModifiedBy() const{ return m_lastModifiedBy; } inline bool LastModifiedByHasBeenSet() const { return m_lastModifiedByHasBeenSet; } inline void SetLastModifiedBy(const UserContext& value) { m_lastModifiedByHasBeenSet = true; m_lastModifiedBy = value; } inline void SetLastModifiedBy(UserContext&& value) { m_lastModifiedByHasBeenSet = true; m_lastModifiedBy = std::move(value); } inline ModelCard& WithLastModifiedBy(const UserContext& value) { SetLastModifiedBy(value); return *this;} inline ModelCard& WithLastModifiedBy(UserContext&& value) { SetLastModifiedBy(std::move(value)); return *this;} /** *

Key-value pairs used to manage metadata for the model card.

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

Key-value pairs used to manage metadata for the model card.

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

Key-value pairs used to manage metadata for the model card.

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

Key-value pairs used to manage metadata for the model card.

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

Key-value pairs used to manage metadata for the model card.

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

Key-value pairs used to manage metadata for the model card.

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

Key-value pairs used to manage metadata for the model card.

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

Key-value pairs used to manage metadata for the model card.

*/ inline ModelCard& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; } /** *

The unique name (ID) of the model.

*/ inline const Aws::String& GetModelId() const{ return m_modelId; } /** *

The unique name (ID) of the model.

*/ inline bool ModelIdHasBeenSet() const { return m_modelIdHasBeenSet; } /** *

The unique name (ID) of the model.

*/ inline void SetModelId(const Aws::String& value) { m_modelIdHasBeenSet = true; m_modelId = value; } /** *

The unique name (ID) of the model.

*/ inline void SetModelId(Aws::String&& value) { m_modelIdHasBeenSet = true; m_modelId = std::move(value); } /** *

The unique name (ID) of the model.

*/ inline void SetModelId(const char* value) { m_modelIdHasBeenSet = true; m_modelId.assign(value); } /** *

The unique name (ID) of the model.

*/ inline ModelCard& WithModelId(const Aws::String& value) { SetModelId(value); return *this;} /** *

The unique name (ID) of the model.

*/ inline ModelCard& WithModelId(Aws::String&& value) { SetModelId(std::move(value)); return *this;} /** *

The unique name (ID) of the model.

*/ inline ModelCard& WithModelId(const char* value) { SetModelId(value); return *this;} /** *

The risk rating of the model. Different organizations might have different * criteria for model card risk ratings. For more information, see Risk * ratings.

*/ inline const Aws::String& GetRiskRating() const{ return m_riskRating; } /** *

The risk rating of the model. Different organizations might have different * criteria for model card risk ratings. For more information, see Risk * ratings.

*/ inline bool RiskRatingHasBeenSet() const { return m_riskRatingHasBeenSet; } /** *

The risk rating of the model. Different organizations might have different * criteria for model card risk ratings. For more information, see Risk * ratings.

*/ inline void SetRiskRating(const Aws::String& value) { m_riskRatingHasBeenSet = true; m_riskRating = value; } /** *

The risk rating of the model. Different organizations might have different * criteria for model card risk ratings. For more information, see Risk * ratings.

*/ inline void SetRiskRating(Aws::String&& value) { m_riskRatingHasBeenSet = true; m_riskRating = std::move(value); } /** *

The risk rating of the model. Different organizations might have different * criteria for model card risk ratings. For more information, see Risk * ratings.

*/ inline void SetRiskRating(const char* value) { m_riskRatingHasBeenSet = true; m_riskRating.assign(value); } /** *

The risk rating of the model. Different organizations might have different * criteria for model card risk ratings. For more information, see Risk * ratings.

*/ inline ModelCard& WithRiskRating(const Aws::String& value) { SetRiskRating(value); return *this;} /** *

The risk rating of the model. Different organizations might have different * criteria for model card risk ratings. For more information, see Risk * ratings.

*/ inline ModelCard& WithRiskRating(Aws::String&& value) { SetRiskRating(std::move(value)); return *this;} /** *

The risk rating of the model. Different organizations might have different * criteria for model card risk ratings. For more information, see Risk * ratings.

*/ inline ModelCard& WithRiskRating(const char* value) { SetRiskRating(value); return *this;} /** *

The model package group that contains the model package. Only relevant for * model cards created for model packages in the Amazon SageMaker Model Registry. *

*/ inline const Aws::String& GetModelPackageGroupName() const{ return m_modelPackageGroupName; } /** *

The model package group that contains the model package. Only relevant for * model cards created for model packages in the Amazon SageMaker Model Registry. *

*/ inline bool ModelPackageGroupNameHasBeenSet() const { return m_modelPackageGroupNameHasBeenSet; } /** *

The model package group that contains the model package. Only relevant for * model cards created for model packages in the Amazon SageMaker Model Registry. *

*/ inline void SetModelPackageGroupName(const Aws::String& value) { m_modelPackageGroupNameHasBeenSet = true; m_modelPackageGroupName = value; } /** *

The model package group that contains the model package. Only relevant for * model cards created for model packages in the Amazon SageMaker Model Registry. *

*/ inline void SetModelPackageGroupName(Aws::String&& value) { m_modelPackageGroupNameHasBeenSet = true; m_modelPackageGroupName = std::move(value); } /** *

The model package group that contains the model package. Only relevant for * model cards created for model packages in the Amazon SageMaker Model Registry. *

*/ inline void SetModelPackageGroupName(const char* value) { m_modelPackageGroupNameHasBeenSet = true; m_modelPackageGroupName.assign(value); } /** *

The model package group that contains the model package. Only relevant for * model cards created for model packages in the Amazon SageMaker Model Registry. *

*/ inline ModelCard& WithModelPackageGroupName(const Aws::String& value) { SetModelPackageGroupName(value); return *this;} /** *

The model package group that contains the model package. Only relevant for * model cards created for model packages in the Amazon SageMaker Model Registry. *

*/ inline ModelCard& WithModelPackageGroupName(Aws::String&& value) { SetModelPackageGroupName(std::move(value)); return *this;} /** *

The model package group that contains the model package. Only relevant for * model cards created for model packages in the Amazon SageMaker Model Registry. *

*/ inline ModelCard& WithModelPackageGroupName(const char* value) { SetModelPackageGroupName(value); return *this;} private: Aws::String m_modelCardArn; bool m_modelCardArnHasBeenSet = false; Aws::String m_modelCardName; bool m_modelCardNameHasBeenSet = false; int m_modelCardVersion; bool m_modelCardVersionHasBeenSet = false; Aws::String m_content; bool m_contentHasBeenSet = false; ModelCardStatus m_modelCardStatus; bool m_modelCardStatusHasBeenSet = false; ModelCardSecurityConfig m_securityConfig; bool m_securityConfigHasBeenSet = false; Aws::Utils::DateTime m_creationTime; bool m_creationTimeHasBeenSet = false; UserContext m_createdBy; bool m_createdByHasBeenSet = false; Aws::Utils::DateTime m_lastModifiedTime; bool m_lastModifiedTimeHasBeenSet = false; UserContext m_lastModifiedBy; bool m_lastModifiedByHasBeenSet = false; Aws::Vector m_tags; bool m_tagsHasBeenSet = false; Aws::String m_modelId; bool m_modelIdHasBeenSet = false; Aws::String m_riskRating; bool m_riskRatingHasBeenSet = false; Aws::String m_modelPackageGroupName; bool m_modelPackageGroupNameHasBeenSet = false; }; } // namespace Model } // namespace SageMaker } // namespace Aws