Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-143021,9861.6 MB

Returns a description of the specified model package, which is used to create SageMaker models or list them on Amazon Web Services Marketplace.

To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace.

post/#X-Amz-Target=SageMaker.DescribeModelPackage

Headers

X-Amz-Target'SageMaker.DescribeModelPackage' required

Request body

ModelPackageNamestring required
<p>The name or Amazon Resource Name (ARN) of the model package to describe.</p> <p>When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).</p>

Response

Success

ModelPackageNamestring required

The name of the model package being described.

ModelPackageGroupNamestring

If the model is a versioned model, the name of the model group that the versioned model belongs to.

ModelPackageVersioninteger

The version of the model package.

ModelPackageArnstring required

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

ModelPackageDescriptionstring

A brief summary of the model package.

CreationTimestring date-time required

A timestamp specifying when the model package was created.

ModelPackageStatus'Pending' | 'InProgress' | 'Completed' | 'Failed' | 'Deleting' required

The current status of the model package.

CertifyForMarketplaceboolean

Whether the model package is certified for listing on Amazon Web Services Marketplace.

ModelApprovalStatus'Approved' | 'Rejected' | 'PendingManualApproval'

The approval status of the model package.

LastModifiedTimestring date-time

The last time that the model package was modified.

ApprovalDescriptionstring

A description provided for the model approval.

CustomerMetadataPropertiesobject

The metadata properties associated with the model package versions.

Domainstring

The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.

Taskstring

The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.

SamplePayloadUrlstring

The 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).