Skip to content

CreateModelCardRequest

Source code in docs_src/capo_sagemaker/types/create_model_card_request.py
class CreateModelCardRequest(TypedDict, closed=True):
    model_card_name: NotRequired["capo_sagemaker.types.entity_name.EntityName"]
    """<p>The unique name of the model card.</p>"""
    security_config: NotRequired[
        "capo_sagemaker.types.model_card_security_config.ModelCardSecurityConfig"
    ]
    """<p>An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.</p>"""
    content: NotRequired["capo_sagemaker.types.model_card_content.ModelCardContent"]
    """<p>The content of the model card. 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>"""
    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>"""
    tags: NotRequired["capo_sagemaker.types.tag_list.TagList"]
    """<p>Key-value pairs used to manage metadata for model cards.</p>"""

content instance-attribute

content: NotRequired[ModelCardContent]

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

model_card_name instance-attribute

model_card_name: NotRequired[EntityName]

The unique name of the model card.

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.

security_config instance-attribute

security_config: NotRequired[ModelCardSecurityConfig]

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

tags instance-attribute

tags: NotRequired[TagList]

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