SageMaker Model Package

An AWS SageMaker Model Package is a container for machine learning models that includes model artifacts, inference code, and metadata. It enables versioning, sharing, and deployment of models across different environments. Model packages can be created, validated, and stored in the SageMaker Model Registry, making it easier to manage the lifecycle of ML models and ensure consistent deployment.

aws.sagemaker_model_package

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
additional_inference_specificationscorejsonAn array of additional Inference Specification objects. 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_descriptioncorestringA description provided for the model approval.
certify_for_marketplacecoreboolWhether the model package is certified for listing on Amazon Web Services Marketplace.
created_bycorejsonInformation about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
creation_timecoretimestampA timestamp specifying when the model package was created.
customer_metadata_propertiescorehstoreThe metadata properties associated with the model package versions.
domaincorestringThe machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.
drift_check_baselinescorejsonRepresents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.
inference_specificationcorejsonDetails about inference jobs that you can run with models based on this model package.
last_modified_bycorejsonInformation about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
last_modified_timecoretimestampThe last time that the model package was modified.
metadata_propertiescorejsonMetadata properties of the tracking entity, trial, or trial component.
model_approval_statuscorestringThe approval status of the model package.
model_cardcorejsonThe 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_cyclecorejsonA structure describing the current state of the model in its life cycle.
model_metricscorejsonMetrics for the model.
model_package_arncorestringThe Amazon Resource Name (ARN) of the model package.
model_package_descriptioncorestringA brief summary of the model package.
model_package_group_namecorestringIf the model is a versioned model, the name of the model group that the versioned model belongs to.
model_package_namecorestringThe name of the model package being described.
model_package_statuscorestringThe current status of the model package.
model_package_status_detailscorejsonDetails about the current status of the model package.
model_package_versioncoreint64The version of the model package.
sample_payload_urlcorestringThe Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single gzip compressed tar archive (.tar.gz suffix).
security_configcorejsonThe KMS Key ID (KMSKeyId) used for encryption of model package information.
skip_model_validationcorestringIndicates if you want to skip model validation.
source_algorithm_specificationcorejsonDetails about the algorithm that was used to create the model package.
source_uricorestringThe URI of the source for the model package.
tagscorehstore
taskcorestringThe machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.
validation_specificationcorejsonConfigurations for one or more transform jobs that SageMaker runs to test the model package.