@propulsionworks/cloudformation 0.0.1 → 0.1.0

package/out/exports/resources.generated/aws-sagemaker-modelpackage.d.ts

@@ -0,0 +1,916 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type SageMakerModelPackage = ResourceDefinitionWithAttributes<"AWS::SageMaker::ModelPackage", SageMakerModelPackageProps, SageMakerModelPackageAttribs>;
+/**
+ * A container for your trained model that can be deployed for SageMaker inference. This can include inference code, artifacts, and metadata. The model package type can be one of the following.
+ *
+ * - Versioned model: A part of a model package group in Model Registry.
+ * - Unversioned model: Not part of a model package group and used in AWS Marketplace.
+ *
+ * For more information, see [`CreateModelPackage`](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModelPackage.html) .
+ */
+export type SageMakerModelPackageProps = {
+    /**
+     * An array of additional Inference Specification objects.
+     */
+    AdditionalInferenceSpecifications?: AdditionalInferenceSpecificationDefinition[] | undefined;
+    /**
+     * An array of additional Inference Specification objects to be added to the existing array. 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.
+     */
+    AdditionalInferenceSpecificationsToAdd?: AdditionalInferenceSpecificationDefinition[] | undefined;
+    /**
+     * A description provided when the model approval is set.
+     */
+    ApprovalDescription?: string | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-mkt-list.html) .
+     */
+    CertifyForMarketplace?: boolean | undefined;
+    /**
+     * A unique token that guarantees that the call to this API is idempotent.
+     */
+    ClientToken?: string | undefined;
+    /**
+     * The metadata properties for the model package.
+     */
+    CustomerMetadataProperties?: Record<string, string> | undefined;
+    /**
+     * The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.
+     */
+    Domain?: string | undefined;
+    /**
+     * Represents the drift check baselines that can be used when the model monitor is set using the model package.
+     */
+    DriftCheckBaselines?: DriftCheckBaselines | undefined;
+    /**
+     * Defines how to perform inference generation after a training job is run.
+     */
+    InferenceSpecification?: InferenceSpecification | undefined;
+    /**
+     * The last time the model package was modified.
+     */
+    LastModifiedTime?: string | undefined;
+    /**
+     * Metadata properties of the tracking entity, trial, or trial component.
+     */
+    MetadataProperties?: MetadataProperties | undefined;
+    /**
+     * 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.
+     */
+    ModelApprovalStatus?: ModelApprovalStatus | undefined;
+    /**
+     * An Amazon SageMaker Model Card.
+     */
+    ModelCard?: ModelCard | undefined;
+    /**
+     * Metrics for the model.
+     */
+    ModelMetrics?: ModelMetrics | undefined;
+    /**
+     * The description of the model package.
+     */
+    ModelPackageDescription?: string | undefined;
+    /**
+     * The model group to which the model belongs.
+     */
+    ModelPackageGroupName?: string | undefined;
+    /**
+     * 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.
+     */
+    ModelPackageName?: string | undefined;
+    /**
+     * Specifies the validation and image scan statuses of the model package.
+     */
+    ModelPackageStatusDetails?: ModelPackageStatusDetails | undefined;
+    /**
+     * The version number of a versioned model.
+     */
+    ModelPackageVersion?: number | undefined;
+    /**
+     * 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).
+     */
+    SamplePayloadUrl?: string | undefined;
+    /**
+     * An optional AWS Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.
+     */
+    SecurityConfig?: SecurityConfig | undefined;
+    /**
+     * Indicates if you want to skip model validation.
+     */
+    SkipModelValidation?: SkipModelValidation | undefined;
+    /**
+     * A list of algorithms that were used to create a model package.
+     */
+    SourceAlgorithmSpecification?: SourceAlgorithmSpecification | undefined;
+    /**
+     * The URI of the source for the model package.
+     */
+    SourceUri?: string | undefined;
+    /**
+     * A list of the tags associated with the model package. For more information, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *AWS General Reference Guide* .
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.
+     */
+    Task?: string | undefined;
+    /**
+     * Specifies batch transform jobs that SageMaker runs to validate your model package.
+     */
+    ValidationSpecification?: ValidationSpecification | undefined;
+};
+export type SageMakerModelPackageAttribs = {
+    /**
+     * The time that the model package was created.
+     */
+    CreationTime: string;
+    /**
+     * The Amazon Resource Name (ARN) of the model package.
+     */
+    ModelPackageArn: string;
+    /**
+     * The status of the model package. This can be one of the following values.
+     *
+     * - `PENDING` - The model package creation is pending.
+     * - `IN_PROGRESS` - The model package is in the process of being created.
+     * - `COMPLETED` - The model package was successfully created.
+     * - `FAILED` - The model package creation failed.
+     * - `DELETING` - The model package is in the process of being deleted.
+     */
+    ModelPackageStatus: ModelPackageStatus;
+};
+/**
+ * A structure of additional Inference Specification. Additional Inference Specification specifies details about inference jobs that can be run with models based on this model package
+ */
+export type AdditionalInferenceSpecificationDefinition = {
+    /**
+     * The Amazon ECR registry path of the Docker image that contains the inference code.
+     */
+    Containers: ModelPackageContainerDefinition[];
+    /**
+     * A description of the additional Inference specification
+     * @maxLength 1024
+     * @pattern .*
+     */
+    Description?: string | undefined;
+    /**
+     * 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.
+     * @minLength 1
+     * @maxLength 63
+     * @pattern ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$
+     */
+    Name: string;
+    /**
+     * The supported MIME types for the input data.
+     */
+    SupportedContentTypes?: string[] | undefined;
+    /**
+     * A list of the instance types that are used to generate inferences in real-time.
+     */
+    SupportedRealtimeInferenceInstanceTypes?: string[] | undefined;
+    /**
+     * The supported MIME types for the output data.
+     */
+    SupportedResponseMIMETypes?: string[] | undefined;
+    /**
+     * A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.
+     */
+    SupportedTransformInstanceTypes?: string[] | undefined;
+};
+/**
+ * Contains bias metrics for a model.
+ */
+export type Bias = {
+    /**
+     * The post-training bias report for a model.
+     */
+    PostTrainingReport?: MetricsSource | undefined;
+    /**
+     * The pre-training bias report for a model.
+     */
+    PreTrainingReport?: MetricsSource | undefined;
+    /**
+     * The bias report for a model
+     */
+    Report?: MetricsSource | undefined;
+};
+/**
+ * Describes the location of the channel data.
+ */
+export type DataSource = {
+    /**
+     * The S3 location of the data source that is associated with a channel.
+     */
+    S3DataSource: S3DataSource;
+};
+/**
+ * Represents the drift check baselines that can be used when the model monitor is set using the model package.
+ */
+export type DriftCheckBaselines = {
+    /**
+     * Represents the drift check bias baselines that can be used when the model monitor is set using the model package.
+     */
+    Bias?: DriftCheckBias | undefined;
+    /**
+     * Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.
+     */
+    Explainability?: DriftCheckExplainability | undefined;
+    /**
+     * Represents the drift check model data quality baselines that can be used when the model monitor is set using the model package.
+     */
+    ModelDataQuality?: DriftCheckModelDataQuality | undefined;
+    /**
+     * Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.
+     */
+    ModelQuality?: DriftCheckModelQuality | undefined;
+};
+/**
+ * Represents the drift check bias baselines that can be used when the model monitor is set using the model package.
+ */
+export type DriftCheckBias = {
+    /**
+     * The bias config file for a model.
+     */
+    ConfigFile?: FileSource | undefined;
+    /**
+     * The post-training constraints.
+     */
+    PostTrainingConstraints?: MetricsSource | undefined;
+    /**
+     * The pre-training constraints.
+     */
+    PreTrainingConstraints?: MetricsSource | undefined;
+};
+/**
+ * Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.
+ */
+export type DriftCheckExplainability = {
+    /**
+     * The explainability config file for the model.
+     */
+    ConfigFile?: FileSource | undefined;
+    /**
+     * The drift check explainability constraints.
+     */
+    Constraints?: MetricsSource | undefined;
+};
+/**
+ * Represents the drift check data quality baselines that can be used when the model monitor is set using the model package.
+ */
+export type DriftCheckModelDataQuality = {
+    /**
+     * The drift check model data quality constraints.
+     */
+    Constraints?: MetricsSource | undefined;
+    /**
+     * The drift check model data quality statistics.
+     */
+    Statistics?: MetricsSource | undefined;
+};
+/**
+ * Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.
+ */
+export type DriftCheckModelQuality = {
+    /**
+     * The drift check model quality constraints.
+     */
+    Constraints?: MetricsSource | undefined;
+    /**
+     * The drift check model quality statistics.
+     */
+    Statistics?: MetricsSource | undefined;
+};
+/**
+ * Contains explainability metrics for a model.
+ */
+export type Explainability = {
+    /**
+     * The explainability report for a model.
+     */
+    Report?: MetricsSource | undefined;
+};
+/**
+ * Contains details regarding the file source.
+ */
+export type FileSource = {
+    /**
+     * The digest of the file source.
+     * @maxLength 72
+     * @pattern ^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$
+     */
+    ContentDigest?: string | undefined;
+    /**
+     * The type of content stored in the file source.
+     * @maxLength 256
+     * @pattern .*
+     */
+    ContentType?: string | undefined;
+    /**
+     * The Amazon S3 URI for the file source.
+     * @maxLength 1024
+     * @pattern ^(https|s3)://([^/]+)/?(.*)$
+     */
+    S3Uri: string;
+};
+/**
+ * Defines how to perform inference generation after a training job is run.
+ */
+export type InferenceSpecification = {
+    /**
+     * The Amazon ECR registry path of the Docker image that contains the inference code.
+     */
+    Containers: ModelPackageContainerDefinition[];
+    /**
+     * The supported MIME types for the input data.
+     */
+    SupportedContentTypes: string[];
+    /**
+     * A list of the instance types that are used to generate inferences in real-time.
+     *
+     * This parameter is required for unversioned models, and optional for versioned models.
+     */
+    SupportedRealtimeInferenceInstanceTypes?: string[] | undefined;
+    /**
+     * The supported MIME types for the output data.
+     */
+    SupportedResponseMIMETypes: string[];
+    /**
+     * A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.
+     *
+     * This parameter is required for unversioned models, and optional for versioned models.
+     */
+    SupportedTransformInstanceTypes?: string[] | undefined;
+};
+/**
+ * Metadata properties of the tracking entity, trial, or trial component.
+ */
+export type MetadataProperties = {
+    /**
+     * The commit ID.
+     * @maxLength 1024
+     * @pattern .*
+     */
+    CommitId?: string | undefined;
+    /**
+     * The entity this entity was generated by.
+     * @maxLength 1024
+     * @pattern .*
+     */
+    GeneratedBy?: string | undefined;
+    /**
+     * The project ID.
+     * @maxLength 1024
+     * @pattern .*
+     */
+    ProjectId?: string | undefined;
+    /**
+     * The repository.
+     * @maxLength 1024
+     * @pattern .*
+     */
+    Repository?: string | undefined;
+};
+/**
+ * Details about the metrics source.
+ */
+export type MetricsSource = {
+    /**
+     * The hash key used for the metrics source.
+     * @maxLength 72
+     * @pattern ^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$
+     */
+    ContentDigest?: string | undefined;
+    /**
+     * The metric source content type.
+     * @maxLength 256
+     * @pattern .*
+     */
+    ContentType: string;
+    /**
+     * The S3 URI for the metrics source.
+     * @maxLength 1024
+     * @pattern ^(https|s3)://([^/]+)/?(.*)$
+     */
+    S3Uri: string;
+};
+/**
+ * The access configuration file to control access to the ML model. You can explicitly accept the model end-user license agreement (EULA) within the `ModelAccessConfig` .
+ *
+ * - If you are a Jumpstart user, see the [End-user license agreements](https://docs.aws.amazon.com/sagemaker/latest/dg/jumpstart-foundation-models-choose.html#jumpstart-foundation-models-choose-eula) section for more details on accepting the EULA.
+ * - If you are an AutoML user, see the *Optional Parameters* section of *Create an AutoML job to fine-tune text generation models using the API* for details on [How to set the EULA acceptance when fine-tuning a model using the AutoML API](https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-create-experiment-finetune-llms.html#autopilot-llms-finetuning-api-optional-params) .
+ */
+export type ModelAccessConfig = {
+    /**
+     * Specifies agreement to the model end-user license agreement (EULA). The `AcceptEula` value must be explicitly defined as `True` in order to accept the EULA that this model requires. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.
+     */
+    AcceptEula: boolean;
+};
+/**
+ * The approval status of the model package.
+ */
+export type ModelApprovalStatus = "Approved" | "Rejected" | "PendingManualApproval";
+/**
+ * An Amazon SageMaker Model Card.
+ */
+export type ModelCard = {
+    /**
+     * The content of the model card.
+     * @minLength 0
+     * @maxLength 100000
+     * @pattern .*
+     */
+    ModelCardContent: string;
+    /**
+     * The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
+     *
+     * - `Draft` : The model card is a work in progress.
+     * - `PendingReview` : The model card is pending review.
+     * - `Approved` : The model card is approved.
+     * - `Archived` : The model card is archived. No more updates should be made to the model card, but it can still be exported.
+     */
+    ModelCardStatus: "Draft" | "PendingReview" | "Approved" | "Archived";
+};
+/**
+ * Data quality constraints and statistics for a model.
+ */
+export type ModelDataQuality = {
+    /**
+     * Data quality constraints for a model.
+     */
+    Constraints?: MetricsSource | undefined;
+    /**
+     * Data quality statistics for a model.
+     */
+    Statistics?: MetricsSource | undefined;
+};
+/**
+ * Specifies the location of ML model data to deploy. If specified, you must specify one and only one of the available data sources.
+ */
+export type ModelDataSource = {
+    /**
+     * Specifies the S3 location of ML model data to deploy.
+     */
+    S3DataSource?: S3ModelDataSource | undefined;
+};
+/**
+ * Contains metrics captured from a model.
+ */
+export type ModelMetrics = {
+    /**
+     * Metrics that measure bias in a model.
+     */
+    Bias?: Bias | undefined;
+    /**
+     * Metrics that help explain a model.
+     */
+    Explainability?: Explainability | undefined;
+    /**
+     * Metrics that measure the quality of the input data for a model.
+     */
+    ModelDataQuality?: ModelDataQuality | undefined;
+    /**
+     * Metrics that measure the quality of a model.
+     */
+    ModelQuality?: ModelQuality | undefined;
+};
+/**
+ * Describes the Docker container for the model package.
+ */
+export type ModelPackageContainerDefinition = {
+    /**
+     * The DNS host name for the Docker container.
+     * @maxLength 63
+     * @pattern ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}
+     */
+    ContainerHostname?: string | undefined;
+    /**
+     * The environment variables to set in the Docker container. Each key and value in the `Environment` string to string map can have length of up to 1024. We support up to 16 entries in the map.
+     */
+    Environment?: Record<string, string> | undefined;
+    /**
+     * The machine learning framework of the model package container image.
+     */
+    Framework?: string | undefined;
+    /**
+     * The framework version of the Model Package Container Image.
+     * @minLength 3
+     * @maxLength 10
+     * @pattern [0-9]\.[A-Za-z0-9.]+
+     */
+    FrameworkVersion?: string | undefined;
+    /**
+     * The Amazon Elastic Container Registry (Amazon ECR) path where inference code is stored.
+     *
+     * If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both `registry/repository[:tag]` and `registry/repository[@digest]` image path formats. For more information, see [Using Your Own Algorithms with Amazon SageMaker](https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html) .
+     * @minLength 1
+     * @maxLength 255
+     * @pattern [\S]{1,255}
+     */
+    Image: string;
+    /**
+     * An MD5 hash of the training algorithm that identifies the Docker image used for training.
+     * @maxLength 72
+     * @pattern ^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$
+     */
+    ImageDigest?: string | undefined;
+    /**
+     * Specifies the location of ML model data to deploy during endpoint creation.
+     */
+    ModelDataSource?: ModelDataSource | undefined;
+    /**
+     * 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).
+     *
+     * > The model artifacts must be in an S3 bucket that is in the same region as the model package.
+     * @maxLength 1024
+     * @pattern ^(https|s3)://([^/]+)/?(.*)$
+     */
+    ModelDataUrl?: string | undefined;
+    /**
+     * A structure with Model Input details.
+     */
+    ModelInput?: {
+        /**
+         * The input configuration object for the model.
+         * @minLength 1
+         * @maxLength 1024
+         * @pattern [\S\s]+
+         */
+        DataInputConfig: string;
+    } | undefined;
+    /**
+     * The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model. You can find a list of benchmarked models by calling `ListModelMetadata` .
+     */
+    NearestModelName?: string | undefined;
+};
+/**
+ * The current status of the model package.
+ */
+export type ModelPackageStatus = "Pending" | "Deleting" | "InProgress" | "Completed" | "Failed";
+/**
+ * Specifies the validation and image scan statuses of the model package.
+ */
+export type ModelPackageStatusDetails = {
+    /**
+     * The validation status of the model package.
+     */
+    ValidationStatuses?: ModelPackageStatusItem[] | undefined;
+};
+/**
+ * Represents the overall status of a model package.
+ */
+export type ModelPackageStatusItem = {
+    /**
+     * if the overall status is `Failed` , the reason for the failure.
+     */
+    FailureReason?: string | undefined;
+    /**
+     * The name of the model package for which the overall status is being reported.
+     * @minLength 1
+     * @maxLength 63
+     * @pattern ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$
+     */
+    Name: string;
+    /**
+     * The current status.
+     */
+    Status: "NotStarted" | "Failed" | "InProgress" | "Completed";
+};
+/**
+ * Model quality statistics and constraints.
+ */
+export type ModelQuality = {
+    /**
+     * Model quality constraints.
+     */
+    Constraints?: MetricsSource | undefined;
+    /**
+     * Model quality statistics.
+     */
+    Statistics?: MetricsSource | undefined;
+};
+/**
+ * Describes the S3 data source.
+ *
+ * Your input bucket must be in the same AWS region as your training job.
+ */
+export type S3DataSource = {
+    /**
+     * If you choose `S3Prefix` , `S3Uri` identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix for model training.
+     *
+     * If you choose `ManifestFile` , `S3Uri` identifies an object that is a manifest file containing a list of object keys that you want SageMaker to use for model training.
+     *
+     * If you choose `AugmentedManifestFile` , `S3Uri` identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. `AugmentedManifestFile` can only be used if the Channel's input mode is `Pipe` .
+     */
+    S3DataType: "ManifestFile" | "S3Prefix" | "AugmentedManifestFile";
+    /**
+     * Depending on the value specified for the `S3DataType` , identifies either a key name prefix or a manifest. For example:
+     *
+     * - A key name prefix might look like this: `s3://bucketname/exampleprefix/`
+     * - A manifest might look like this: `s3://bucketname/example.manifest`
+     *
+     * A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of `S3Uri` . Note that the prefix must be a valid non-empty `S3Uri` that precludes users from specifying a manifest whose individual `S3Uri` is sourced from different S3 buckets.
+     *
+     * The following code example shows a valid manifest format:
+     *
+     * `[ {"prefix": "s3://customer_bucket/some/prefix/"},`
+     *
+     * `"relative/path/to/custdata-1",`
+     *
+     * `"relative/path/custdata-2",`
+     *
+     * `...`
+     *
+     * `"relative/path/custdata-N"`
+     *
+     * `]`
+     *
+     * This JSON is equivalent to the following `S3Uri` list:
+     *
+     * `s3://customer_bucket/some/prefix/relative/path/to/custdata-1`
+     *
+     * `s3://customer_bucket/some/prefix/relative/path/custdata-2`
+     *
+     * `...`
+     *
+     * `s3://customer_bucket/some/prefix/relative/path/custdata-N`
+     *
+     * The complete set of `S3Uri` in this manifest is the input data for the channel for this data source. The object that each `S3Uri` points to must be readable by the IAM role that SageMaker uses to perform tasks on your behalf.
+     *
+     * Your input bucket must be located in same AWS region as your training job.
+     * @maxLength 1024
+     * @pattern ^(https|s3)://([^/]+)/?(.*)$
+     */
+    S3Uri: string;
+};
+/**
+ * Specifies the S3 location of ML model data to deploy.
+ */
+export type S3ModelDataSource = {
+    /**
+     * Specifies how the ML model data is prepared.
+     *
+     * If you choose `Gzip` and choose `S3Object` as the value of `S3DataType` , `S3Uri` identifies an object that is a gzip-compressed TAR archive. SageMaker will attempt to decompress and untar the object during model deployment.
+     *
+     * If you choose `None` and chooose `S3Object` as the value of `S3DataType` , `S3Uri` identifies an object that represents an uncompressed ML model to deploy.
+     *
+     * If you choose None and choose `S3Prefix` as the value of `S3DataType` , `S3Uri` identifies a key name prefix, under which all objects represents the uncompressed ML model to deploy.
+     *
+     * If you choose None, then SageMaker will follow rules below when creating model data files under /opt/ml/model directory for use by your inference code:
+     *
+     * - If you choose `S3Object` as the value of `S3DataType` , then SageMaker will split the key of the S3 object referenced by `S3Uri` by slash (/), and use the last part as the filename of the file holding the content of the S3 object.
+     * - If you choose `S3Prefix` as the value of `S3DataType` , then for each S3 object under the key name pefix referenced by `S3Uri` , SageMaker will trim its key by the prefix, and use the remainder as the path (relative to `/opt/ml/model` ) of the file holding the content of the S3 object. SageMaker will split the remainder by slash (/), using intermediate parts as directory names and the last part as filename of the file holding the content of the S3 object.
+     * - Do not use any of the following as file names or directory names:
+     *
+     * - An empty or blank string
+     * - A string which contains null bytes
+     * - A string longer than 255 bytes
+     * - A single dot ( `.` )
+     * - A double dot ( `..` )
+     * - Ambiguous file names will result in model deployment failure. For example, if your uncompressed ML model consists of two S3 objects `s3://mybucket/model/weights` and `s3://mybucket/model/weights/part1` and you specify `s3://mybucket/model/` as the value of `S3Uri` and `S3Prefix` as the value of `S3DataType` , then it will result in name clash between `/opt/ml/model/weights` (a regular file) and `/opt/ml/model/weights/` (a directory).
+     * - Do not organize the model artifacts in [S3 console using folders](https://docs.aws.amazon.com//AmazonS3/latest/userguide/using-folders.html) . When you create a folder in S3 console, S3 creates a 0-byte object with a key set to the folder name you provide. They key of the 0-byte object ends with a slash (/) which violates SageMaker restrictions on model artifact file names, leading to model deployment failure.
+     */
+    CompressionType: "None" | "Gzip";
+    /**
+     * Specifies the access configuration file for the ML model. You can explicitly accept the model end-user license agreement (EULA) within the `ModelAccessConfig` . You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.
+     */
+    ModelAccessConfig?: ModelAccessConfig | undefined;
+    /**
+     * Specifies the type of ML model data to deploy.
+     *
+     * If you choose `S3Prefix` , `S3Uri` identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix as part of the ML model data to deploy. A valid key name prefix identified by `S3Uri` always ends with a forward slash (/).
+     *
+     * If you choose `S3Object` , `S3Uri` identifies an object that is the ML model data to deploy.
+     */
+    S3DataType: "S3Prefix" | "S3Object";
+    /**
+     * Specifies the S3 path of ML model data to deploy.
+     * @maxLength 1024
+     * @pattern ^(https|s3)://([^/]+)/?(.*)$
+     */
+    S3Uri: string;
+};
+/**
+ * An optional AWS Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.
+ */
+export type SecurityConfig = {
+    /**
+     * The AWS KMS Key ID (KMSKeyId) used for encryption of model package information.
+     * @maxLength 2048
+     * @pattern ^[a-zA-Z0-9:/_-]*$
+     */
+    KmsKeyId: string;
+};
+/**
+ * Indicates if you want to skip model validation.
+ */
+export type SkipModelValidation = "None" | "All";
+/**
+ * Specifies an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in AWS Marketplace that you are subscribed to.
+ */
+export type SourceAlgorithm = {
+    /**
+     * The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in AWS Marketplace that you are subscribed to.
+     * @minLength 1
+     * @maxLength 170
+     * @pattern (arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:[a-z\-]*\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(?<!-)$
+     */
+    AlgorithmName: string;
+    /**
+     * 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).
+     *
+     * > The model artifacts must be in an S3 bucket that is in the same AWS region as the algorithm.
+     * @maxLength 1024
+     * @pattern ^(https|s3)://([^/]+)/?(.*)$
+     */
+    ModelDataUrl?: string | undefined;
+};
+/**
+ * A list of algorithms that were used to create a model package.
+ */
+export type SourceAlgorithmSpecification = {
+    /**
+     * A list of the algorithms that were used to create a model package.
+     */
+    SourceAlgorithms: SourceAlgorithm[];
+};
+/**
+ * Describes the input source of a transform job and the way the transform job consumes it.
+ */
+export type TransformInput = {
+    /**
+     * 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` .
+     */
+    CompressionType?: "None" | "Gzip" | undefined;
+    /**
+     * 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.
+     * @maxLength 256
+     * @pattern .*
+     */
+    ContentType?: string | undefined;
+    /**
+     * Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.
+     */
+    DataSource: DataSource;
+    /**
+     * The method to use to split the transform job's data files into smaller batches. Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for `SplitType` is `None` , which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to `Line` to split records on a newline character boundary. `SplitType` also supports a number of record-oriented binary data formats. Currently, the supported record formats are:
+     *
+     * - RecordIO
+     * - TFRecord
+     *
+     * When splitting is enabled, the size of a mini-batch depends on the values of the `BatchStrategy` and `MaxPayloadInMB` parameters. When the value of `BatchStrategy` is `MultiRecord` , Amazon SageMaker sends the maximum number of records in each request, up to the `MaxPayloadInMB` limit. If the value of `BatchStrategy` is `SingleRecord` , Amazon SageMaker sends individual records in each request.
+     *
+     * > Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of `BatchStrategy` is set to `SingleRecord` . Padding is not removed if the value of `BatchStrategy` is set to `MultiRecord` .
+     * >
+     * > For more information about `RecordIO` , see [Create a Dataset Using RecordIO](https://docs.aws.amazon.com/https://mxnet.apache.org/api/faq/recordio) in the MXNet documentation. For more information about `TFRecord` , see [Consuming TFRecord data](https://docs.aws.amazon.com/https://www.tensorflow.org/guide/data#consuming_tfrecord_data) in the TensorFlow documentation.
+     */
+    SplitType?: "None" | "TFRecord" | "Line" | "RecordIO" | undefined;
+};
+/**
+ * Defines the input needed to run a transform job using the inference specification specified in the algorithm.
+ */
+export type TransformJobDefinition = {
+    /**
+     * A string that determines the number of records included in a single mini-batch.
+     *
+     * `SingleRecord` means only one record is used per mini-batch. `MultiRecord` means a mini-batch is set to contain as many records that can fit within the `MaxPayloadInMB` limit.
+     */
+    BatchStrategy?: "MultiRecord" | "SingleRecord" | undefined;
+    /**
+     * The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
+     */
+    Environment?: Record<string, string> | undefined;
+    /**
+     * The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.
+     * @min 0
+     */
+    MaxConcurrentTransforms?: number | undefined;
+    /**
+     * The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).
+     * @min 0
+     */
+    MaxPayloadInMB?: number | undefined;
+    /**
+     * A description of the input source and the way the transform job consumes it.
+     */
+    TransformInput: TransformInput;
+    /**
+     * Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
+     */
+    TransformOutput: TransformOutput;
+    /**
+     * Identifies the ML compute instances for the transform job.
+     */
+    TransformResources: TransformResources;
+};
+/**
+ * Describes the results of a transform job.
+ */
+export type TransformOutput = {
+    /**
+     * 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.
+     * @maxLength 256
+     * @pattern .*
+     */
+    Accept?: string | undefined;
+    /**
+     * Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify `None` . To add a newline character at the end of every transformed record, specify `Line` .
+     */
+    AssembleWith?: "None" | "Line" | undefined;
+    /**
+     * 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. The `KmsKeyId` can be any of the following formats:
+     *
+     * - Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+     * - Key ARN: `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+     * - Alias name: `alias/ExampleAlias`
+     * - Alias name ARN: `arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias`
+     *
+     * If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see [KMS-Managed Encryption Keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) in the *Amazon Simple Storage Service Developer Guide.*
+     *
+     * The KMS key policy must grant permission to the IAM role that you specify in your [CreateModel](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html) request. For more information, see [Using Key Policies in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) in the *AWS Key Management Service Developer Guide* .
+     * @maxLength 2048
+     * @pattern .*
+     */
+    KmsKeyId?: string | undefined;
+    /**
+     * The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, `s3://bucket-name/key-name-prefix` .
+     *
+     * For every S3 object used as input for the transform job, batch transform stores the transformed data with an . `out` suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at `s3://bucket-name/input-name-prefix/dataset01/data.csv` , batch transform stores the transformed data at `s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out` . Batch transform doesn't upload partially processed objects. For an input S3 object that contains multiple records, it creates an . `out` file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation.
+     * @maxLength 1024
+     * @pattern ^(https|s3)://([^/]+)/?(.*)$
+     */
+    S3OutputPath: string;
+};
+/**
+ * Describes the resources, including ML instance types and ML instance count, to use for transform job.
+ */
+export type TransformResources = {
+    /**
+     * The number of ML compute instances to use in the transform job. The default value is `1` , and the maximum is `100` . For distributed transform jobs, specify a value greater than `1` .
+     * @min 1
+     */
+    InstanceCount: number;
+    /**
+     * The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or `ml.m5.large` instance types.
+     */
+    InstanceType: string;
+    /**
+     * 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.
+     *
+     * > Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a `VolumeKmsKeyId` when using an instance type with local storage.
+     * >
+     * > For a list of instance types that support local instance storage, see [Instance Store Volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes) .
+     * >
+     * > For more information about local instance storage encryption, see [SSD Instance Store Volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html) .
+     *
+     * The `VolumeKmsKeyId` can be any of the following formats:
+     *
+     * - Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+     * - Key ARN: `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+     * - Alias name: `alias/ExampleAlias`
+     * - Alias name ARN: `arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias`
+     * @maxLength 2048
+     * @pattern .*
+     */
+    VolumeKmsKeyId?: string | undefined;
+};
+/**
+ * Contains data, such as the inputs and targeted instance types that are used in the process of validating the model package.
+ *
+ * The data provided in the validation profile is made available to your buyers on AWS Marketplace.
+ */
+export type ValidationProfile = {
+    /**
+     * The name of the profile for the model package.
+     * @minLength 1
+     * @maxLength 63
+     * @pattern ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$
+     */
+    ProfileName: string;
+    /**
+     * The `TransformJobDefinition` object that describes the transform job used for the validation of the model package.
+     */
+    TransformJobDefinition: TransformJobDefinition;
+};
+/**
+ * Specifies batch transform jobs that SageMaker runs to validate your model package.
+ */
+export type ValidationSpecification = {
+    /**
+     * An array of `ModelPackageValidationProfile` objects, each of which specifies a batch transform job that SageMaker runs to validate your model package.
+     */
+    ValidationProfiles: ValidationProfile[];
+    /**
+     * The IAM roles to be used for the validation of the model package.
+     * @minLength 20
+     * @maxLength 2048
+     * @pattern ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$
+     */
+    ValidationRole: string;
+};
+//# sourceMappingURL=aws-sagemaker-modelpackage.d.ts.map