Skip to content

DescribeModelCardRequest

Source code in docs_src/capo_sagemaker/types/describe_model_card_request.py
class DescribeModelCardRequest(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 describe.</p>"""
    model_card_version: NotRequired["capo_sagemaker.types.integer.Integer"]
    """<p>The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.</p>"""
    included_data: NotRequired["capo_sagemaker.types.included_data.IncludedData"]
    """<p>Specifies the level of model card data to include in the response. Use this parameter to call <code>DescribeModelCard</code> without requiring <code>kms:Decrypt</code> permission on the customer-managed Amazon Web Services KMS key.</p> <ul> <li> <p> <code>AllData</code>: Returns the full model card <code>Content</code>. This option requires <code>kms:Decrypt</code> permission on the customer-managed key, if one is associated with the model card. This is the default.</p> </li> <li> <p> <code>MetadataOnly</code>: Returns the model card with sanitized <code>Content</code> that includes only a small set of unencrypted metadata fields. This option does not require <code>kms:Decrypt</code> permission. For the list of fields preserved in the response, see <code>Content</code>.</p> </li> </ul> <p>If you don't specify a value, SageMaker returns <code>AllData</code>.</p>"""

included_data instance-attribute

included_data: NotRequired[IncludedData]

Specifies the level of model card data to include in the response. Use this parameter to call DescribeModelCard without requiring kms:Decrypt permission on the customer-managed Amazon Web Services KMS key.

  • AllData: Returns the full model card Content. This option requires kms:Decrypt permission on the customer-managed key, if one is associated with the model card. This is the default.

  • MetadataOnly: Returns the model card with sanitized Content that includes only a small set of unencrypted metadata fields. This option does not require kms:Decrypt permission. For the list of fields preserved in the response, see Content.

If you don't specify a value, SageMaker returns AllData.

model_card_name instance-attribute

model_card_name: NotRequired[ModelCardNameOrArn]

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

model_card_version instance-attribute

model_card_version: NotRequired[Integer]

The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.