Creates an Amazon SageMaker Model Card.
For information about how to use model cards, see Amazon SageMaker Model Card.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Type" : "AWS::SageMaker::ModelCard",
"Properties" : {
"Content" : Content,
"CreatedBy" : UserContext,
"LastModifiedBy" : UserContext,
"ModelCardName" : String,
"ModelCardStatus" : String,
"SecurityConfig" : SecurityConfig,
"Tags" : [ Tag, ... ]
}
}
YAML
Type: AWS::SageMaker::ModelCard
Properties:
Content:
Content
CreatedBy:
UserContext
LastModifiedBy:
UserContext
ModelCardName: String
ModelCardStatus: String
SecurityConfig:
SecurityConfig
Tags:
- Tag
Properties
Content-
The content of the model card. Content uses the model card JSON schema.
Required: Yes
Type: Content
Update requires: No interruption
CreatedBy-
Information about the user who created or modified one or more of the following:
-
Experiment
-
Trial
-
Trial component
-
Lineage group
-
Project
-
Model Card
Required: No
Type: UserContext
Update requires: No interruption
-
LastModifiedByProperty description not available.
Required: No
Type: UserContext
Update requires: No interruption
ModelCardName-
The unique name of the model card.
Required: Yes
Type: String
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$Maximum:
63Update requires: Replacement
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.
Required: Yes
Type: String
Allowed values:
Draft | PendingReview | Approved | ArchivedUpdate requires: No interruption
-
SecurityConfig-
The security configuration used to protect model card data.
Required: No
Type: SecurityConfig
Update requires: Replacement
-
Key-value pairs used to manage metadata for the model card.
Required: No
Type: Array of Tag
Minimum:
1Maximum:
50Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the model card name.
For more information about using the Ref function, see Ref.
Fn::GetAtt
The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.
CreatedBy.DomainIdProperty description not available.
LastModifiedBy.UserProfileArnProperty description not available.
ModelCardArn-
The Amazon Resource Number (ARN) of the model card. For example,
arn:aws:sagemaker:us-west-2:012345678901:modelcard/examplemodelcard.
