Skip to content

UpdateModelCardRequest

Source code in docs_src/capo_sagemaker/types/update_model_card_request.py 
13
14
15
16
17
18
19
20
21
22
23
class UpdateModelCardRequest(TypedDict, closed=True):
    model_card_name: NotRequired[
        "capo_sagemaker.types.model_card_name_or_arn.ModelCardNameOrArn"
    ]
    """<p>The name or Amazon Resource Name (ARN) of the model card to update.</p>"""
    content: NotRequired["capo_sagemaker.types.model_card_content.ModelCardContent"]
    """<p>The updated model card content. Content must be in <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema">model card JSON schema</a> and provided as a string.</p> <p>When updating model card content, be sure to include the full content and not just updated content.</p>"""
    model_card_status: NotRequired[
        "capo_sagemaker.types.model_card_status.ModelCardStatus"
    ]
    """<p>The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.</p> <ul> <li> <p> <code>Draft</code>: The model card is a work in progress.</p> </li> <li> <p> <code>PendingReview</code>: The model card is pending review.</p> </li> <li> <p> <code>Approved</code>: The model card is approved.</p> </li> <li> <p> <code>Archived</code>: The model card is archived. No more updates should be made to the model card, but it can still be exported.</p> </li> </ul>"""

content instance-attribute 

content: NotRequired[ModelCardContent]

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.

model_card_name instance-attribute 

model_card_name: NotRequired[ModelCardNameOrArn]

The name or Amazon Resource Name (ARN) of the model card to update.

model_card_status instance-attribute 

model_card_status: NotRequired[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.