UpdateModelCard
Update an Amazon SageMaker Model Card.
Important
You cannot update both model card content and model card status in a single call.
Request Syntax
{
"Content": "string",
"ModelCardName": "string",
"ModelCardStatus": "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 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.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 100000.
Pattern:
.*Required: No
- ModelCardName
-
The name or Amazon Resource Name (ARN) of the model card to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:model-card/.*)?([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 | ArchivedRequired: 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 updated 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
ExperimentorArtifact.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
- ResourceNotFound
-
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
