CfnModelPackageProps Struct
Properties for defining a CfnModelPackage.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
declare const modelInput: any;
const cfnModelPackageProps: sagemaker.CfnModelPackageProps = {
additionalInferenceSpecifications: [{
containers: [{
image: 'image',
// the properties below are optional
containerHostname: 'containerHostname',
environment: {
environmentKey: 'environment',
},
framework: 'framework',
frameworkVersion: 'frameworkVersion',
imageDigest: 'imageDigest',
modelDataSource: {
s3DataSource: {
compressionType: 'compressionType',
s3DataType: 's3DataType',
s3Uri: 's3Uri',
// the properties below are optional
modelAccessConfig: {
acceptEula: false,
},
},
},
modelDataUrl: 'modelDataUrl',
modelInput: modelInput,
nearestModelName: 'nearestModelName',
}],
name: 'name',
// the properties below are optional
description: 'description',
supportedContentTypes: ['supportedContentTypes'],
supportedRealtimeInferenceInstanceTypes: ['supportedRealtimeInferenceInstanceTypes'],
supportedResponseMimeTypes: ['supportedResponseMimeTypes'],
supportedTransformInstanceTypes: ['supportedTransformInstanceTypes'],
}],
additionalInferenceSpecificationsToAdd: [{
containers: [{
image: 'image',
// the properties below are optional
containerHostname: 'containerHostname',
environment: {
environmentKey: 'environment',
},
framework: 'framework',
frameworkVersion: 'frameworkVersion',
imageDigest: 'imageDigest',
modelDataSource: {
s3DataSource: {
compressionType: 'compressionType',
s3DataType: 's3DataType',
s3Uri: 's3Uri',
// the properties below are optional
modelAccessConfig: {
acceptEula: false,
},
},
},
modelDataUrl: 'modelDataUrl',
modelInput: modelInput,
nearestModelName: 'nearestModelName',
}],
name: 'name',
// the properties below are optional
description: 'description',
supportedContentTypes: ['supportedContentTypes'],
supportedRealtimeInferenceInstanceTypes: ['supportedRealtimeInferenceInstanceTypes'],
supportedResponseMimeTypes: ['supportedResponseMimeTypes'],
supportedTransformInstanceTypes: ['supportedTransformInstanceTypes'],
}],
approvalDescription: 'approvalDescription',
certifyForMarketplace: false,
clientToken: 'clientToken',
customerMetadataProperties: {
customerMetadataPropertiesKey: 'customerMetadataProperties',
},
domain: 'domain',
driftCheckBaselines: {
bias: {
configFile: {
s3Uri: 's3Uri',
// the properties below are optional
contentDigest: 'contentDigest',
contentType: 'contentType',
},
postTrainingConstraints: {
contentType: 'contentType',
s3Uri: 's3Uri',
// the properties below are optional
contentDigest: 'contentDigest',
},
preTrainingConstraints: {
contentType: 'contentType',
s3Uri: 's3Uri',
// the properties below are optional
contentDigest: 'contentDigest',
},
},
explainability: {
configFile: {
s3Uri: 's3Uri',
// the properties below are optional
contentDigest: 'contentDigest',
contentType: 'contentType',
},
constraints: {
contentType: 'contentType',
s3Uri: 's3Uri',
// the properties below are optional
contentDigest: 'contentDigest',
},
},
modelDataQuality: {
constraints: {
contentType: 'contentType',
s3Uri: 's3Uri',
// the properties below are optional
contentDigest: 'contentDigest',
},
statistics: {
contentType: 'contentType',
s3Uri: 's3Uri',
// the properties below are optional
contentDigest: 'contentDigest',
},
},
modelQuality: {
constraints: {
contentType: 'contentType',
s3Uri: 's3Uri',
// the properties below are optional
contentDigest: 'contentDigest',
},
statistics: {
contentType: 'contentType',
s3Uri: 's3Uri',
// the properties below are optional
contentDigest: 'contentDigest',
},
},
},
inferenceSpecification: {
containers: [{
image: 'image',
// the properties below are optional
containerHostname: 'containerHostname',
environment: {
environmentKey: 'environment',
},
framework: 'framework',
frameworkVersion: 'frameworkVersion',
imageDigest: 'imageDigest',
modelDataSource: {
s3DataSource: {
compressionType: 'compressionType',
s3DataType: 's3DataType',
s3Uri: 's3Uri',
// the properties below are optional
modelAccessConfig: {
acceptEula: false,
},
},
},
modelDataUrl: 'modelDataUrl',
modelInput: modelInput,
nearestModelName: 'nearestModelName',
}],
supportedContentTypes: ['supportedContentTypes'],
supportedResponseMimeTypes: ['supportedResponseMimeTypes'],
// the properties below are optional
supportedRealtimeInferenceInstanceTypes: ['supportedRealtimeInferenceInstanceTypes'],
supportedTransformInstanceTypes: ['supportedTransformInstanceTypes'],
},
lastModifiedTime: 'lastModifiedTime',
metadataProperties: {
commitId: 'commitId',
generatedBy: 'generatedBy',
projectId: 'projectId',
repository: 'repository',
},
modelApprovalStatus: 'modelApprovalStatus',
modelCard: {
modelCardContent: 'modelCardContent',
modelCardStatus: 'modelCardStatus',
},
modelMetrics: {
bias: {
postTrainingReport: {
contentType: 'contentType',
s3Uri: 's3Uri',
// the properties below are optional
contentDigest: 'contentDigest',
},
preTrainingReport: {
contentType: 'contentType',
s3Uri: 's3Uri',
// the properties below are optional
contentDigest: 'contentDigest',
},
report: {
contentType: 'contentType',
s3Uri: 's3Uri',
// the properties below are optional
contentDigest: 'contentDigest',
},
},
explainability: {
report: {
contentType: 'contentType',
s3Uri: 's3Uri',
// the properties below are optional
contentDigest: 'contentDigest',
},
},
modelDataQuality: {
constraints: {
contentType: 'contentType',
s3Uri: 's3Uri',
// the properties below are optional
contentDigest: 'contentDigest',
},
statistics: {
contentType: 'contentType',
s3Uri: 's3Uri',
// the properties below are optional
contentDigest: 'contentDigest',
},
},
modelQuality: {
constraints: {
contentType: 'contentType',
s3Uri: 's3Uri',
// the properties below are optional
contentDigest: 'contentDigest',
},
statistics: {
contentType: 'contentType',
s3Uri: 's3Uri',
// the properties below are optional
contentDigest: 'contentDigest',
},
},
},
modelPackageDescription: 'modelPackageDescription',
modelPackageGroupName: 'modelPackageGroupName',
modelPackageName: 'modelPackageName',
modelPackageStatusDetails: {
validationStatuses: [{
name: 'name',
status: 'status',
// the properties below are optional
failureReason: 'failureReason',
}],
},
modelPackageVersion: 123,
samplePayloadUrl: 'samplePayloadUrl',
securityConfig: {
kmsKeyId: 'kmsKeyId',
},
skipModelValidation: 'skipModelValidation',
sourceAlgorithmSpecification: {
sourceAlgorithms: [{
algorithmName: 'algorithmName',
// the properties below are optional
modelDataUrl: 'modelDataUrl',
}],
},
sourceUri: 'sourceUri',
tags: [{
key: 'key',
value: 'value',
}],
task: 'task',
validationSpecification: {
validationProfiles: [{
profileName: 'profileName',
transformJobDefinition: {
transformInput: {
dataSource: {
s3DataSource: {
s3DataType: 's3DataType',
s3Uri: 's3Uri',
},
},
// the properties below are optional
compressionType: 'compressionType',
contentType: 'contentType',
splitType: 'splitType',
},
transformOutput: {
s3OutputPath: 's3OutputPath',
// the properties below are optional
accept: 'accept',
assembleWith: 'assembleWith',
kmsKeyId: 'kmsKeyId',
},
transformResources: {
instanceCount: 123,
instanceType: 'instanceType',
// the properties below are optional
volumeKmsKeyId: 'volumeKmsKeyId',
},
// the properties below are optional
batchStrategy: 'batchStrategy',
environment: {
environmentKey: 'environment',
},
maxConcurrentTransforms: 123,
maxPayloadInMb: 123,
},
}],
validationRole: 'validationRole',
},
};
Properties
additionalInferenceSpecificationsoptionalIResolvable | IResolvable | CfnModelPackage.AdditionalInferenceSpecificationDefinitionProperty[]additional_inference_specificationsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AdditionalInferenceSpecificationDefinitionProperty]]]additionalInferenceSpecificationsoptionalIResolvableAdditionalInferenceSpecificationsoptionalIResolvableAdditionalInferenceSpecificationsoptionalinterface{}#An array of additional Inference Specification objects.
additionalInferenceSpecificationsToAddoptionalIResolvable | IResolvable | CfnModelPackage.AdditionalInferenceSpecificationDefinitionProperty[]additional_inference_specifications_to_addoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AdditionalInferenceSpecificationDefinitionProperty]]]additionalInferenceSpecificationsToAddoptionalIResolvableAdditionalInferenceSpecificationsToAddoptionalIResolvableAdditionalInferenceSpecificationsToAddoptionalinterface{}#An array of additional Inference Specification objects to be added to the existing array.
notes
The total number of additional Inference Specification objects cannot exceed 15. Each additional Inference Specification object specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.
approvalDescriptionoptionalstringapproval_descriptionoptionalstrapprovalDescriptionoptionalStringApprovalDescriptionoptionalstringApprovalDescriptionoptional*string#A description provided when the model approval is set.
certifyForMarketplaceoptionalboolean | IResolvablecertify_for_marketplaceoptionaltyping.Union[bool, IResolvable]certifyForMarketplaceoptionalBooleanCertifyForMarketplaceoptionalboolCertifyForMarketplaceoptionalinterface{}#Whether the model package is to be certified to be listed on AWS Marketplace.
For information about listing model packages on AWS Marketplace, see List Your Algorithm or Model Package on AWS Marketplace .
clientTokenoptionalstringclient_tokenoptionalstrclientTokenoptionalStringClientTokenoptionalstringClientTokenoptional*string#A unique token that guarantees that the call to this API is idempotent.
customerMetadataPropertiesoptionalIResolvable | { [key: string]: string }customer_metadata_propertiesoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]customerMetadataPropertiesoptionalIResolvableCustomerMetadataPropertiesoptionalIResolvableCustomerMetadataPropertiesoptionalinterface{}#The metadata properties for the model package.
The machine learning domain of your model package and its components.
Common machine learning domains include computer vision and natural language processing.
driftCheckBaselinesoptionalIResolvable | CfnModelPackage.DriftCheckBaselinesPropertydrift_check_baselinesoptionaltyping.Union[IResolvable, DriftCheckBaselinesProperty]driftCheckBaselinesoptionalIResolvableDriftCheckBaselinesoptionalIResolvableDriftCheckBaselinesoptionalinterface{}#Represents the drift check baselines that can be used when the model monitor is set using the model package.
inferenceSpecificationoptionalIResolvable | CfnModelPackage.InferenceSpecificationPropertyinference_specificationoptionaltyping.Union[IResolvable, InferenceSpecificationProperty]inferenceSpecificationoptionalIResolvableInferenceSpecificationoptionalIResolvableInferenceSpecificationoptionalinterface{}#Defines how to perform inference generation after a training job is run.
lastModifiedTimeoptionalstringlast_modified_timeoptionalstrlastModifiedTimeoptionalStringLastModifiedTimeoptionalstringLastModifiedTimeoptional*string#The last time the model package was modified.
metadataPropertiesoptionalIResolvable | CfnModelPackage.MetadataPropertiesPropertymetadata_propertiesoptionaltyping.Union[IResolvable, MetadataPropertiesProperty]metadataPropertiesoptionalIResolvableMetadataPropertiesoptionalIResolvableMetadataPropertiesoptionalinterface{}#Metadata properties of the tracking entity, trial, or trial component.
modelApprovalStatusoptionalstringmodel_approval_statusoptionalstrmodelApprovalStatusoptionalStringModelApprovalStatusoptionalstringModelApprovalStatusoptional*string#The approval status of the model. This can be one of the following values.
APPROVED- The model is approvedREJECTED- The model is rejected.PENDING_MANUAL_APPROVAL- The model is waiting for manual approval.
modelCardoptionalIResolvable | CfnModelPackage.ModelCardPropertymodel_cardoptionaltyping.Union[IResolvable, ModelCardProperty]modelCardoptionalIResolvableModelCardoptionalIResolvableModelCardoptionalinterface{}#An Amazon SageMaker Model Card.
modelMetricsoptionalIResolvable | CfnModelPackage.ModelMetricsPropertymodel_metricsoptionaltyping.Union[IResolvable, ModelMetricsProperty]modelMetricsoptionalIResolvableModelMetricsoptionalIResolvableModelMetricsoptionalinterface{}#Metrics for the model.
modelPackageDescriptionoptionalstringmodel_package_descriptionoptionalstrmodelPackageDescriptionoptionalStringModelPackageDescriptionoptionalstringModelPackageDescriptionoptional*string#The description of the model package.
modelPackageGroupNameoptionalstringmodel_package_group_nameoptionalstrmodelPackageGroupNameoptionalStringModelPackageGroupNameoptionalstringModelPackageGroupNameoptional*string#The model group to which the model belongs.
modelPackageNameoptionalstringmodel_package_nameoptionalstrmodelPackageNameoptionalStringModelPackageNameoptionalstringModelPackageNameoptional*string#The name of the model package. The name can be as follows:.
- For a versioned model, the name is automatically generated by SageMaker Model Registry and follows the format '
ModelPackageGroupName/ModelPackageVersion'. - For an unversioned model, you must provide the name.
modelPackageStatusDetailsoptionalIResolvable | CfnModelPackage.ModelPackageStatusDetailsPropertymodel_package_status_detailsoptionaltyping.Union[IResolvable, ModelPackageStatusDetailsProperty]modelPackageStatusDetailsoptionalIResolvableModelPackageStatusDetailsoptionalIResolvableModelPackageStatusDetailsoptionalinterface{}#Specifies the validation and image scan statuses of the model package.
modelPackageVersionoptionalnumbermodel_package_versionoptionalint | floatmodelPackageVersionoptionalNumberModelPackageVersionoptionaldoubleModelPackageVersionoptional*float64#The version number of a versioned model.
samplePayloadUrloptionalstringsample_payload_urloptionalstrsamplePayloadUrloptionalStringSamplePayloadUrloptionalstringSamplePayloadUrloptional*string#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).
securityConfigoptionalIResolvable | CfnModelPackage.SecurityConfigPropertysecurity_configoptionaltyping.Union[IResolvable, SecurityConfigProperty]securityConfigoptionalIResolvableSecurityConfigoptionalIResolvableSecurityConfigoptionalinterface{}#An optional AWS Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.
skipModelValidationoptionalstringskip_model_validationoptionalstrskipModelValidationoptionalStringSkipModelValidationoptionalstringSkipModelValidationoptional*string#Indicates if you want to skip model validation.
sourceAlgorithmSpecificationoptionalIResolvable | CfnModelPackage.SourceAlgorithmSpecificationPropertysource_algorithm_specificationoptionaltyping.Union[IResolvable, SourceAlgorithmSpecificationProperty]sourceAlgorithmSpecificationoptionalIResolvableSourceAlgorithmSpecificationoptionalIResolvableSourceAlgorithmSpecificationoptionalinterface{}#A list of algorithms that were used to create a model package.
sourceUrioptionalstringsource_urioptionalstrsourceUrioptionalStringSourceUrioptionalstringSourceUrioptional*string#The URI of the source for the model package.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#A list of the tags associated with the model package.
For more information, see Tagging AWS resources in the AWS General Reference Guide .
The machine learning task your model package accomplishes.
Common machine learning tasks include object detection and image classification.
validationSpecificationoptionalIResolvable | CfnModelPackage.ValidationSpecificationPropertyvalidation_specificationoptionaltyping.Union[IResolvable, ValidationSpecificationProperty]validationSpecificationoptionalIResolvableValidationSpecificationoptionalIResolvableValidationSpecificationoptionalinterface{}#Specifies batch transform jobs that SageMaker runs to validate your model package.