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.CreateModelCard

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an Amazon SageMaker Model Card.

For information about how to use model cards, see Amazon SageMaker Model Card.

Synopsis

data CreateModelCard = CreateModelCard' {
- securityConfig :: Maybe ModelCardSecurityConfig
- tags :: Maybe [Tag]
- modelCardName :: Text
- content :: Sensitive Text
- modelCardStatus :: ModelCardStatus
}
newCreateModelCard :: Text -> Text -> ModelCardStatus -> CreateModelCard
createModelCard_securityConfig :: Lens' CreateModelCard (Maybe ModelCardSecurityConfig)
createModelCard_tags :: Lens' CreateModelCard (Maybe [Tag])
createModelCard_modelCardName :: Lens' CreateModelCard Text
createModelCard_content :: Lens' CreateModelCard Text
createModelCard_modelCardStatus :: Lens' CreateModelCard ModelCardStatus
data CreateModelCardResponse = CreateModelCardResponse' {
- httpStatus :: Int
- modelCardArn :: Text
}
newCreateModelCardResponse :: Int -> Text -> CreateModelCardResponse
createModelCardResponse_httpStatus :: Lens' CreateModelCardResponse Int
createModelCardResponse_modelCardArn :: Lens' CreateModelCardResponse Text

Creating a Request

data CreateModelCard Source #

See: newCreateModelCard smart constructor.

Constructors

CreateModelCard'

Fields

securityConfig :: Maybe ModelCardSecurityConfig
An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.
tags :: Maybe [Tag]
Key-value pairs used to manage metadata for model cards.
modelCardName :: Text
The unique name of the model card.
content :: Sensitive Text
The content of the model card. Content must be in model card JSON schema and provided as a string.
modelCardStatus :: 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.

Instances

Instances details

ToJSON CreateModelCard Source #
Instance details Defined in Amazonka.SageMaker.CreateModelCard Methods toJSON :: CreateModelCard -> Value # toEncoding :: CreateModelCard -> Encoding # toJSONList :: [CreateModelCard] -> Value # toEncodingList :: [CreateModelCard] -> Encoding #
ToHeaders CreateModelCard Source #
Instance details Defined in Amazonka.SageMaker.CreateModelCard Methods toHeaders :: CreateModelCard -> [Header] #
ToPath CreateModelCard Source #
Instance details Defined in Amazonka.SageMaker.CreateModelCard Methods toPath :: CreateModelCard -> ByteString #
ToQuery CreateModelCard Source #
Instance details Defined in Amazonka.SageMaker.CreateModelCard Methods toQuery :: CreateModelCard -> QueryString #
AWSRequest CreateModelCard Source #
Instance details Defined in Amazonka.SageMaker.CreateModelCard Associated Types type AWSResponse CreateModelCard # Methods request :: (Service -> Service) -> CreateModelCard -> Request CreateModelCard # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateModelCard -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateModelCard))) #
Generic CreateModelCard Source #
Instance details Defined in Amazonka.SageMaker.CreateModelCard Associated Types type Rep CreateModelCard :: Type -> Type # Methods from :: CreateModelCard -> Rep CreateModelCard x # to :: Rep CreateModelCard x -> CreateModelCard #
Show CreateModelCard Source #
Instance details Defined in Amazonka.SageMaker.CreateModelCard Methods showsPrec :: Int -> CreateModelCard -> ShowS # show :: CreateModelCard -> String # showList :: [CreateModelCard] -> ShowS #
NFData CreateModelCard Source #
Instance details Defined in Amazonka.SageMaker.CreateModelCard Methods rnf :: CreateModelCard -> () #
Eq CreateModelCard Source #
Instance details Defined in Amazonka.SageMaker.CreateModelCard Methods (==) :: CreateModelCard -> CreateModelCard -> Bool # (/=) :: CreateModelCard -> CreateModelCard -> Bool #
Hashable CreateModelCard Source #
Instance details Defined in Amazonka.SageMaker.CreateModelCard Methods hashWithSalt :: Int -> CreateModelCard -> Int # hash :: CreateModelCard -> Int #
type AWSResponse CreateModelCard Source #
Instance details Defined in Amazonka.SageMaker.CreateModelCard type AWSResponse CreateModelCard = CreateModelCardResponse
type Rep CreateModelCard Source #
Instance details Defined in Amazonka.SageMaker.CreateModelCard type Rep CreateModelCard = D1 ('MetaData "CreateModelCard" "Amazonka.SageMaker.CreateModelCard" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "CreateModelCard'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "securityConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelCardSecurityConfig)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :: (S1 ('MetaSel ('Just "modelCardName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :: S1 ('MetaSel ('Just "modelCardStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ModelCardStatus)))))

newCreateModelCard Source #

Arguments

:: Text	`CreateModelCard`
-> Text	`CreateModelCard`
-> ModelCardStatus	`CreateModelCard`
-> CreateModelCard

Create a value of CreateModelCard 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:

CreateModelCard, createModelCard_securityConfig - An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.

CreateModelCard, createModelCard_tags - Key-value pairs used to manage metadata for model cards.

CreateModelCard, createModelCard_modelCardName - The unique name of the model card.

CreateModelCard, createModelCard_content - The content of the model card. Content must be in model card JSON schema and provided as a string.

CreateModelCard, createModelCard_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.

Request Lenses

createModelCard_securityConfig :: Lens' CreateModelCard (Maybe ModelCardSecurityConfig) Source #

An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.

createModelCard_tags :: Lens' CreateModelCard (Maybe [Tag]) Source #

Key-value pairs used to manage metadata for model cards.

createModelCard_modelCardName :: Lens' CreateModelCard Text Source #

The unique name of the model card.

createModelCard_content :: Lens' CreateModelCard Text Source #

The content of the model card. Content must be in model card JSON schema and provided as a string.

createModelCard_modelCardStatus :: Lens' CreateModelCard 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.

Destructuring the Response

data CreateModelCardResponse Source #

See: newCreateModelCardResponse smart constructor.

Constructors

CreateModelCardResponse'
Fields httpStatus :: Int The response's http status code. modelCardArn :: Text The Amazon Resource Name (ARN) of the successfully created model card.

Instances

Instances details

Generic CreateModelCardResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateModelCard Associated Types type Rep CreateModelCardResponse :: Type -> Type # Methods from :: CreateModelCardResponse -> Rep CreateModelCardResponse x # to :: Rep CreateModelCardResponse x -> CreateModelCardResponse #
Read CreateModelCardResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateModelCard Methods readsPrec :: Int -> ReadS CreateModelCardResponse # readList :: ReadS [CreateModelCardResponse] # readPrec :: ReadPrec CreateModelCardResponse # readListPrec :: ReadPrec [CreateModelCardResponse] #
Show CreateModelCardResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateModelCard Methods showsPrec :: Int -> CreateModelCardResponse -> ShowS # show :: CreateModelCardResponse -> String # showList :: [CreateModelCardResponse] -> ShowS #
NFData CreateModelCardResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateModelCard Methods rnf :: CreateModelCardResponse -> () #
Eq CreateModelCardResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateModelCard Methods (==) :: CreateModelCardResponse -> CreateModelCardResponse -> Bool # (/=) :: CreateModelCardResponse -> CreateModelCardResponse -> Bool #
type Rep CreateModelCardResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateModelCard type Rep CreateModelCardResponse = D1 ('MetaData "CreateModelCardResponse" "Amazonka.SageMaker.CreateModelCard" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "CreateModelCardResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "modelCardArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateModelCardResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateModelCardResponse'`
-> Text	`CreateModelCardResponse`
-> CreateModelCardResponse

Create a value of CreateModelCardResponse 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:httpStatus:CreateModelCardResponse', createModelCardResponse_httpStatus - The response's http status code.

CreateModelCardResponse, createModelCardResponse_modelCardArn - The Amazon Resource Name (ARN) of the successfully created model card.

Response Lenses

createModelCardResponse_httpStatus :: Lens' CreateModelCardResponse Int Source #

The response's http status code.

createModelCardResponse_modelCardArn :: Lens' CreateModelCardResponse Text Source #

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