Skip to content

UpdateModelPackageInput

Source code in docs_src/capo_sagemaker/types/update_model_package_input.py
class UpdateModelPackageInput(TypedDict, closed=True):
    model_package_arn: NotRequired[
        "capo_sagemaker.types.model_package_arn.ModelPackageArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the model package.</p>"""
    model_approval_status: NotRequired[
        "capo_sagemaker.types.model_approval_status.ModelApprovalStatus"
    ]
    """<p>The approval status of the model.</p>"""
    model_package_registration_type: NotRequired[
        "capo_sagemaker.types.model_package_registration_type.ModelPackageRegistrationType"
    ]
    """<p> The package registration type of the model package input. </p>"""
    approval_description: NotRequired[
        "capo_sagemaker.types.approval_description.ApprovalDescription"
    ]
    """<p>A description for the approval status of the model.</p>"""
    customer_metadata_properties: NotRequired[
        "capo_sagemaker.types.customer_metadata_map.CustomerMetadataMap"
    ]
    """<p>The metadata properties associated with the model package versions.</p>"""
    customer_metadata_properties_to_remove: NotRequired[
        "capo_sagemaker.types.customer_metadata_key_list.CustomerMetadataKeyList"
    ]
    """<p>The metadata properties associated with the model package versions to remove.</p>"""
    additional_inference_specifications_to_add: NotRequired[
        "capo_sagemaker.types.additional_inference_specifications.AdditionalInferenceSpecifications"
    ]
    """<p>An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.</p>"""
    inference_specification: NotRequired[
        "capo_sagemaker.types.inference_specification.InferenceSpecification"
    ]
    """<p>Specifies details about inference jobs that you can run with models based on this model package, including the following information:</p> <ul> <li> <p>The Amazon ECR paths of containers that contain the inference code and model artifacts.</p> </li> <li> <p>The instance types that the model package supports for transform jobs and real-time endpoints used for inference.</p> </li> <li> <p>The input and output content formats that the model package supports for inference.</p> </li> </ul>"""
    source_uri: NotRequired[
        "capo_sagemaker.types.model_package_source_uri.ModelPackageSourceUri"
    ]
    """<p>The URI of the source for the model package.</p>"""
    model_card: NotRequired[
        "capo_sagemaker.types.model_package_model_card.ModelPackageModelCard"
    ]
    """<p>The model card associated with the model package. Since <code>ModelPackageModelCard</code> is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of <code>ModelCard</code>. The <code>ModelPackageModelCard</code> schema does not include <code>model_package_details</code>, and <code>model_overview</code> is composed of the <code>model_creator</code> and <code>model_artifact</code> properties. For more information about the model package model card schema, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html#model-card-schema">Model package model card schema</a>. For more information about the model card associated with the model package, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html">View the Details of a Model Version</a>.</p>"""
    model_life_cycle: NotRequired[
        "capo_sagemaker.types.model_life_cycle.ModelLifeCycle"
    ]
    """<p> A structure describing the current state of the model in its life cycle. </p>"""
    client_token: NotRequired["capo_sagemaker.types.client_token.ClientToken"]
    """<p> A unique token that guarantees that the call to this API is idempotent. </p>"""

additional_inference_specifications_to_add instance-attribute

additional_inference_specifications_to_add: NotRequired[
    AdditionalInferenceSpecifications
]

An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

approval_description instance-attribute

approval_description: NotRequired[ApprovalDescription]

A description for the approval status of the model.

client_token instance-attribute

client_token: NotRequired[ClientToken]

A unique token that guarantees that the call to this API is idempotent.

customer_metadata_properties instance-attribute

customer_metadata_properties: NotRequired[CustomerMetadataMap]

The metadata properties associated with the model package versions.

customer_metadata_properties_to_remove instance-attribute

customer_metadata_properties_to_remove: NotRequired[CustomerMetadataKeyList]

The metadata properties associated with the model package versions to remove.

inference_specification instance-attribute

inference_specification: NotRequired[InferenceSpecification]

Specifies details about inference jobs that you can run with models based on this model package, including the following information:

  • The Amazon ECR paths of containers that contain the inference code and model artifacts.

  • The instance types that the model package supports for transform jobs and real-time endpoints used for inference.

  • The input and output content formats that the model package supports for inference.

model_approval_status instance-attribute

model_approval_status: NotRequired[ModelApprovalStatus]

The approval status of the model.

model_card instance-attribute

model_card: NotRequired[ModelPackageModelCard]

The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.

model_life_cycle instance-attribute

model_life_cycle: NotRequired[ModelLifeCycle]

A structure describing the current state of the model in its life cycle.

model_package_arn instance-attribute

model_package_arn: NotRequired[ModelPackageArn]

The Amazon Resource Name (ARN) of the model package.

model_package_registration_type instance-attribute

model_package_registration_type: NotRequired[ModelPackageRegistrationType]

The package registration type of the model package input.

source_uri instance-attribute

source_uri: NotRequired[ModelPackageSourceUri]

The URI of the source for the model package.