ModelPackage - Amazon SageMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

ModelPackage

A versioned model that can be deployed for SageMaker inference.

Contents

AdditionalInferenceSpecifications

An array of additional Inference Specification objects.

Type: Array of AdditionalInferenceSpecificationDefinition objects

Array Members: Minimum number of 1 item. Maximum number of 15 items.

Required: No

ApprovalDescription

A description provided when the model approval is set.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: .*

Required: No

CertifyForMarketplace

Whether the model package is to be certified to be listed on Amazon Marketplace. For information about listing model packages on Amazon Marketplace, see List Your Algorithm or Model Package on Amazon Marketplace.

Type: Boolean

Required: No

CreatedBy

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

Type: UserContext object

Required: No

CreationTime

The time that the model package was created.

Type: Timestamp

Required: No

CustomerMetadataProperties

The metadata properties for the model package.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)${1,128}

Value Length Constraints: Minimum length of 1. Maximum length of 256.

Value Pattern: ^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)${1,256}

Required: No

Domain

The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.

Type: String

Required: No

DriftCheckBaselines

Represents the drift check baselines that can be used when the model monitor is set using the model package.

Type: DriftCheckBaselines object

Required: No

InferenceSpecification

Defines how to perform inference generation after a training job is run.

Type: InferenceSpecification object

Required: No

LastModifiedBy

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

Type: UserContext object

Required: No

LastModifiedTime

The last time the model package was modified.

Type: Timestamp

Required: No

MetadataProperties

Metadata properties of the tracking entity, trial, or trial component.

Type: MetadataProperties object

Required: No

ModelApprovalStatus

The approval status of the model. This can be one of the following values.

  • APPROVED - The model is approved

  • REJECTED - The model is rejected.

  • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.

Type: String

Valid Values: Approved | Rejected | PendingManualApproval

Required: No

ModelMetrics

Metrics for the model.

Type: ModelMetrics object

Required: No

ModelPackageArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:model-package/.*

Required: No

ModelPackageDescription

The description of the model package.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*

Required: No

ModelPackageGroupName

The model group to which the model belongs.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$

Required: No

ModelPackageName

The name of the model.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$

Required: No

ModelPackageStatus

The status of the model package. This can be one of the following values.

  • PENDING - The model package is pending being created.

  • IN_PROGRESS - The model package is in the process of being created.

  • COMPLETED - The model package was successfully created.

  • FAILED - The model package failed.

  • DELETING - The model package is in the process of being deleted.

Type: String

Valid Values: Pending | InProgress | Completed | Failed | Deleting

Required: No

ModelPackageStatusDetails

Specifies the validation and image scan statuses of the model package.

Type: ModelPackageStatusDetails object

Required: No

ModelPackageVersion

The version number of a versioned model.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

SamplePayloadUrl

The Amazon Simple Storage Service path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

Type: String

Required: No

SourceAlgorithmSpecification

A list of algorithms that were used to create a model package.

Type: SourceAlgorithmSpecification object

Required: No

Tags

A list of the tags associated with the model package. For more information, see Tagging Amazon resources in the Amazon General Reference Guide.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

Task

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

Type: String

Required: No

ValidationSpecification

Specifies batch transform jobs that SageMaker runs to validate your model package.

Type: ModelPackageValidationSpecification object

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: