Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-sagemaker-modelpackage.json
Parent schema serverless-framework-configuration
Type: object

Resource Type definition for AWS::SageMaker::ModelPackage. Source:- No source definition found, add manually please

Properties

Tags Tag[]

An array of key-value pairs to apply to this resource.

maxItems=50
AdditionalInferenceSpecifications AdditionalInferenceSpecificationDefinition[]

An array of additional Inference Specification objects.

minItems=1maxItems=15
AdditionalInferenceSpecificationDefinition object

Additional Inference Specification specifies details about inference jobs that can be run with models based on this model package.AdditionalInferenceSpecifications can be added to existing model packages using AdditionalInferenceSpecificationsToAdd.

7 nested properties
Containers ModelPackageContainerDefinition[] required

The Amazon ECR registry path of the Docker image that contains the inference code.

minItems=1maxItems=15
Name string | Aws_CF_FunctionString required

A unique name to identify the additional inference specification. The name must be unique within the list of your additional inference specifications for a particular model package.

Description string | Aws_CF_FunctionString

A description of the additional Inference specification.

SupportedContentTypes ContentType[]

The supported MIME types for the input data.

SupportedRealtimeInferenceInstanceTypes InferenceInstanceType[]

A list of the instance types that are used to generate inferences in real-time

SupportedResponseMIMETypes ResponseMIMEType[]

The supported MIME types for the output data.

SupportedTransformInstanceTypes TransformInstanceType[]

A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

minItems=1
CertifyForMarketplace boolean

Whether to certify the model package for listing on AWS Marketplace.

ClientToken string | Aws_CF_FunctionString

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

CustomerMetadataProperties object

The metadata properties associated with the model package versions.

Domain string | Aws_CF_FunctionString

The machine learning domain of the model package you specified.

DriftCheckBaselines object

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

4 nested properties
Bias object

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

3 nested properties
PostTrainingConstraints object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

PreTrainingConstraints object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

ConfigFile object

Represents a File Source Object.

3 nested properties
S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the file source.

ContentDigest string | Aws_CF_FunctionString

The digest of the file source.

ContentType string | Aws_CF_FunctionString

The type of content stored in the file source.

Explainability object

Contains explainability metrics for a model.

2 nested properties
Constraints object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

ConfigFile object

Represents a File Source Object.

3 nested properties
S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the file source.

ContentDigest string | Aws_CF_FunctionString

The digest of the file source.

ContentType string | Aws_CF_FunctionString

The type of content stored in the file source.

ModelDataQuality object

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

2 nested properties
Constraints object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

Statistics object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

ModelQuality object

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

2 nested properties
Constraints object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

Statistics object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

InferenceSpecification object

Details about inference jobs that can be run with models based on this model package.

5 nested properties
Containers ModelPackageContainerDefinition[] required

The Amazon ECR registry path of the Docker image that contains the inference code.

minItems=1maxItems=15uniqueItems=true
SupportedContentTypes ContentType[] required

The supported MIME types for the input data.

SupportedResponseMIMETypes ResponseMIMEType[] required

The supported MIME types for the output data.

SupportedRealtimeInferenceInstanceTypes InferenceInstanceType[]

A list of the instance types that are used to generate inferences in real-time

SupportedTransformInstanceTypes TransformInstanceType[]

A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

minItems=1
MetadataProperties object

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

4 nested properties
CommitId string | Aws_CF_FunctionString

The commit ID.

GeneratedBy string | Aws_CF_FunctionString

The entity this entity was generated by.

ProjectId string | Aws_CF_FunctionString

The project ID metadata.

Repository string | Aws_CF_FunctionString

The repository metadata.

ModelApprovalStatus string | Aws_CF_FunctionString

The approval status of the model package.

ModelMetrics object

A structure that contains model metrics reports.

4 nested properties
Bias object

Contains bias metrics for a model.

3 nested properties
Report object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

PreTrainingReport object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

PostTrainingReport object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

Explainability object

Contains explainability metrics for a model.

1 nested properties
Report object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

ModelDataQuality object

Metrics that measure the quality of the input data for a model.

2 nested properties
Constraints object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

Statistics object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

ModelQuality object

Metrics that measure the quality of a model.

2 nested properties
Constraints object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

Statistics object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

ModelPackageDescription string | Aws_CF_FunctionString

The description of the model package.

ModelPackageGroupName string | Aws_CF_FunctionString

The name of the model package group.

ModelPackageName string | Aws_CF_FunctionString

The name or arn of the model package.

SamplePayloadUrl string | Aws_CF_FunctionString

The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored pointing to single gzip compressed tar archive.

SourceAlgorithmSpecification object

Details about the algorithm that was used to create the model package.

1 nested properties
SourceAlgorithms SourceAlgorithm[] required

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

minItems=1maxItems=1
Task string | Aws_CF_FunctionString

The machine learning task your model package accomplishes.

ValidationSpecification object

Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.

2 nested properties
ValidationProfiles ValidationProfile[] required
minItems=1maxItems=1
ValidationRole string | Aws_CF_FunctionString required

The IAM roles to be used for the validation of the model package.

ApprovalDescription string | Aws_CF_FunctionString

A description provided for the model approval.

LastModifiedBy UserContext
LastModifiedTime string | Aws_CF_FunctionString

The time at which the model package was last modified.

ModelPackageVersion integer

The version of the model package.

min=1
AdditionalInferenceSpecificationsToAdd AdditionalInferenceSpecificationDefinition[]

An array of additional Inference Specification objects.

minItems=1maxItems=15
ModelPackageStatusDetails object

Details about the current status of the model package.

2 nested properties
ValidationStatuses ModelPackageStatusItem[] required
ImageScanStatuses ModelPackageStatusItem[]
ModelPackageStatusItem object

Represents the overall status of a model package.

3 nested properties
Name string | Aws_CF_FunctionString required

The name of the model package for which the overall status is being reported.

Status string | Aws_CF_FunctionString required

The current status.

FailureReason string | Aws_CF_FunctionString

If the overall status is Failed, the reason for the failure.

CreatedBy UserContext
Environment object

Sets the environment variables in the Docker container

Definitions

Tag object

A key-value pair to associate with a resource.

Key string | Aws_CF_FunctionString required

The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string | Aws_CF_FunctionString required

The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

AdditionalInferenceSpecifications AdditionalInferenceSpecificationDefinition[]

An array of additional Inference Specification objects.

AdditionalInferenceSpecificationDefinition object

Additional Inference Specification specifies details about inference jobs that can be run with models based on this model package.AdditionalInferenceSpecifications can be added to existing model packages using AdditionalInferenceSpecificationsToAdd.

Containers ModelPackageContainerDefinition[] required

The Amazon ECR registry path of the Docker image that contains the inference code.

minItems=1maxItems=15
Name string | Aws_CF_FunctionString required

A unique name to identify the additional inference specification. The name must be unique within the list of your additional inference specifications for a particular model package.

Description string | Aws_CF_FunctionString

A description of the additional Inference specification.

SupportedContentTypes ContentType[]

The supported MIME types for the input data.

SupportedRealtimeInferenceInstanceTypes InferenceInstanceType[]

A list of the instance types that are used to generate inferences in real-time

SupportedResponseMIMETypes ResponseMIMEType[]

The supported MIME types for the output data.

SupportedTransformInstanceTypes TransformInstanceType[]

A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

minItems=1
TransformInstanceType string | Aws_CF_FunctionString

Instance types on which a transformation job can be run or on which an endpoint can be deployed.

InferenceInstanceType string | Aws_CF_FunctionString

Instance type that is used to generate inferences in real-time

ContentType string | Aws_CF_FunctionString

The supported MIME type for the input data.

ResponseMIMEType string | Aws_CF_FunctionString

The supported MIME types for the output data.

CertifyForMarketplace boolean

Whether to certify the model package for listing on AWS Marketplace.

ClientToken string | Aws_CF_FunctionString

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

CustomerMetadataProperties object

The metadata properties associated with the model package versions.

Domain string | Aws_CF_FunctionString

The machine learning domain of the model package you specified.

DriftCheckBaselines object

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

Bias object

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

3 nested properties
PostTrainingConstraints object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

PreTrainingConstraints object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

ConfigFile object

Represents a File Source Object.

3 nested properties
S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the file source.

ContentDigest string | Aws_CF_FunctionString

The digest of the file source.

ContentType string | Aws_CF_FunctionString

The type of content stored in the file source.

Explainability object

Contains explainability metrics for a model.

2 nested properties
Constraints object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

ConfigFile object

Represents a File Source Object.

3 nested properties
S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the file source.

ContentDigest string | Aws_CF_FunctionString

The digest of the file source.

ContentType string | Aws_CF_FunctionString

The type of content stored in the file source.

ModelDataQuality object

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

2 nested properties
Constraints object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

Statistics object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

ModelQuality object

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

2 nested properties
Constraints object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

Statistics object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

DriftCheckBias object

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

PostTrainingConstraints object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

PreTrainingConstraints object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

ConfigFile object

Represents a File Source Object.

3 nested properties
S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the file source.

ContentDigest string | Aws_CF_FunctionString

The digest of the file source.

ContentType string | Aws_CF_FunctionString

The type of content stored in the file source.

DriftCheckExplainability object

Contains explainability metrics for a model.

Constraints object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

ConfigFile object

Represents a File Source Object.

3 nested properties
S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the file source.

ContentDigest string | Aws_CF_FunctionString

The digest of the file source.

ContentType string | Aws_CF_FunctionString

The type of content stored in the file source.

DriftCheckModelDataQuality object

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

Constraints object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

Statistics object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

DriftCheckModelQuality object

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

Constraints object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

Statistics object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

MetricsSource object

Represents a Metric Source Object.

ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

FileSource object

Represents a File Source Object.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the file source.

ContentDigest string | Aws_CF_FunctionString

The digest of the file source.

ContentType string | Aws_CF_FunctionString

The type of content stored in the file source.

InferenceSpecification object

Details about inference jobs that can be run with models based on this model package.

Containers ModelPackageContainerDefinition[] required

The Amazon ECR registry path of the Docker image that contains the inference code.

minItems=1maxItems=15uniqueItems=true
SupportedContentTypes ContentType[] required

The supported MIME types for the input data.

SupportedResponseMIMETypes ResponseMIMEType[] required

The supported MIME types for the output data.

SupportedRealtimeInferenceInstanceTypes InferenceInstanceType[]

A list of the instance types that are used to generate inferences in real-time

SupportedTransformInstanceTypes TransformInstanceType[]

A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

minItems=1
Environment object

Sets the environment variables in the Docker container

ModelPackageContainerDefinition object

Describes the Docker container for the model package.

Image string | Aws_CF_FunctionString required

The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.

ContainerHostname string | Aws_CF_FunctionString

The DNS host name for the Docker container.

Environment object

Sets the environment variables in the Docker container

ModelInput object
1 nested properties
DataInputConfig string | Aws_CF_FunctionString required

The input configuration object for the model.

ImageDigest string | Aws_CF_FunctionString

An MD5 hash of the training algorithm that identifies the Docker image used for training.

ModelDataUrl string | Aws_CF_FunctionString

A structure with Model Input details.

ProductId string | Aws_CF_FunctionString

The AWS Marketplace product ID of the model package.

Framework string | Aws_CF_FunctionString

The machine learning framework of the model package container image.

FrameworkVersion string | Aws_CF_FunctionString

The framework version of the Model Package Container Image.

NearestModelName string | Aws_CF_FunctionString

The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model.

MetadataProperties object

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

CommitId string | Aws_CF_FunctionString

The commit ID.

GeneratedBy string | Aws_CF_FunctionString

The entity this entity was generated by.

ProjectId string | Aws_CF_FunctionString

The project ID metadata.

Repository string | Aws_CF_FunctionString

The repository metadata.

ModelApprovalStatus string | Aws_CF_FunctionString

The approval status of the model package.

ModelMetrics object

A structure that contains model metrics reports.

Bias object

Contains bias metrics for a model.

3 nested properties
Report object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

PreTrainingReport object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

PostTrainingReport object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

Explainability object

Contains explainability metrics for a model.

1 nested properties
Report object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

ModelDataQuality object

Metrics that measure the quality of the input data for a model.

2 nested properties
Constraints object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

Statistics object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

ModelQuality object

Metrics that measure the quality of a model.

2 nested properties
Constraints object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

Statistics object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

Bias object

Contains bias metrics for a model.

Report object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

PreTrainingReport object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

PostTrainingReport object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

Explainability object

Contains explainability metrics for a model.

Report object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

ModelDataQuality object

Metrics that measure the quality of the input data for a model.

Constraints object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

Statistics object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

ModelQuality object

Metrics that measure the quality of a model.

Constraints object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

Statistics object

Represents a Metric Source Object.

3 nested properties
ContentType string | Aws_CF_FunctionString required

The type of content stored in the metric source.

S3Uri string | Aws_CF_FunctionString required

The Amazon S3 URI for the metric source.

ContentDigest string | Aws_CF_FunctionString

The digest of the metric source.

ModelPackageDescription string | Aws_CF_FunctionString

The description of the model package.

ModelPackageGroupName string | Aws_CF_FunctionString

The name of the model package group.

ModelPackageName string | Aws_CF_FunctionString

The name or arn of the model package.

SamplePayloadUrl string | Aws_CF_FunctionString

The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored pointing to single gzip compressed tar archive.

SourceAlgorithmSpecification object

Details about the algorithm that was used to create the model package.

SourceAlgorithms SourceAlgorithm[] required

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

minItems=1maxItems=1
SourceAlgorithm object

Specifies an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your Amazon SageMaker account or an algorithm in AWS Marketplace that you are subscribed to.

AlgorithmName string | Aws_CF_FunctionString required

The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your Amazon SageMaker account or an algorithm in AWS Marketplace that you are subscribed to.

ModelDataUrl string | Aws_CF_FunctionString

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

ValidationSpecification object

Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.

ValidationProfiles ValidationProfile[] required
minItems=1maxItems=1
ValidationRole string | Aws_CF_FunctionString required

The IAM roles to be used for the validation of the model package.

ValidationProfile object

Contains data, such as the inputs and targeted instance types that are used in the process of validating the model package.

TransformJobDefinition object required

Defines the input needed to run a transform job using the inference specification specified in the algorithm.

7 nested properties
TransformInput object required

Describes the input source of a transform job and the way the transform job consumes it.

4 nested properties
DataSource object required

Describes the input source of a transform job and the way the transform job consumes it.

CompressionType string | Aws_CF_FunctionString

If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None.

ContentType string | Aws_CF_FunctionString

The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.

SplitType string | Aws_CF_FunctionString

The method to use to split the transform job's data files into smaller batches.

TransformOutput object required

Describes the results of a transform job.

4 nested properties
S3OutputPath string | Aws_CF_FunctionString required

The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job.

Accept string | Aws_CF_FunctionString

The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.

KmsKeyId string | Aws_CF_FunctionString

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.

AssembleWith string | Aws_CF_FunctionString

Defines how to assemble the results of the transform job as a single S3 object.

TransformResources object required

Describes the resources, including ML instance types and ML instance count, to use for transform job.

3 nested properties
InstanceCount integer required

The number of ML compute instances to use in the transform job. For distributed transform jobs, specify a value greater than 1. The default value is 1.

min=1
InstanceType string | Aws_CF_FunctionString required

The ML compute instance type for the transform job.

VolumeKmsKeyId string | Aws_CF_FunctionString

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job.

Environment object

Sets the environment variables in the Docker container

BatchStrategy string | Aws_CF_FunctionString

A string that determines the number of records included in a single mini-batch.

MaxConcurrentTransforms integer

The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.

min=0
MaxPayloadInMB integer

The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).

min=0
ProfileName string | Aws_CF_FunctionString required

The name of the profile for the model package.

TransformJobDefinition object

Defines the input needed to run a transform job using the inference specification specified in the algorithm.

TransformInput object required

Describes the input source of a transform job and the way the transform job consumes it.

4 nested properties
DataSource object required

Describes the input source of a transform job and the way the transform job consumes it.

1 nested properties
S3DataSource object required

Describes the S3 data source.

CompressionType string | Aws_CF_FunctionString

If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None.

ContentType string | Aws_CF_FunctionString

The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.

SplitType string | Aws_CF_FunctionString

The method to use to split the transform job's data files into smaller batches.

TransformOutput object required

Describes the results of a transform job.

4 nested properties
S3OutputPath string | Aws_CF_FunctionString required

The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job.

Accept string | Aws_CF_FunctionString

The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.

KmsKeyId string | Aws_CF_FunctionString

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.

AssembleWith string | Aws_CF_FunctionString

Defines how to assemble the results of the transform job as a single S3 object.

TransformResources object required

Describes the resources, including ML instance types and ML instance count, to use for transform job.

3 nested properties
InstanceCount integer required

The number of ML compute instances to use in the transform job. For distributed transform jobs, specify a value greater than 1. The default value is 1.

min=1
InstanceType string | Aws_CF_FunctionString required

The ML compute instance type for the transform job.

VolumeKmsKeyId string | Aws_CF_FunctionString

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job.

Environment object

Sets the environment variables in the Docker container

BatchStrategy string | Aws_CF_FunctionString

A string that determines the number of records included in a single mini-batch.

MaxConcurrentTransforms integer

The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.

min=0
MaxPayloadInMB integer

The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).

min=0
TransformInput object

Describes the input source of a transform job and the way the transform job consumes it.

DataSource object required

Describes the input source of a transform job and the way the transform job consumes it.

1 nested properties
S3DataSource object required

Describes the S3 data source.

2 nested properties
S3DataType string | Aws_CF_FunctionString required

The S3 Data Source Type

S3Uri string | Aws_CF_FunctionString required

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest.

CompressionType string | Aws_CF_FunctionString

If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None.

ContentType string | Aws_CF_FunctionString

The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.

SplitType string | Aws_CF_FunctionString

The method to use to split the transform job's data files into smaller batches.

DataSource object

Describes the input source of a transform job and the way the transform job consumes it.

S3DataSource object required

Describes the S3 data source.

2 nested properties
S3DataType string | Aws_CF_FunctionString required

The S3 Data Source Type

S3Uri string | Aws_CF_FunctionString required

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest.

S3DataSource object

Describes the S3 data source.

S3DataType string | Aws_CF_FunctionString required

The S3 Data Source Type

S3Uri string | Aws_CF_FunctionString required

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest.

TransformOutput object

Describes the results of a transform job.

S3OutputPath string | Aws_CF_FunctionString required

The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job.

Accept string | Aws_CF_FunctionString

The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.

KmsKeyId string | Aws_CF_FunctionString

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.

AssembleWith string | Aws_CF_FunctionString

Defines how to assemble the results of the transform job as a single S3 object.

TransformResources object

Describes the resources, including ML instance types and ML instance count, to use for transform job.

InstanceCount integer required

The number of ML compute instances to use in the transform job. For distributed transform jobs, specify a value greater than 1. The default value is 1.

min=1
InstanceType string | Aws_CF_FunctionString required

The ML compute instance type for the transform job.

VolumeKmsKeyId string | Aws_CF_FunctionString

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job.

ModelPackageArn string | Aws_CF_FunctionString

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

ApprovalDescription string | Aws_CF_FunctionString

A description provided for the model approval.

CreatedBy object

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

DomainId string | Aws_CF_FunctionString

The domain associated with the user.

UserProfileArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the user's profile.

UserProfileName string | Aws_CF_FunctionString

The name of the user's profile.

CreationTime string | Aws_CF_FunctionString

The time at which the model package was created.

UserContext object

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

DomainId string | Aws_CF_FunctionString

The domain associated with the user.

UserProfileArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the user's profile.

UserProfileName string | Aws_CF_FunctionString

The name of the user's profile.

LastModifiedBy object

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

DomainId string | Aws_CF_FunctionString

The domain associated with the user.

UserProfileArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the user's profile.

UserProfileName string | Aws_CF_FunctionString

The name of the user's profile.

LastModifiedTime string | Aws_CF_FunctionString

The time at which the model package was last modified.

ModelPackageStatus string | Aws_CF_FunctionString

The current status of the model package.

ModelPackageStatusDetails object

Details about the current status of the model package.

ValidationStatuses ModelPackageStatusItem[] required
ImageScanStatuses ModelPackageStatusItem[]
ModelPackageStatusItem object

Represents the overall status of a model package.

Name string | Aws_CF_FunctionString required

The name of the model package for which the overall status is being reported.

Status string | Aws_CF_FunctionString required

The current status.

FailureReason string | Aws_CF_FunctionString

If the overall status is Failed, the reason for the failure.

ModelPackageVersion integer

The version of the model package.

Task string | Aws_CF_FunctionString

The machine learning task your model package accomplishes.