Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SageMaker.Types.ModelCard

Description

Synopsis

data ModelCard = ModelCard' {
- content :: Maybe (Sensitive Text)
- createdBy :: Maybe UserContext
- creationTime :: Maybe POSIX
- lastModifiedBy :: Maybe UserContext
- lastModifiedTime :: Maybe POSIX
- modelCardArn :: Maybe Text
- modelCardName :: Maybe Text
- modelCardStatus :: Maybe ModelCardStatus
- modelCardVersion :: Maybe Int
- modelId :: Maybe Text
- riskRating :: Maybe Text
- securityConfig :: Maybe ModelCardSecurityConfig
- tags :: Maybe [Tag]
}
newModelCard :: ModelCard
modelCard_content :: Lens' ModelCard (Maybe Text)
modelCard_createdBy :: Lens' ModelCard (Maybe UserContext)
modelCard_creationTime :: Lens' ModelCard (Maybe UTCTime)
modelCard_lastModifiedBy :: Lens' ModelCard (Maybe UserContext)
modelCard_lastModifiedTime :: Lens' ModelCard (Maybe UTCTime)
modelCard_modelCardArn :: Lens' ModelCard (Maybe Text)
modelCard_modelCardName :: Lens' ModelCard (Maybe Text)
modelCard_modelCardStatus :: Lens' ModelCard (Maybe ModelCardStatus)
modelCard_modelCardVersion :: Lens' ModelCard (Maybe Int)
modelCard_modelId :: Lens' ModelCard (Maybe Text)
modelCard_riskRating :: Lens' ModelCard (Maybe Text)
modelCard_securityConfig :: Lens' ModelCard (Maybe ModelCardSecurityConfig)
modelCard_tags :: Lens' ModelCard (Maybe [Tag])

Documentation

data ModelCard Source #

An Amazon SageMaker Model Card.

See: newModelCard smart constructor.

Constructors

ModelCard'

Fields

content :: Maybe (Sensitive Text)
The content of the model card. Content uses the model card JSON schema and provided as a string.
createdBy :: Maybe UserContext
creationTime :: Maybe POSIX
The date and time that the model card was created.
lastModifiedBy :: Maybe UserContext
lastModifiedTime :: Maybe POSIX
The date and time that the model card was last modified.
modelCardArn :: Maybe Text
The Amazon Resource Name (ARN) of the model card.
modelCardName :: Maybe Text
The unique name of the model card.
modelCardStatus :: Maybe 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.
modelCardVersion :: Maybe Int
The version of the model card.
modelId :: Maybe Text
The unique name (ID) of the model.
riskRating :: Maybe Text
The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.
securityConfig :: Maybe ModelCardSecurityConfig
The security configuration used to protect model card data.
tags :: Maybe [Tag]
Key-value pairs used to manage metadata for the model card.

Instances

Instances details

FromJSON ModelCard Source #
Instance details Defined in Amazonka.SageMaker.Types.ModelCard Methods parseJSON :: Value -> Parser ModelCard # parseJSONList :: Value -> Parser [ModelCard] #
Generic ModelCard Source #
Instance details Defined in Amazonka.SageMaker.Types.ModelCard Associated Types type Rep ModelCard :: Type -> Type # Methods from :: ModelCard -> Rep ModelCard x # to :: Rep ModelCard x -> ModelCard #
Show ModelCard Source #
Instance details Defined in Amazonka.SageMaker.Types.ModelCard Methods showsPrec :: Int -> ModelCard -> ShowS # show :: ModelCard -> String # showList :: [ModelCard] -> ShowS #
NFData ModelCard Source #
Instance details Defined in Amazonka.SageMaker.Types.ModelCard Methods rnf :: ModelCard -> () #
Eq ModelCard Source #
Instance details Defined in Amazonka.SageMaker.Types.ModelCard Methods (==) :: ModelCard -> ModelCard -> Bool # (/=) :: ModelCard -> ModelCard -> Bool #
Hashable ModelCard Source #
Instance details Defined in Amazonka.SageMaker.Types.ModelCard Methods hashWithSalt :: Int -> ModelCard -> Int # hash :: ModelCard -> Int #
type Rep ModelCard Source #
Instance details Defined in Amazonka.SageMaker.Types.ModelCard type Rep ModelCard = D1 ('MetaData "ModelCard" "Amazonka.SageMaker.Types.ModelCard" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ModelCard'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "createdBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserContext)) :: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: (S1 ('MetaSel ('Just "lastModifiedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserContext)) :: (S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "modelCardArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "modelCardName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "modelCardStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelCardStatus)) :: S1 ('MetaSel ('Just "modelCardVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "modelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "riskRating") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "securityConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelCardSecurityConfig)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))))))

newModelCard :: ModelCard Source #

Create a value of ModelCard with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:content:ModelCard', modelCard_content - The content of the model card. Content uses the model card JSON schema and provided as a string.

$sel:createdBy:ModelCard', modelCard_createdBy - Undocumented member.

$sel:creationTime:ModelCard', modelCard_creationTime - The date and time that the model card was created.

$sel:lastModifiedBy:ModelCard', modelCard_lastModifiedBy - Undocumented member.

$sel:lastModifiedTime:ModelCard', modelCard_lastModifiedTime - The date and time that the model card was last modified.

$sel:modelCardArn:ModelCard', modelCard_modelCardArn - The Amazon Resource Name (ARN) of the model card.

$sel:modelCardName:ModelCard', modelCard_modelCardName - The unique name of the model card.

$sel:modelCardStatus:ModelCard', modelCard_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.

$sel:modelCardVersion:ModelCard', modelCard_modelCardVersion - The version of the model card.

$sel:modelId:ModelCard', modelCard_modelId - The unique name (ID) of the model.

$sel:riskRating:ModelCard', modelCard_riskRating - The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.

$sel:securityConfig:ModelCard', modelCard_securityConfig - The security configuration used to protect model card data.

$sel:tags:ModelCard', modelCard_tags - Key-value pairs used to manage metadata for the model card.

modelCard_content :: Lens' ModelCard (Maybe Text) Source #

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

modelCard_createdBy :: Lens' ModelCard (Maybe UserContext) Source #

Undocumented member.

modelCard_creationTime :: Lens' ModelCard (Maybe UTCTime) Source #

The date and time that the model card was created.

modelCard_lastModifiedBy :: Lens' ModelCard (Maybe UserContext) Source #

Undocumented member.

modelCard_lastModifiedTime :: Lens' ModelCard (Maybe UTCTime) Source #

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

modelCard_modelCardArn :: Lens' ModelCard (Maybe Text) Source #

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

modelCard_modelCardName :: Lens' ModelCard (Maybe Text) Source #

The unique name of the model card.

modelCard_modelCardStatus :: Lens' ModelCard (Maybe ModelCardStatus) Source #

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.

modelCard_modelCardVersion :: Lens' ModelCard (Maybe Int) Source #

The version of the model card.

modelCard_modelId :: Lens' ModelCard (Maybe Text) Source #

The unique name (ID) of the model.

modelCard_riskRating :: Lens' ModelCard (Maybe Text) Source #

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

modelCard_securityConfig :: Lens' ModelCard (Maybe ModelCardSecurityConfig) Source #

The security configuration used to protect model card data.

modelCard_tags :: Lens' ModelCard (Maybe [Tag]) Source #

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