ModelCard
An Amazon SageMaker Model Card.
Contents
- Content
-
The content of the model card. Content uses the model card JSON schema and provided as a string.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 100000.
Pattern:
.*Required: No
- CreatedBy
-
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
Type: UserContext object
Required: No
- CreationTime
-
The date and time that the model card was created.
Type: Timestamp
Required: No
- LastModifiedBy
-
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
Type: UserContext object
Required: No
- LastModifiedTime
-
The date and time that the model card was last modified.
Type: Timestamp
Required: No
- ModelCardArn
-
The Amazon Resource Name (ARN) of the model card.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$Required: No
- ModelCardName
-
The unique name of the model card.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$Required: No
- 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.
Type: String
Valid Values:
Draft | PendingReview | Approved | ArchivedRequired: No
-
- ModelCardVersion
-
The version of the model card.
Type: Integer
Required: No
- ModelId
-
The unique name (ID) of the model.
Type: String
Required: No
- ModelPackageGroupName
-
The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry.
Type: String
Required: No
- RiskRating
-
The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.
Type: String
Required: No
- SecurityConfig
-
The security configuration used to protect model card data.
Type: ModelCardSecurityConfig object
Required: No
- Tags
-
Key-value pairs used to manage metadata for the model card.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: