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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Update an Amazon SageMaker Model Card.

You cannot update both model card content and model card status in a single call.

Creating a Request

data UpdateModelCard Source #

See: newUpdateModelCard smart constructor.

Constructors

UpdateModelCard'

Fields

content :: Maybe (Sensitive Text)
The updated model card content. Content must be in model card JSON schema and provided as a string.
When updating model card content, be sure to include the full content and not just updated content.
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.
modelCardName :: Text
The name of the model card to update.

Instances

Instances details

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

newUpdateModelCard Source #

Arguments

:: Text	`UpdateModelCard`
-> UpdateModelCard

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

UpdateModelCard, updateModelCard_content - The updated model card content. Content must be in model card JSON schema and provided as a string.

When updating model card content, be sure to include the full content and not just updated content.

UpdateModelCard, updateModelCard_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.

UpdateModelCard, updateModelCard_modelCardName - The name of the model card to update.

Request Lenses

updateModelCard_content :: Lens' UpdateModelCard (Maybe Text) Source #

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

When updating model card content, be sure to include the full content and not just updated content.

updateModelCard_modelCardStatus :: Lens' UpdateModelCard (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.

updateModelCard_modelCardName :: Lens' UpdateModelCard Text Source #

The name of the model card to update.

Destructuring the Response

data UpdateModelCardResponse Source #

See: newUpdateModelCardResponse smart constructor.

Constructors

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

Instances

Instances details

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

newUpdateModelCardResponse Source #

Arguments

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

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

UpdateModelCardResponse, updateModelCardResponse_modelCardArn - The Amazon Resource Name (ARN) of the updated model card.

Response Lenses

updateModelCardResponse_httpStatus :: Lens' UpdateModelCardResponse Int Source #

The response's http status code.

updateModelCardResponse_modelCardArn :: Lens' UpdateModelCardResponse Text Source #

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