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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card.

Synopsis

Creating a Request

data DescribeModelCard Source #

See: newDescribeModelCard smart constructor.

Constructors

DescribeModelCard'
Fields modelCardVersion :: Maybe Int The version of the model card to describe. If a version is not provided, then the latest version of the model card is described. modelCardName :: Text The name of the model card to describe.

Instances

Instances details

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

newDescribeModelCard Source #

Arguments

:: Text	`DescribeModelCard`
-> DescribeModelCard

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

DescribeModelCard, describeModelCard_modelCardVersion - The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.

DescribeModelCard, describeModelCard_modelCardName - The name of the model card to describe.

Request Lenses

describeModelCard_modelCardVersion :: Lens' DescribeModelCard (Maybe Int) Source #

The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.

describeModelCard_modelCardName :: Lens' DescribeModelCard Text Source #

The name of the model card to describe.

Destructuring the Response

data DescribeModelCardResponse Source #

See: newDescribeModelCardResponse smart constructor.

Constructors

DescribeModelCardResponse'

Fields

lastModifiedBy :: Maybe UserContext
lastModifiedTime :: Maybe POSIX
The date and time the model card was last modified.
modelCardProcessingStatus :: Maybe ModelCardProcessingStatus
The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.
- DeletePending: Model card deletion request received.
- DeleteInProgress: Model card deletion is in progress.
- ContentDeleted: Deleted model card content.
- ExportJobsDeleted: Deleted all export jobs associated with the model card.
- DeleteCompleted: Successfully deleted the model card.
- DeleteFailed: The model card failed to delete.
securityConfig :: Maybe ModelCardSecurityConfig
The security configuration used to protect model card content.
httpStatus :: Int
The response's http status code.
modelCardArn :: Text
The Amazon Resource Name (ARN) of the model card.
modelCardName :: Text
The name of the model card.
modelCardVersion :: Int
The version of the model card.
content :: Sensitive Text
The content of the model card.
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.
creationTime :: POSIX
The date and time the model card was created.
createdBy :: UserContext

Instances

Instances details

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

newDescribeModelCardResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeModelCardResponse'`
-> Text	`DescribeModelCardResponse`
-> Text	`DescribeModelCard`
-> Int	`DescribeModelCard`
-> Text	`DescribeModelCardResponse`
-> ModelCardStatus	`DescribeModelCardResponse`
-> UTCTime	`DescribeModelCardResponse`
-> UserContext	`DescribeModelCardResponse`
-> DescribeModelCardResponse

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

DescribeModelCardResponse, describeModelCardResponse_lastModifiedBy - Undocumented member.

DescribeModelCardResponse, describeModelCardResponse_lastModifiedTime - The date and time the model card was last modified.

$sel:modelCardProcessingStatus:DescribeModelCardResponse', describeModelCardResponse_modelCardProcessingStatus - The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.

DeletePending: Model card deletion request received.
DeleteInProgress: Model card deletion is in progress.
ContentDeleted: Deleted model card content.
ExportJobsDeleted: Deleted all export jobs associated with the model card.
DeleteCompleted: Successfully deleted the model card.
DeleteFailed: The model card failed to delete.

DescribeModelCardResponse, describeModelCardResponse_securityConfig - The security configuration used to protect model card content.

$sel:httpStatus:DescribeModelCardResponse', describeModelCardResponse_httpStatus - The response's http status code.

DescribeModelCardResponse, describeModelCardResponse_modelCardArn - The Amazon Resource Name (ARN) of the model card.

DescribeModelCard, describeModelCardResponse_modelCardName - The name of the model card.

DescribeModelCard, describeModelCardResponse_modelCardVersion - The version of the model card.

DescribeModelCardResponse, describeModelCardResponse_content - The content of the model card.

DescribeModelCardResponse, describeModelCardResponse_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.

DescribeModelCardResponse, describeModelCardResponse_creationTime - The date and time the model card was created.

DescribeModelCardResponse, describeModelCardResponse_createdBy - Undocumented member.

Response Lenses

describeModelCardResponse_lastModifiedBy :: Lens' DescribeModelCardResponse (Maybe UserContext) Source #

Undocumented member.

describeModelCardResponse_lastModifiedTime :: Lens' DescribeModelCardResponse (Maybe UTCTime) Source #

The date and time the model card was last modified.

describeModelCardResponse_modelCardProcessingStatus :: Lens' DescribeModelCardResponse (Maybe ModelCardProcessingStatus) Source #

The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.

DeletePending: Model card deletion request received.
DeleteInProgress: Model card deletion is in progress.
ContentDeleted: Deleted model card content.
ExportJobsDeleted: Deleted all export jobs associated with the model card.
DeleteCompleted: Successfully deleted the model card.
DeleteFailed: The model card failed to delete.

describeModelCardResponse_securityConfig :: Lens' DescribeModelCardResponse (Maybe ModelCardSecurityConfig) Source #

The security configuration used to protect model card content.

describeModelCardResponse_httpStatus :: Lens' DescribeModelCardResponse Int Source #

The response's http status code.

describeModelCardResponse_modelCardArn :: Lens' DescribeModelCardResponse Text Source #

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

describeModelCardResponse_modelCardName :: Lens' DescribeModelCardResponse Text Source #

The name of the model card.

describeModelCardResponse_modelCardVersion :: Lens' DescribeModelCardResponse Int Source #

The version of the model card.

describeModelCardResponse_content :: Lens' DescribeModelCardResponse Text Source #

The content of the model card.

describeModelCardResponse_modelCardStatus :: Lens' DescribeModelCardResponse 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.

describeModelCardResponse_creationTime :: Lens' DescribeModelCardResponse UTCTime Source #

The date and time the model card was created.

describeModelCardResponse_createdBy :: Lens' DescribeModelCardResponse UserContext Source #

Undocumented member.