/* eslint-disable */ /** * This file was automatically generated by json-schema-to-typescript. * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, * and run json-schema-to-typescript to regenerate this file. */ /** * An array of additional Inference Specification objects. * * @minItems 1 * @maxItems 15 */ export type AdditionalInferenceSpecifications = | [AdditionalInferenceSpecificationDefinition] | [AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition] | [ AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition ] | [ AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition ] | [ AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition ] | [ AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition ] | [ AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition ] | [ AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition ] | [ AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition ] | [ AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition ] | [ AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition ] | [ AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition ] | [ AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition ] | [ AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition ] | [ AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition, AdditionalInferenceSpecificationDefinition ]; /** * The supported MIME type for the input data. */ export type ContentType = string; /** * Instance type that is used to generate inferences in real-time */ export type InferenceInstanceType = string; /** * The supported MIME types for the output data. */ export type ResponseMIMEType = string; /** * Instance types on which a transformation job can be run or on which an endpoint can be deployed. */ export type TransformInstanceType = string; /** * Whether to certify the model package for listing on AWS Marketplace. */ export type CertifyForMarketplace = boolean; /** * A unique token that guarantees that the call to this API is idempotent. */ export type ClientToken = string; /** * The machine learning domain of the model package you specified. */ export type Domain = string; /** * The approval status of the model package. */ export type ModelApprovalStatus = "Approved" | "Rejected" | "PendingManualApproval"; /** * The description of the model package. */ export type ModelPackageDescription = string; /** * The name of the model package group. */ export type ModelPackageGroupName = string; /** * The name or arn of the model package. */ export type ModelPackageName = string; /** * The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored pointing to single gzip compressed tar archive. */ export type SamplePayloadUrl = string; /** * The machine learning task your model package accomplishes. */ export type Task = string; /** * The Amazon Resource Name (ARN) of the model package group. */ export type ModelPackageArn = string; /** * A description provided for the model approval. */ export type ApprovalDescription = string; /** * The time at which the model package was created. */ export type CreationTime = string; /** * The time at which the model package was last modified. */ export type LastModifiedTime = string; /** * The current status of the model package. */ export type ModelPackageStatus = "Pending" | "Deleting" | "InProgress" | "Completed" | "Failed"; /** * The version of the model package. */ export type ModelPackageVersion = number; /** * Resource Type definition for AWS::SageMaker::ModelPackage */ export interface AwsSagemakerModelpackage { /** * An array of key-value pairs to apply to this resource. * * @maxItems 50 */ Tags?: Tag[]; AdditionalInferenceSpecifications?: AdditionalInferenceSpecifications; AdditionalInferenceSpecificationDefinition?: AdditionalInferenceSpecificationDefinition; CertifyForMarketplace?: CertifyForMarketplace; ClientToken?: ClientToken; CustomerMetadataProperties?: CustomerMetadataProperties; Domain?: Domain; DriftCheckBaselines?: DriftCheckBaselines; InferenceSpecification?: InferenceSpecification; MetadataProperties?: MetadataProperties; ModelApprovalStatus?: ModelApprovalStatus; ModelMetrics?: ModelMetrics; ModelPackageDescription?: ModelPackageDescription; ModelPackageGroupName?: ModelPackageGroupName; ModelPackageName?: ModelPackageName; SamplePayloadUrl?: SamplePayloadUrl; SourceAlgorithmSpecification?: SourceAlgorithmSpecification; Task?: Task; ValidationSpecification?: ValidationSpecification; ModelPackageArn?: ModelPackageArn; ApprovalDescription?: ApprovalDescription; CreationTime?: CreationTime; LastModifiedBy?: CreatedBy; LastModifiedTime?: LastModifiedTime; ModelPackageStatus?: ModelPackageStatus; ModelPackageVersion?: ModelPackageVersion; AdditionalInferenceSpecificationsToAdd?: AdditionalInferenceSpecifications; ModelPackageStatusDetails?: ModelPackageStatusDetails; ModelPackageStatusItem?: ModelPackageStatusItem; CreatedBy?: CreatedBy; Environment?: Environment; } /** * A key-value pair to associate with a resource. */ export interface Tag { /** * 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 -. */ Key: string; /** * 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 -. */ Value: string; } /** * 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. */ export interface AdditionalInferenceSpecificationDefinition { /** * The Amazon ECR registry path of the Docker image that contains the inference code. * * @minItems 1 * @maxItems 15 */ Containers: | [ModelPackageContainerDefinition] | [ModelPackageContainerDefinition, ModelPackageContainerDefinition] | [ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition] | [ ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition ] | [ ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition ] | [ ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition ] | [ ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition ] | [ ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition ] | [ ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition ] | [ ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition ] | [ ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition ] | [ ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition ] | [ ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition ] | [ ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition ] | [ ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition ]; /** * A description of the additional Inference specification. */ Description?: string; /** * 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. */ Name: string; /** * The supported MIME types for the input data. */ SupportedContentTypes?: ContentType[]; /** * A list of the instance types that are used to generate inferences in real-time */ SupportedRealtimeInferenceInstanceTypes?: InferenceInstanceType[]; /** * The supported MIME types for the output data. */ SupportedResponseMIMETypes?: ResponseMIMEType[]; /** * A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed. * * @minItems 1 */ SupportedTransformInstanceTypes?: [TransformInstanceType, ...TransformInstanceType[]]; } /** * Describes the Docker container for the model package. */ export interface ModelPackageContainerDefinition { /** * The DNS host name for the Docker container. */ ContainerHostname?: string; Environment?: Environment; ModelInput?: { /** * The input configuration object for the model. */ DataInputConfig: string; }; /** * The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored. */ Image: string; /** * An MD5 hash of the training algorithm that identifies the Docker image used for training. */ ImageDigest?: string; /** * A structure with Model Input details. */ ModelDataUrl?: string; /** * The AWS Marketplace product ID of the model package. */ ProductId?: string; /** * The machine learning framework of the model package container image. */ Framework?: string; /** * The framework version of the Model Package Container Image. */ FrameworkVersion?: string; /** * The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model. */ NearestModelName?: string; } /** * Sets the environment variables in the Docker container */ export interface Environment {} /** * The metadata properties associated with the model package versions. */ export interface CustomerMetadataProperties {} /** * Represents the drift check baselines that can be used when the model monitor is set using the model package. */ export interface DriftCheckBaselines { Bias?: DriftCheckBias; Explainability?: DriftCheckExplainability; ModelDataQuality?: DriftCheckModelDataQuality; ModelQuality?: DriftCheckModelQuality; } /** * Represents the drift check bias baselines that can be used when the model monitor is set using the model package. */ export interface DriftCheckBias { PostTrainingConstraints?: MetricsSource; PreTrainingConstraints?: MetricsSource; ConfigFile?: FileSource; } /** * Represents a Metric Source Object. */ export interface MetricsSource { /** * The digest of the metric source. */ ContentDigest?: string; /** * The type of content stored in the metric source. */ ContentType: string; /** * The Amazon S3 URI for the metric source. */ S3Uri: string; } /** * Represents a File Source Object. */ export interface FileSource { /** * The digest of the file source. */ ContentDigest?: string; /** * The type of content stored in the file source. */ ContentType?: string; /** * The Amazon S3 URI for the file source. */ S3Uri: string; } /** * Contains explainability metrics for a model. */ export interface DriftCheckExplainability { Constraints?: MetricsSource; ConfigFile?: FileSource; } /** * Represents the drift check data quality baselines that can be used when the model monitor is set using the model package. */ export interface DriftCheckModelDataQuality { Constraints?: MetricsSource; Statistics?: MetricsSource; } /** * Represents the drift check model quality baselines that can be used when the model monitor is set using the model package. */ export interface DriftCheckModelQuality { Constraints?: MetricsSource; Statistics?: MetricsSource; } /** * Details about inference jobs that can be run with models based on this model package. */ export interface InferenceSpecification { /** * The Amazon ECR registry path of the Docker image that contains the inference code. * * @minItems 1 * @maxItems 15 */ Containers: | [ModelPackageContainerDefinition] | [ModelPackageContainerDefinition, ModelPackageContainerDefinition] | [ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition] | [ ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition ] | [ ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition ] | [ ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition ] | [ ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition ] | [ ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition ] | [ ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition ] | [ ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition ] | [ ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition ] | [ ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition ] | [ ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition ] | [ ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition ] | [ ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition, ModelPackageContainerDefinition ]; /** * The supported MIME types for the input data. */ SupportedContentTypes: ContentType[]; /** * A list of the instance types that are used to generate inferences in real-time */ SupportedRealtimeInferenceInstanceTypes?: InferenceInstanceType[]; /** * The supported MIME types for the output data. */ SupportedResponseMIMETypes: ResponseMIMEType[]; /** * A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed. * * @minItems 1 */ SupportedTransformInstanceTypes?: [TransformInstanceType, ...TransformInstanceType[]]; } /** * Metadata properties of the tracking entity, trial, or trial component. */ export interface MetadataProperties { /** * The commit ID. */ CommitId?: string; /** * The entity this entity was generated by. */ GeneratedBy?: string; /** * The project ID metadata. */ ProjectId?: string; /** * The repository metadata. */ Repository?: string; } /** * A structure that contains model metrics reports. */ export interface ModelMetrics { Bias?: Bias; Explainability?: Explainability; ModelDataQuality?: ModelDataQuality; ModelQuality?: ModelQuality; } /** * Contains bias metrics for a model. */ export interface Bias { Report?: MetricsSource; PreTrainingReport?: MetricsSource; PostTrainingReport?: MetricsSource; } /** * Contains explainability metrics for a model. */ export interface Explainability { Report?: MetricsSource; } /** * Metrics that measure the quality of the input data for a model. */ export interface ModelDataQuality { Constraints?: MetricsSource; Statistics?: MetricsSource; } /** * Metrics that measure the quality of a model. */ export interface ModelQuality { Constraints?: MetricsSource; Statistics?: MetricsSource; } /** * Details about the algorithm that was used to create the model package. */ export interface SourceAlgorithmSpecification { /** * A list of algorithms that were used to create a model package. * * @minItems 1 * @maxItems 1 */ SourceAlgorithms: [SourceAlgorithm]; } /** * 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. */ export interface SourceAlgorithm { /** * 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. */ 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). */ ModelDataUrl?: string; } /** * Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package. */ export interface ValidationSpecification { /** * @minItems 1 * @maxItems 1 */ ValidationProfiles: [ValidationProfile]; /** * The IAM roles to be used for the validation of the model package. */ ValidationRole: string; } /** * Contains data, such as the inputs and targeted instance types that are used in the process of validating the model package. */ export interface ValidationProfile { TransformJobDefinition: TransformJobDefinition; /** * The name of the profile for the model package. */ ProfileName: string; } /** * Defines the input needed to run a transform job using the inference specification specified in the algorithm. */ export interface TransformJobDefinition { Environment?: Environment; /** * A string that determines the number of records included in a single mini-batch. */ BatchStrategy?: "MultiRecord" | "SingleRecord"; /** * The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1. */ MaxConcurrentTransforms?: number; /** * The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata). */ MaxPayloadInMB?: number; TransformInput: TransformInput; TransformOutput: TransformOutput; TransformResources: TransformResources; } /** * Describes the input source of a transform job and the way the transform job consumes it. */ export interface 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"; /** * 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. */ ContentType?: string; DataSource: DataSource; /** * The method to use to split the transform job's data files into smaller batches. */ SplitType?: "None" | "TFRecord" | "Line" | "RecordIO"; } /** * Describes the input source of a transform job and the way the transform job consumes it. */ export interface DataSource { S3DataSource: S3DataSource; } /** * Describes the S3 data source. */ export interface S3DataSource { /** * The S3 Data Source Type */ S3DataType: "ManifestFile" | "S3Prefix" | "AugmentedManifestFile"; /** * Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. */ S3Uri: string; } /** * Describes the results of a transform job. */ export interface 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. */ Accept?: string; /** * 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. */ KmsKeyId?: string; /** * The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. */ S3OutputPath: string; /** * Defines how to assemble the results of the transform job as a single S3 object. */ AssembleWith?: "None" | "Line"; } /** * Describes the resources, including ML instance types and ML instance count, to use for transform job. */ export interface TransformResources { /** * 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. */ InstanceCount: number; /** * The ML compute instance type for the transform job. */ 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. */ VolumeKmsKeyId?: string; } /** * Information about the user who created or modified an experiment, trial, trial component, lineage group, or project. */ export interface CreatedBy { /** * The domain associated with the user. */ DomainId?: string; /** * The Amazon Resource Name (ARN) of the user's profile. */ UserProfileArn?: string; /** * The name of the user's profile. */ UserProfileName?: string; } /** * Details about the current status of the model package. */ export interface ModelPackageStatusDetails { ImageScanStatuses?: ModelPackageStatusItem[]; ValidationStatuses: ModelPackageStatusItem[]; } /** * Represents the overall status of a model package. */ export interface ModelPackageStatusItem { /** * If the overall status is Failed, the reason for the failure. */ FailureReason?: string; /** * The name of the model package for which the overall status is being reported. */ Name: string; /** * The current status. */ Status: "NotStarted" | "Failed" | "InProgress" | "Completed"; }