Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateModelCard

Creates an Amazon SageMaker Model Card.

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

Request Syntax


{
   "Content": "string",
   "ModelCardName": "string",
   "ModelCardStatus": "string",
   "SecurityConfig": { 
      "KmsKeyId": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Content

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 100000.

Pattern: .*

Required: Yes

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: Yes

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 | Archived

Required: Yes

SecurityConfig

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

Type: ModelCardSecurityConfig object

Required: No

Tags

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

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

Response Syntax


{
   "ModelCardArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ModelCardArn

The Amazon Resource Name (ARN) of the successfully created 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}$

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.

HTTP Status Code: 400

ResourceLimitExceeded

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

HTTP Status Code: 400