@aws-sdk/client-sagemaker 3.609.0 → 3.613.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (91) hide show
  1. package/README.md +40 -0
  2. package/dist-cjs/index.js +4869 -4441
  3. package/dist-es/SageMaker.js +10 -0
  4. package/dist-es/commands/CreateOptimizationJobCommand.js +24 -0
  5. package/dist-es/commands/DeleteOptimizationJobCommand.js +24 -0
  6. package/dist-es/commands/DescribeModelPackageCommand.js +1 -1
  7. package/dist-es/commands/DescribeOptimizationJobCommand.js +24 -0
  8. package/dist-es/commands/ListOptimizationJobsCommand.js +24 -0
  9. package/dist-es/commands/StopOptimizationJobCommand.js +24 -0
  10. package/dist-es/commands/index.js +5 -0
  11. package/dist-es/models/models_0.js +4 -4
  12. package/dist-es/models/models_1.js +38 -0
  13. package/dist-es/models/models_2.js +0 -19
  14. package/dist-es/models/models_3.js +27 -17
  15. package/dist-es/models/models_4.js +22 -0
  16. package/dist-es/pagination/ListOptimizationJobsPaginator.js +4 -0
  17. package/dist-es/pagination/index.js +1 -0
  18. package/dist-es/protocols/Aws_json1_1.js +278 -0
  19. package/dist-types/SageMaker.d.ts +36 -0
  20. package/dist-types/SageMakerClient.d.ts +7 -2
  21. package/dist-types/commands/CreateAppCommand.d.ts +3 -2
  22. package/dist-types/commands/CreateClusterCommand.d.ts +2 -1
  23. package/dist-types/commands/CreateCodeRepositoryCommand.d.ts +1 -2
  24. package/dist-types/commands/CreateDomainCommand.d.ts +22 -18
  25. package/dist-types/commands/CreateModelCommand.d.ts +22 -0
  26. package/dist-types/commands/CreateOptimizationJobCommand.d.ts +124 -0
  27. package/dist-types/commands/CreatePresignedDomainUrlCommand.d.ts +15 -15
  28. package/dist-types/commands/CreateProcessingJobCommand.d.ts +1 -1
  29. package/dist-types/commands/CreateUserProfileCommand.d.ts +6 -6
  30. package/dist-types/commands/DeleteOptimizationJobCommand.d.ts +61 -0
  31. package/dist-types/commands/DeleteStudioLifecycleConfigCommand.d.ts +4 -1
  32. package/dist-types/commands/DeleteUserProfileCommand.d.ts +1 -1
  33. package/dist-types/commands/DescribeDomainCommand.d.ts +4 -0
  34. package/dist-types/commands/DescribeModelCardExportJobCommand.d.ts +2 -1
  35. package/dist-types/commands/DescribeModelCommand.d.ts +22 -0
  36. package/dist-types/commands/DescribeModelExplainabilityJobDefinitionCommand.d.ts +1 -1
  37. package/dist-types/commands/DescribeModelPackageCommand.d.ts +1 -1
  38. package/dist-types/commands/DescribeModelPackageGroupCommand.d.ts +1 -1
  39. package/dist-types/commands/DescribeModelQualityJobDefinitionCommand.d.ts +1 -1
  40. package/dist-types/commands/DescribeMonitoringScheduleCommand.d.ts +1 -2
  41. package/dist-types/commands/DescribeOptimizationJobCommand.d.ts +119 -0
  42. package/dist-types/commands/ListModelMetadataCommand.d.ts +1 -1
  43. package/dist-types/commands/ListModelPackageGroupsCommand.d.ts +1 -1
  44. package/dist-types/commands/ListModelPackagesCommand.d.ts +1 -1
  45. package/dist-types/commands/ListModelQualityJobDefinitionsCommand.d.ts +1 -1
  46. package/dist-types/commands/ListModelsCommand.d.ts +1 -2
  47. package/dist-types/commands/ListOptimizationJobsCommand.d.ts +85 -0
  48. package/dist-types/commands/ListStudioLifecycleConfigsCommand.d.ts +2 -1
  49. package/dist-types/commands/SearchCommand.d.ts +32 -0
  50. package/dist-types/commands/StopOptimizationJobCommand.d.ts +61 -0
  51. package/dist-types/commands/UpdateDomainCommand.d.ts +4 -0
  52. package/dist-types/commands/index.d.ts +5 -0
  53. package/dist-types/models/models_0.d.ts +69 -61
  54. package/dist-types/models/models_1.d.ts +421 -442
  55. package/dist-types/models/models_2.d.ts +436 -556
  56. package/dist-types/models/models_3.d.ts +5535 -5371
  57. package/dist-types/models/models_4.d.ts +740 -38
  58. package/dist-types/pagination/ListOptimizationJobsPaginator.d.ts +7 -0
  59. package/dist-types/pagination/index.d.ts +1 -0
  60. package/dist-types/protocols/Aws_json1_1.d.ts +45 -0
  61. package/dist-types/ts3.4/SageMaker.d.ts +86 -0
  62. package/dist-types/ts3.4/SageMakerClient.d.ts +30 -0
  63. package/dist-types/ts3.4/commands/CreateClusterCommand.d.ts +2 -4
  64. package/dist-types/ts3.4/commands/CreateCodeRepositoryCommand.d.ts +4 -2
  65. package/dist-types/ts3.4/commands/CreateOptimizationJobCommand.d.ts +40 -0
  66. package/dist-types/ts3.4/commands/CreateProcessingJobCommand.d.ts +1 -1
  67. package/dist-types/ts3.4/commands/DeleteOptimizationJobCommand.d.ts +35 -0
  68. package/dist-types/ts3.4/commands/DescribeModelCardExportJobCommand.d.ts +2 -4
  69. package/dist-types/ts3.4/commands/DescribeModelExplainabilityJobDefinitionCommand.d.ts +1 -1
  70. package/dist-types/ts3.4/commands/DescribeModelPackageCommand.d.ts +1 -1
  71. package/dist-types/ts3.4/commands/DescribeModelPackageGroupCommand.d.ts +1 -1
  72. package/dist-types/ts3.4/commands/DescribeModelQualityJobDefinitionCommand.d.ts +1 -1
  73. package/dist-types/ts3.4/commands/DescribeMonitoringScheduleCommand.d.ts +4 -2
  74. package/dist-types/ts3.4/commands/DescribeOptimizationJobCommand.d.ts +40 -0
  75. package/dist-types/ts3.4/commands/ListModelMetadataCommand.d.ts +1 -1
  76. package/dist-types/ts3.4/commands/ListModelPackageGroupsCommand.d.ts +1 -1
  77. package/dist-types/ts3.4/commands/ListModelPackagesCommand.d.ts +1 -1
  78. package/dist-types/ts3.4/commands/ListModelQualityJobDefinitionsCommand.d.ts +1 -1
  79. package/dist-types/ts3.4/commands/ListModelsCommand.d.ts +1 -2
  80. package/dist-types/ts3.4/commands/ListOptimizationJobsCommand.d.ts +40 -0
  81. package/dist-types/ts3.4/commands/StopOptimizationJobCommand.d.ts +35 -0
  82. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  83. package/dist-types/ts3.4/models/models_0.d.ts +14 -13
  84. package/dist-types/ts3.4/models/models_1.d.ts +109 -71
  85. package/dist-types/ts3.4/models/models_2.d.ts +81 -142
  86. package/dist-types/ts3.4/models/models_3.d.ts +192 -125
  87. package/dist-types/ts3.4/models/models_4.d.ts +170 -9
  88. package/dist-types/ts3.4/pagination/ListOptimizationJobsPaginator.d.ts +11 -0
  89. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  90. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +60 -0
  91. package/package.json +4 -4
@@ -1,5 +1,388 @@
1
- import { ActionSource, ActionStatus, AdditionalInferenceSpecificationDefinition, AlgorithmSpecification, AlgorithmStatus, AlgorithmStatusDetails, AlgorithmValidationSpecification, AppNetworkAccessType, AppSecurityGroupManagement, AppStatus, AppType, ArtifactSource, AsyncInferenceConfig, AuthMode, AutoMLCandidate, AutoMLChannel, AutoMLDataSplitConfig, AutoMLJobArtifacts, AutoMLJobChannel, AutoMLJobCompletionCriteria, AutoMLJobConfig, AutoMLJobObjective, AutoMLJobSecondaryStatus, AutoMLJobStatus, AutoMLOutputDataConfig, AutoMLPartialFailureReason, AutoMLProblemTypeConfig, AutoMLProblemTypeConfigName, AutoMLResolvedAttributes, AutoMLSecurityConfig, Autotune, BatchDataCaptureConfig, BatchStrategy, CaptureStatus, Channel, CheckpointConfig, ClusterInstanceGroupDetails, ClusterNodeDetails, ClusterStatus, CodeEditorAppImageConfig, CodeRepository, CognitoConfig, CognitoMemberDefinition, CollectionConfiguration, CompilationJobStatus, ContainerDefinition, ContextSource, GitConfig, HyperParameterTuningJobObjectiveType, InferenceSpecification, JupyterLabAppImageConfig, KernelGatewayImageConfig, MetadataProperties, ModelApprovalStatus, ModelDeployConfig, ModelPackageStatus, ObjectiveStatus, OutputDataConfig, ProblemType, ProductionVariantInstanceType, ResourceConfig, ResourceSpec, StoppingCondition, Tag, TrainingSpecification, TransformInput, TransformOutput, TransformResources, UserContext, VpcConfig } from "./models_0";
2
- import { DataCaptureConfig, DataQualityAppSpecification, DataQualityBaselineConfig, DataQualityJobInput, DefaultSpaceSettings, DeploymentConfig, DeviceSelectionConfig, DomainSettings, DriftCheckBaselines, EdgeDeploymentConfig, EdgeDeploymentModelConfig, EdgeOutputConfig, EdgePresetDeploymentType, EndpointInfo, ExperimentConfig, ExplainerConfig, FeatureDefinition, FeatureType, FlowDefinitionOutputConfig, HubS3StorageConfig, HumanLoopActivationConfig, HumanLoopConfig, HumanLoopRequestSource, HumanTaskConfig, HyperParameterTrainingJobDefinition, HyperParameterTuningJobConfig, HyperParameterTuningJobWarmStartConfig, InferenceComponentComputeResourceRequirements, InferenceComponentStartupParameters, InferenceExecutionConfig, InferenceExperimentDataStorageConfig, InferenceExperimentSchedule, InferenceExperimentType, InputConfig, JobType, JupyterServerAppSettings, KernelGatewayAppSettings, LabelingJobAlgorithmsConfig, LabelingJobInputConfig, LabelingJobOutputConfig, LabelingJobStoppingConditions, ModelBiasAppSpecification, ModelBiasBaselineConfig, ModelBiasJobInput, ModelCardExportOutputConfig, ModelCardSecurityConfig, ModelCardStatus, ModelExplainabilityAppSpecification, ModelExplainabilityBaselineConfig, ModelExplainabilityJobInput, ModelInfrastructureConfig, ModelMetrics, ModelPackageModelCard, ModelPackageSecurityConfig, ModelPackageValidationSpecification, ModelQualityAppSpecification, ModelQualityBaselineConfig, ModelQualityJobInput, MonitoringNetworkConfig, MonitoringOutputConfig, MonitoringResources, MonitoringStoppingCondition, NeoVpcConfig, OfflineStoreConfig, OnlineStoreConfig, OutputConfig, ProcessingInstanceType, Processor, ProductionVariant, ProductionVariantAcceleratorType, ProductionVariantManagedInstanceScaling, ProductionVariantRoutingConfig, ProductionVariantServerlessConfig, RecommendationJobInputConfig, RecommendationJobStoppingConditions, RecommendationJobType, RetryStrategy, ServiceCatalogProvisioningDetails, ShadowModeConfig, SkipModelValidation, SourceAlgorithmSpecification, ThroughputMode, TrackingServerSize, UserSettings, VendorGuidance } from "./models_1";
1
+ import { ActionSource, ActionStatus, AlgorithmSpecification, AlgorithmStatus, AlgorithmStatusDetails, AlgorithmValidationSpecification, AppNetworkAccessType, AppSecurityGroupManagement, AppSpecification, AppStatus, AppType, ArtifactSource, AsyncInferenceConfig, AuthMode, AutoMLCandidate, AutoMLChannel, AutoMLDataSplitConfig, AutoMLJobArtifacts, AutoMLJobChannel, AutoMLJobCompletionCriteria, AutoMLJobConfig, AutoMLJobObjective, AutoMLJobSecondaryStatus, AutoMLJobStatus, AutoMLOutputDataConfig, AutoMLPartialFailureReason, AutoMLProblemTypeConfig, AutoMLProblemTypeConfigName, AutoMLResolvedAttributes, AutoMLSecurityConfig, Autotune, BatchDataCaptureConfig, BatchStrategy, CaptureStatus, Channel, CheckpointConfig, ClusterInstanceGroupDetails, ClusterNodeDetails, ClusterStatus, CodeEditorAppImageConfig, CodeRepository, CognitoConfig, CognitoMemberDefinition, CollectionConfiguration, CompilationJobStatus, ContainerDefinition, ContextSource, GitConfig, HyperParameterTuningJobObjectiveType, InferenceSpecification, JupyterLabAppImageConfig, KernelGatewayImageConfig, MetadataProperties, ModelDeployConfig, ObjectiveStatus, OutputDataConfig, ProblemType, ProcessingS3DataDistributionType, ProcessingS3InputMode, ProductionVariantInstanceType, ResourceConfig, ResourceSpec, StoppingCondition, Tag, TrainingSpecification, TransformInput, TransformOutput, TransformResources, UserContext, VpcConfig } from "./models_0";
2
+ import { DataCaptureConfig, DataQualityAppSpecification, DataQualityBaselineConfig, DataQualityJobInput, DatasetDefinition, DefaultSpaceSettings, DeploymentConfig, DeviceSelectionConfig, DomainSettings, EdgeDeploymentConfig, EdgeDeploymentModelConfig, EdgeOutputConfig, EdgePresetDeploymentType, EndpointInfo, ExperimentConfig, ExplainerConfig, FeatureDefinition, FeatureType, FlowDefinitionOutputConfig, HubS3StorageConfig, HumanLoopActivationConfig, HumanLoopConfig, HumanLoopRequestSource, HumanTaskConfig, HyperParameterTrainingJobDefinition, HyperParameterTuningJobConfig, HyperParameterTuningJobWarmStartConfig, InferenceComponentComputeResourceRequirements, InferenceComponentStartupParameters, InferenceExecutionConfig, InferenceExperimentDataStorageConfig, InferenceExperimentSchedule, InferenceExperimentType, InputConfig, JobType, JupyterServerAppSettings, KernelGatewayAppSettings, LabelingJobAlgorithmsConfig, LabelingJobInputConfig, LabelingJobOutputConfig, LabelingJobStoppingConditions, ModelBiasAppSpecification, ModelBiasBaselineConfig, ModelBiasJobInput, ModelCardSecurityConfig, ModelCardStatus, ModelInfrastructureConfig, MonitoringNetworkConfig, MonitoringOutputConfig, MonitoringResources, MonitoringStoppingCondition, NeoVpcConfig, NetworkConfig, OfflineStoreConfig, OnlineStoreConfig, OutputConfig, ProcessingInstanceType, ProcessingS3CompressionType, ProcessingS3DataType, ProcessingS3UploadMode, Processor, ProductionVariant, ProductionVariantAcceleratorType, ProductionVariantManagedInstanceScaling, ProductionVariantRoutingConfig, ProductionVariantServerlessConfig, RecommendationJobInputConfig, RecommendationJobStoppingConditions, RecommendationJobType, RetryStrategy, ShadowModeConfig, ThroughputMode, TrackingServerSize, UserSettings, VendorGuidance } from "./models_1";
3
+ /**
4
+ * <p>Configuration for downloading input data from Amazon S3 into the processing container.</p>
5
+ * @public
6
+ */
7
+ export interface ProcessingS3Input {
8
+ /**
9
+ * <p>The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.</p>
10
+ * @public
11
+ */
12
+ S3Uri: string | undefined;
13
+ /**
14
+ * <p>The local path in your container where you want Amazon SageMaker to write input data to.
15
+ * <code>LocalPath</code> is an absolute path to the input data and must begin with
16
+ * <code>/opt/ml/processing/</code>. <code>LocalPath</code> is a required
17
+ * parameter when <code>AppManaged</code> is <code>False</code> (default).</p>
18
+ * @public
19
+ */
20
+ LocalPath?: string;
21
+ /**
22
+ * <p>Whether you use an <code>S3Prefix</code> or a <code>ManifestFile</code> for
23
+ * the data type. If you choose <code>S3Prefix</code>, <code>S3Uri</code> identifies a key
24
+ * name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing
25
+ * job. If you choose <code>ManifestFile</code>, <code>S3Uri</code> identifies an object
26
+ * that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for
27
+ * the processing job.</p>
28
+ * @public
29
+ */
30
+ S3DataType: ProcessingS3DataType | undefined;
31
+ /**
32
+ * <p>Whether to use <code>File</code> or <code>Pipe</code> input mode. In File mode, Amazon SageMaker copies the data
33
+ * from the input source onto the local ML storage volume before starting your processing
34
+ * container. This is the most commonly used input mode. In <code>Pipe</code> mode, Amazon SageMaker
35
+ * streams input data from the source directly to your processing container into named
36
+ * pipes without using the ML storage volume.</p>
37
+ * @public
38
+ */
39
+ S3InputMode?: ProcessingS3InputMode;
40
+ /**
41
+ * <p>Whether to distribute the data from Amazon S3 to all processing instances with
42
+ * <code>FullyReplicated</code>, or whether the data from Amazon S3 is shared by Amazon S3 key,
43
+ * downloading one shard of data to each processing instance.</p>
44
+ * @public
45
+ */
46
+ S3DataDistributionType?: ProcessingS3DataDistributionType;
47
+ /**
48
+ * <p>Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing
49
+ * container. <code>Gzip</code> can only be used when <code>Pipe</code> mode is
50
+ * specified as the <code>S3InputMode</code>. In <code>Pipe</code> mode, Amazon SageMaker streams input
51
+ * data from the source directly to your container without using the EBS volume.</p>
52
+ * @public
53
+ */
54
+ S3CompressionType?: ProcessingS3CompressionType;
55
+ }
56
+ /**
57
+ * <p>The inputs for a processing job. The processing input must specify exactly one of either
58
+ * <code>S3Input</code> or <code>DatasetDefinition</code> types.</p>
59
+ * @public
60
+ */
61
+ export interface ProcessingInput {
62
+ /**
63
+ * <p>The name for the processing job input.</p>
64
+ * @public
65
+ */
66
+ InputName: string | undefined;
67
+ /**
68
+ * <p>When <code>True</code>, input operations such as data download are managed natively by the
69
+ * processing job application. When <code>False</code> (default), input operations are managed by Amazon SageMaker.</p>
70
+ * @public
71
+ */
72
+ AppManaged?: boolean;
73
+ /**
74
+ * <p>Configuration for downloading input data from Amazon S3 into the processing container.</p>
75
+ * @public
76
+ */
77
+ S3Input?: ProcessingS3Input;
78
+ /**
79
+ * <p>Configuration for a Dataset Definition input. </p>
80
+ * @public
81
+ */
82
+ DatasetDefinition?: DatasetDefinition;
83
+ }
84
+ /**
85
+ * <p>Configuration for processing job outputs in Amazon SageMaker Feature Store.</p>
86
+ * @public
87
+ */
88
+ export interface ProcessingFeatureStoreOutput {
89
+ /**
90
+ * <p>The name of the Amazon SageMaker FeatureGroup to use as the destination for processing job output. Note that your
91
+ * processing script is responsible for putting records into your Feature Store.</p>
92
+ * @public
93
+ */
94
+ FeatureGroupName: string | undefined;
95
+ }
96
+ /**
97
+ * <p>Configuration for uploading output data to Amazon S3 from the processing container.</p>
98
+ * @public
99
+ */
100
+ export interface ProcessingS3Output {
101
+ /**
102
+ * <p>A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of
103
+ * a processing job.</p>
104
+ * @public
105
+ */
106
+ S3Uri: string | undefined;
107
+ /**
108
+ * <p>The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3.
109
+ * <code>LocalPath</code> is an absolute path to a directory containing output files.
110
+ * This directory will be created by the platform and exist when your container's
111
+ * entrypoint is invoked.</p>
112
+ * @public
113
+ */
114
+ LocalPath: string | undefined;
115
+ /**
116
+ * <p>Whether to upload the results of the processing job continuously or after the job
117
+ * completes.</p>
118
+ * @public
119
+ */
120
+ S3UploadMode: ProcessingS3UploadMode | undefined;
121
+ }
122
+ /**
123
+ * <p>Describes the results of a processing job. The processing output must specify exactly one of
124
+ * either <code>S3Output</code> or <code>FeatureStoreOutput</code> types.</p>
125
+ * @public
126
+ */
127
+ export interface ProcessingOutput {
128
+ /**
129
+ * <p>The name for the processing job output.</p>
130
+ * @public
131
+ */
132
+ OutputName: string | undefined;
133
+ /**
134
+ * <p>Configuration for processing job outputs in Amazon S3.</p>
135
+ * @public
136
+ */
137
+ S3Output?: ProcessingS3Output;
138
+ /**
139
+ * <p>Configuration for processing job outputs in Amazon SageMaker Feature Store. This processing output
140
+ * type is only supported when <code>AppManaged</code> is specified. </p>
141
+ * @public
142
+ */
143
+ FeatureStoreOutput?: ProcessingFeatureStoreOutput;
144
+ /**
145
+ * <p>When <code>True</code>, output operations such as data upload are managed natively by the
146
+ * processing job application. When <code>False</code> (default), output operations are managed by
147
+ * Amazon SageMaker.</p>
148
+ * @public
149
+ */
150
+ AppManaged?: boolean;
151
+ }
152
+ /**
153
+ * <p>Configuration for uploading output from the processing container.</p>
154
+ * @public
155
+ */
156
+ export interface ProcessingOutputConfig {
157
+ /**
158
+ * <p>An array of outputs configuring the data to upload from the processing container.</p>
159
+ * @public
160
+ */
161
+ Outputs: ProcessingOutput[] | undefined;
162
+ /**
163
+ * <p>The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the processing
164
+ * job output. <code>KmsKeyId</code> can be an ID of a KMS key, ARN of a KMS key, alias of
165
+ * a KMS key, or alias of a KMS key. The <code>KmsKeyId</code> is applied to all
166
+ * outputs.</p>
167
+ * @public
168
+ */
169
+ KmsKeyId?: string;
170
+ }
171
+ /**
172
+ * <p>Configuration for the cluster used to run a processing job.</p>
173
+ * @public
174
+ */
175
+ export interface ProcessingClusterConfig {
176
+ /**
177
+ * <p>The number of ML compute instances to use in the processing job. For distributed
178
+ * processing jobs, specify a value greater than 1. The default value is 1.</p>
179
+ * @public
180
+ */
181
+ InstanceCount: number | undefined;
182
+ /**
183
+ * <p>The ML compute instance type for the processing job.</p>
184
+ * @public
185
+ */
186
+ InstanceType: ProcessingInstanceType | undefined;
187
+ /**
188
+ * <p>The size of the ML storage volume in gigabytes that you want to provision. You must
189
+ * specify sufficient ML storage for your scenario.</p>
190
+ * <note>
191
+ * <p>Certain Nitro-based instances include local storage with a fixed total size,
192
+ * dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts
193
+ * the local instance storage instead of Amazon EBS gp2 storage. You can't request a
194
+ * <code>VolumeSizeInGB</code> greater than the total size of the local instance
195
+ * storage.</p>
196
+ * <p>For a list of instance types that support local instance storage, including the
197
+ * total size per instance type, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes">Instance Store Volumes</a>.</p>
198
+ * </note>
199
+ * @public
200
+ */
201
+ VolumeSizeInGB: number | undefined;
202
+ /**
203
+ * <p>The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the
204
+ * storage volume attached to the ML compute instance(s) that run the processing job.
205
+ * </p>
206
+ * <note>
207
+ * <p>Certain Nitro-based instances include local storage, dependent on the instance
208
+ * type. Local storage volumes are encrypted using a hardware module on the instance.
209
+ * You can't request a <code>VolumeKmsKeyId</code> when using an instance type with
210
+ * local storage.</p>
211
+ * <p>For a list of instance types that support local instance storage, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes">Instance Store Volumes</a>.</p>
212
+ * <p>For more information about local instance storage encryption, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html">SSD
213
+ * Instance Store Volumes</a>.</p>
214
+ * </note>
215
+ * @public
216
+ */
217
+ VolumeKmsKeyId?: string;
218
+ }
219
+ /**
220
+ * <p>Identifies the resources, ML compute instances, and ML storage volumes to deploy for a
221
+ * processing job. In distributed training, you specify more than one instance.</p>
222
+ * @public
223
+ */
224
+ export interface ProcessingResources {
225
+ /**
226
+ * <p>The configuration for the resources in a cluster used to run the processing
227
+ * job.</p>
228
+ * @public
229
+ */
230
+ ClusterConfig: ProcessingClusterConfig | undefined;
231
+ }
232
+ /**
233
+ * <p>Configures conditions under which the processing job should be stopped, such as how long
234
+ * the processing job has been running. After the condition is met, the processing job is stopped.</p>
235
+ * @public
236
+ */
237
+ export interface ProcessingStoppingCondition {
238
+ /**
239
+ * <p>Specifies the maximum runtime in seconds.</p>
240
+ * @public
241
+ */
242
+ MaxRuntimeInSeconds: number | undefined;
243
+ }
244
+ /**
245
+ * @public
246
+ */
247
+ export interface CreateProcessingJobRequest {
248
+ /**
249
+ * <p>An array of inputs configuring the data to download into the
250
+ * processing container.</p>
251
+ * @public
252
+ */
253
+ ProcessingInputs?: ProcessingInput[];
254
+ /**
255
+ * <p>Output configuration for the processing job.</p>
256
+ * @public
257
+ */
258
+ ProcessingOutputConfig?: ProcessingOutputConfig;
259
+ /**
260
+ * <p> The name of the processing job. The name must be unique within an Amazon Web Services Region in the
261
+ * Amazon Web Services account.</p>
262
+ * @public
263
+ */
264
+ ProcessingJobName: string | undefined;
265
+ /**
266
+ * <p>Identifies the resources, ML compute instances, and ML storage volumes to deploy for a
267
+ * processing job. In distributed training, you specify more than one instance.</p>
268
+ * @public
269
+ */
270
+ ProcessingResources: ProcessingResources | undefined;
271
+ /**
272
+ * <p>The time limit for how long the processing job is allowed to run.</p>
273
+ * @public
274
+ */
275
+ StoppingCondition?: ProcessingStoppingCondition;
276
+ /**
277
+ * <p>Configures the processing job to run a specified Docker container image.</p>
278
+ * @public
279
+ */
280
+ AppSpecification: AppSpecification | undefined;
281
+ /**
282
+ * <p>The environment variables to set in the Docker container. Up to
283
+ * 100 key and values entries in the map are supported.</p>
284
+ * @public
285
+ */
286
+ Environment?: Record<string, string>;
287
+ /**
288
+ * <p>Networking options for a processing job, such as whether to allow inbound and
289
+ * outbound network calls to and from processing containers, and the VPC subnets and
290
+ * security groups to use for VPC-enabled processing jobs.</p>
291
+ * @public
292
+ */
293
+ NetworkConfig?: NetworkConfig;
294
+ /**
295
+ * <p>The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on
296
+ * your behalf.</p>
297
+ * @public
298
+ */
299
+ RoleArn: string | undefined;
300
+ /**
301
+ * <p>(Optional) An array of key-value pairs. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL">Using Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management
302
+ * User Guide</i>.</p>
303
+ * @public
304
+ */
305
+ Tags?: Tag[];
306
+ /**
307
+ * <p>Associates a SageMaker job as a trial component with an experiment and trial. Specified when
308
+ * you call the following APIs:</p>
309
+ * <ul>
310
+ * <li>
311
+ * <p>
312
+ * <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html">CreateProcessingJob</a>
313
+ * </p>
314
+ * </li>
315
+ * <li>
316
+ * <p>
317
+ * <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html">CreateTrainingJob</a>
318
+ * </p>
319
+ * </li>
320
+ * <li>
321
+ * <p>
322
+ * <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html">CreateTransformJob</a>
323
+ * </p>
324
+ * </li>
325
+ * </ul>
326
+ * @public
327
+ */
328
+ ExperimentConfig?: ExperimentConfig;
329
+ }
330
+ /**
331
+ * @public
332
+ */
333
+ export interface CreateProcessingJobResponse {
334
+ /**
335
+ * <p>The Amazon Resource Name (ARN) of the processing job.</p>
336
+ * @public
337
+ */
338
+ ProcessingJobArn: string | undefined;
339
+ }
340
+ /**
341
+ * <p>A key value pair used when you provision a project as a service catalog product. For
342
+ * information, see <a href="https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html">What is Amazon Web Services Service
343
+ * Catalog</a>.</p>
344
+ * @public
345
+ */
346
+ export interface ProvisioningParameter {
347
+ /**
348
+ * <p>The key that identifies a provisioning parameter.</p>
349
+ * @public
350
+ */
351
+ Key?: string;
352
+ /**
353
+ * <p>The value of the provisioning parameter.</p>
354
+ * @public
355
+ */
356
+ Value?: string;
357
+ }
358
+ /**
359
+ * <p>Details that you specify to provision a service catalog product. For information about
360
+ * service catalog, see <a href="https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html">What is Amazon Web Services Service
361
+ * Catalog</a>.</p>
362
+ * @public
363
+ */
364
+ export interface ServiceCatalogProvisioningDetails {
365
+ /**
366
+ * <p>The ID of the product to provision.</p>
367
+ * @public
368
+ */
369
+ ProductId: string | undefined;
370
+ /**
371
+ * <p>The ID of the provisioning artifact.</p>
372
+ * @public
373
+ */
374
+ ProvisioningArtifactId?: string;
375
+ /**
376
+ * <p>The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. </p>
377
+ * @public
378
+ */
379
+ PathId?: string;
380
+ /**
381
+ * <p>A list of key value pairs that you specify when you provision a product.</p>
382
+ * @public
383
+ */
384
+ ProvisioningParameters?: ProvisioningParameter[];
385
+ }
3
386
  /**
4
387
  * @public
5
388
  */
@@ -231,9 +614,9 @@ export interface CreateSpaceRequest {
231
614
  */
232
615
  SpaceName: string | undefined;
233
616
  /**
234
- * <p>Tags to associated with the space. Each tag consists of a key and an optional value.
235
- * Tag keys must be unique for each resource. Tags are searchable using the
236
- * <code>Search</code> API.</p>
617
+ * <p>Tags to associated with the space. Each tag consists of a key and an optional value. Tag
618
+ * keys must be unique for each resource. Tags are searchable using the <code>Search</code>
619
+ * API.</p>
237
620
  * @public
238
621
  */
239
622
  Tags?: Tag[];
@@ -292,7 +675,8 @@ export interface CreateStudioLifecycleConfigRequest {
292
675
  */
293
676
  StudioLifecycleConfigName: string | undefined;
294
677
  /**
295
- * <p>The content of your Amazon SageMaker Studio Lifecycle Configuration script. This content must be base64 encoded.</p>
678
+ * <p>The content of your Amazon SageMaker Studio Lifecycle Configuration script. This
679
+ * content must be base64 encoded.</p>
296
680
  * @public
297
681
  */
298
682
  StudioLifecycleConfigContent: string | undefined;
@@ -302,7 +686,9 @@ export interface CreateStudioLifecycleConfigRequest {
302
686
  */
303
687
  StudioLifecycleConfigAppType: StudioLifecycleConfigAppType | undefined;
304
688
  /**
305
- * <p>Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API. </p>
689
+ * <p>Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an
690
+ * optional value. Tag keys must be unique per resource. Tags are searchable using the Search
691
+ * API. </p>
306
692
  * @public
307
693
  */
308
694
  Tags?: Tag[];
@@ -1250,24 +1636,25 @@ export interface CreateUserProfileRequest {
1250
1636
  */
1251
1637
  UserProfileName: string | undefined;
1252
1638
  /**
1253
- * <p>A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName".
1254
- * If the Domain's AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.
1255
- * </p>
1639
+ * <p>A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only
1640
+ * supported value is "UserName". If the Domain's AuthMode is IAM Identity Center, this field is
1641
+ * required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.
1642
+ * </p>
1256
1643
  * @public
1257
1644
  */
1258
1645
  SingleSignOnUserIdentifier?: string;
1259
1646
  /**
1260
- * <p>The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is
1261
- * required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.
1262
- * </p>
1647
+ * <p>The username of the associated Amazon Web Services Single Sign-On User for this
1648
+ * UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must
1649
+ * match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified. </p>
1263
1650
  * @public
1264
1651
  */
1265
1652
  SingleSignOnUserValue?: string;
1266
1653
  /**
1267
- * <p>Each tag consists of a key and an optional value.
1268
- * Tag keys must be unique per resource.</p>
1269
- * <p>Tags that you specify for the User Profile are also added to all Apps that the
1270
- * User Profile launches.</p>
1654
+ * <p>Each tag consists of a key and an optional value. Tag keys must be unique per
1655
+ * resource.</p>
1656
+ * <p>Tags that you specify for the User Profile are also added to all Apps that the User
1657
+ * Profile launches.</p>
1271
1658
  * @public
1272
1659
  */
1273
1660
  Tags?: Tag[];
@@ -1775,13 +2162,14 @@ export interface DeleteAppRequest {
1775
2162
  */
1776
2163
  DomainId: string | undefined;
1777
2164
  /**
1778
- * <p>The user profile name. If this value is not set, then <code>SpaceName</code> must be set.</p>
2165
+ * <p>The user profile name. If this value is not set, then <code>SpaceName</code> must be
2166
+ * set.</p>
1779
2167
  * @public
1780
2168
  */
1781
2169
  UserProfileName?: string;
1782
2170
  /**
1783
- * <p>The name of the space. If this value is not set, then <code>UserProfileName</code>
1784
- * must be set.</p>
2171
+ * <p>The name of the space. If this value is not set, then <code>UserProfileName</code> must be
2172
+ * set.</p>
1785
2173
  * @public
1786
2174
  */
1787
2175
  SpaceName?: string;
@@ -2369,6 +2757,16 @@ export interface DeleteNotebookInstanceLifecycleConfigInput {
2369
2757
  */
2370
2758
  NotebookInstanceLifecycleConfigName: string | undefined;
2371
2759
  }
2760
+ /**
2761
+ * @public
2762
+ */
2763
+ export interface DeleteOptimizationJobRequest {
2764
+ /**
2765
+ * <p>The name that you assigned to the optimization job.</p>
2766
+ * @public
2767
+ */
2768
+ OptimizationJobName: string | undefined;
2769
+ }
2372
2770
  /**
2373
2771
  * @public
2374
2772
  */
@@ -2899,7 +3297,8 @@ export interface DescribeAppRequest {
2899
3297
  */
2900
3298
  DomainId: string | undefined;
2901
3299
  /**
2902
- * <p>The user profile name. If this value is not set, then <code>SpaceName</code> must be set.</p>
3300
+ * <p>The user profile name. If this value is not set, then <code>SpaceName</code> must be
3301
+ * set.</p>
2903
3302
  * @public
2904
3303
  */
2905
3304
  UserProfileName?: string;
@@ -2949,8 +3348,8 @@ export interface DescribeAppResponse {
2949
3348
  */
2950
3349
  UserProfileName?: string;
2951
3350
  /**
2952
- * <p>The name of the space. If this value is not set, then <code>UserProfileName</code>
2953
- * must be set.</p>
3351
+ * <p>The name of the space. If this value is not set, then <code>UserProfileName</code> must be
3352
+ * set.</p>
2954
3353
  * @public
2955
3354
  */
2956
3355
  SpaceName?: string;
@@ -2965,14 +3364,20 @@ export interface DescribeAppResponse {
2965
3364
  */
2966
3365
  LastHealthCheckTimestamp?: Date;
2967
3366
  /**
2968
- * <p>The timestamp of the last user's activity. <code>LastUserActivityTimestamp</code> is also updated when SageMaker performs health checks without user activity. As a result, this value is set to the same value as <code>LastHealthCheckTimestamp</code>.</p>
3367
+ * <p>The timestamp of the last user's activity. <code>LastUserActivityTimestamp</code> is also
3368
+ * updated when SageMaker performs health checks without user activity. As a result, this
3369
+ * value is set to the same value as <code>LastHealthCheckTimestamp</code>.</p>
2969
3370
  * @public
2970
3371
  */
2971
3372
  LastUserActivityTimestamp?: Date;
2972
3373
  /**
2973
3374
  * <p>The creation time of the application.</p>
2974
3375
  * <note>
2975
- * <p>After an application has been shut down for 24 hours, SageMaker deletes all metadata for the application. To be considered an update and retain application metadata, applications must be restarted within 24 hours after the previous application has been shut down. After this time window, creation of an application is considered a new application rather than an update of the previous application.</p>
3376
+ * <p>After an application has been shut down for 24 hours, SageMaker deletes all
3377
+ * metadata for the application. To be considered an update and retain application metadata,
3378
+ * applications must be restarted within 24 hours after the previous application has been shut
3379
+ * down. After this time window, creation of an application is considered a new application
3380
+ * rather than an update of the previous application.</p>
2976
3381
  * </note>
2977
3382
  * @public
2978
3383
  */
@@ -2983,7 +3388,8 @@ export interface DescribeAppResponse {
2983
3388
  */
2984
3389
  FailureReason?: string;
2985
3390
  /**
2986
- * <p>The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.</p>
3391
+ * <p>The instance type and the Amazon Resource Name (ARN) of the SageMaker image
3392
+ * created on the instance.</p>
2987
3393
  * @public
2988
3394
  */
2989
3395
  ResourceSpec?: ResourceSpec;
@@ -4041,8 +4447,8 @@ export interface DescribeDomainResponse {
4041
4447
  */
4042
4448
  SingleSignOnManagedApplicationInstanceId?: string;
4043
4449
  /**
4044
- * <p>The ARN of the application managed by SageMaker in IAM Identity Center. This value is
4045
- * only returned for domains created after October 1, 2023.</p>
4450
+ * <p>The ARN of the application managed by SageMaker in IAM Identity Center. This value
4451
+ * is only returned for domains created after October 1, 2023.</p>
4046
4452
  * @public
4047
4453
  */
4048
4454
  SingleSignOnApplicationArn?: string;
@@ -4094,8 +4500,7 @@ export interface DescribeDomainResponse {
4094
4500
  * <ul>
4095
4501
  * <li>
4096
4502
  * <p>
4097
- * <code>PublicInternetOnly</code> - Non-EFS traffic is through a VPC managed by
4098
- * Amazon SageMaker, which allows direct internet access</p>
4503
+ * <code>PublicInternetOnly</code> - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access</p>
4099
4504
  * </li>
4100
4505
  * <li>
4101
4506
  * <p>
@@ -7807,528 +8212,7 @@ export declare const ModelCardExportJobStatus: {
7807
8212
  */
7808
8213
  export type ModelCardExportJobStatus = (typeof ModelCardExportJobStatus)[keyof typeof ModelCardExportJobStatus];
7809
8214
  /**
7810
- * @public
7811
- */
7812
- export interface DescribeModelCardExportJobResponse {
7813
- /**
7814
- * <p>The name of the model card export job to describe.</p>
7815
- * @public
7816
- */
7817
- ModelCardExportJobName: string | undefined;
7818
- /**
7819
- * <p>The Amazon Resource Name (ARN) of the model card export job.</p>
7820
- * @public
7821
- */
7822
- ModelCardExportJobArn: string | undefined;
7823
- /**
7824
- * <p>The completion status of the model card export job.</p>
7825
- * <ul>
7826
- * <li>
7827
- * <p>
7828
- * <code>InProgress</code>: The model card export job is in progress.</p>
7829
- * </li>
7830
- * <li>
7831
- * <p>
7832
- * <code>Completed</code>: The model card export job is complete.</p>
7833
- * </li>
7834
- * <li>
7835
- * <p>
7836
- * <code>Failed</code>: The model card export job failed. To see the reason for the failure, see
7837
- * the <code>FailureReason</code> field in the response to a
7838
- * <code>DescribeModelCardExportJob</code> call.</p>
7839
- * </li>
7840
- * </ul>
7841
- * @public
7842
- */
7843
- Status: ModelCardExportJobStatus | undefined;
7844
- /**
7845
- * <p>The name or Amazon Resource Name (ARN) of the model card that the model export job exports.</p>
7846
- * @public
7847
- */
7848
- ModelCardName: string | undefined;
7849
- /**
7850
- * <p>The version of the model card that the model export job exports.</p>
7851
- * @public
7852
- */
7853
- ModelCardVersion: number | undefined;
7854
- /**
7855
- * <p>The export output details for the model card.</p>
7856
- * @public
7857
- */
7858
- OutputConfig: ModelCardExportOutputConfig | undefined;
7859
- /**
7860
- * <p>The date and time that the model export job was created.</p>
7861
- * @public
7862
- */
7863
- CreatedAt: Date | undefined;
7864
- /**
7865
- * <p>The date and time that the model export job was last modified.</p>
7866
- * @public
7867
- */
7868
- LastModifiedAt: Date | undefined;
7869
- /**
7870
- * <p>The failure reason if the model export job fails.</p>
7871
- * @public
7872
- */
7873
- FailureReason?: string;
7874
- /**
7875
- * <p>The exported model card artifacts.</p>
7876
- * @public
7877
- */
7878
- ExportArtifacts?: ModelCardExportArtifacts;
7879
- }
7880
- /**
7881
- * @public
7882
- */
7883
- export interface DescribeModelExplainabilityJobDefinitionRequest {
7884
- /**
7885
- * <p>The name of the model explainability job definition. The name must be unique within an
7886
- * Amazon Web Services Region in the Amazon Web Services account.</p>
7887
- * @public
7888
- */
7889
- JobDefinitionName: string | undefined;
7890
- }
7891
- /**
7892
- * @public
7893
- */
7894
- export interface DescribeModelExplainabilityJobDefinitionResponse {
7895
- /**
7896
- * <p>The Amazon Resource Name (ARN) of the model explainability job.</p>
7897
- * @public
7898
- */
7899
- JobDefinitionArn: string | undefined;
7900
- /**
7901
- * <p>The name of the explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.</p>
7902
- * @public
7903
- */
7904
- JobDefinitionName: string | undefined;
7905
- /**
7906
- * <p>The time at which the model explainability job was created.</p>
7907
- * @public
7908
- */
7909
- CreationTime: Date | undefined;
7910
- /**
7911
- * <p>The baseline configuration for a model explainability job.</p>
7912
- * @public
7913
- */
7914
- ModelExplainabilityBaselineConfig?: ModelExplainabilityBaselineConfig;
7915
- /**
7916
- * <p>Configures the model explainability job to run a specified Docker container image.</p>
7917
- * @public
7918
- */
7919
- ModelExplainabilityAppSpecification: ModelExplainabilityAppSpecification | undefined;
7920
- /**
7921
- * <p>Inputs for the model explainability job.</p>
7922
- * @public
7923
- */
7924
- ModelExplainabilityJobInput: ModelExplainabilityJobInput | undefined;
7925
- /**
7926
- * <p>The output configuration for monitoring jobs.</p>
7927
- * @public
7928
- */
7929
- ModelExplainabilityJobOutputConfig: MonitoringOutputConfig | undefined;
7930
- /**
7931
- * <p>Identifies the resources to deploy for a monitoring job.</p>
7932
- * @public
7933
- */
7934
- JobResources: MonitoringResources | undefined;
7935
- /**
7936
- * <p>Networking options for a model explainability job.</p>
7937
- * @public
7938
- */
7939
- NetworkConfig?: MonitoringNetworkConfig;
7940
- /**
7941
- * <p>The Amazon Resource Name (ARN) of the IAM role that has read permission to the
7942
- * input data location and write permission to the output data location in Amazon S3.</p>
7943
- * @public
7944
- */
7945
- RoleArn: string | undefined;
7946
- /**
7947
- * <p>A time limit for how long the monitoring job is allowed to run before stopping.</p>
7948
- * @public
7949
- */
7950
- StoppingCondition?: MonitoringStoppingCondition;
7951
- }
7952
- /**
7953
- * @public
7954
- */
7955
- export interface DescribeModelPackageInput {
7956
- /**
7957
- * <p>The name or Amazon Resource Name (ARN) of the model package to describe.</p>
7958
- * <p>When you specify a name, the name must have 1 to 63 characters. Valid
7959
- * characters are a-z, A-Z, 0-9, and - (hyphen).</p>
7960
- * @public
7961
- */
7962
- ModelPackageName: string | undefined;
7963
- }
7964
- /**
7965
- * @public
7966
- * @enum
7967
- */
7968
- export declare const DetailedModelPackageStatus: {
7969
- readonly COMPLETED: "Completed";
7970
- readonly FAILED: "Failed";
7971
- readonly IN_PROGRESS: "InProgress";
7972
- readonly NOT_STARTED: "NotStarted";
7973
- };
7974
- /**
7975
- * @public
7976
- */
7977
- export type DetailedModelPackageStatus = (typeof DetailedModelPackageStatus)[keyof typeof DetailedModelPackageStatus];
7978
- /**
7979
- * <p>Represents the overall status of a model package.</p>
7980
- * @public
7981
- */
7982
- export interface ModelPackageStatusItem {
7983
- /**
7984
- * <p>The name of the model package for which the overall status is being reported.</p>
7985
- * @public
7986
- */
7987
- Name: string | undefined;
7988
- /**
7989
- * <p>The current status.</p>
7990
- * @public
7991
- */
7992
- Status: DetailedModelPackageStatus | undefined;
7993
- /**
7994
- * <p>if the overall status is <code>Failed</code>, the reason for the failure.</p>
7995
- * @public
7996
- */
7997
- FailureReason?: string;
7998
- }
7999
- /**
8000
- * <p>Specifies the validation and image scan statuses of the model package.</p>
8001
- * @public
8002
- */
8003
- export interface ModelPackageStatusDetails {
8004
- /**
8005
- * <p>The validation status of the model package.</p>
8006
- * @public
8007
- */
8008
- ValidationStatuses: ModelPackageStatusItem[] | undefined;
8009
- /**
8010
- * <p>The status of the scan of the Docker image container for the model package.</p>
8011
- * @public
8012
- */
8013
- ImageScanStatuses?: ModelPackageStatusItem[];
8014
- }
8015
- /**
8016
- * @public
8017
- */
8018
- export interface DescribeModelPackageOutput {
8019
- /**
8020
- * <p>The name of the model package being described.</p>
8021
- * @public
8022
- */
8023
- ModelPackageName: string | undefined;
8024
- /**
8025
- * <p>If the model is a versioned model, the name of the model group that the versioned
8026
- * model belongs to.</p>
8027
- * @public
8028
- */
8029
- ModelPackageGroupName?: string;
8030
- /**
8031
- * <p>The version of the model package.</p>
8032
- * @public
8033
- */
8034
- ModelPackageVersion?: number;
8035
- /**
8036
- * <p>The Amazon Resource Name (ARN) of the model package.</p>
8037
- * @public
8038
- */
8039
- ModelPackageArn: string | undefined;
8040
- /**
8041
- * <p>A brief summary of the model package.</p>
8042
- * @public
8043
- */
8044
- ModelPackageDescription?: string;
8045
- /**
8046
- * <p>A timestamp specifying when the model package was created.</p>
8047
- * @public
8048
- */
8049
- CreationTime: Date | undefined;
8050
- /**
8051
- * <p>Details about inference jobs that you can run with models based on this model
8052
- * package.</p>
8053
- * @public
8054
- */
8055
- InferenceSpecification?: InferenceSpecification;
8056
- /**
8057
- * <p>Details about the algorithm that was used to create the model package.</p>
8058
- * @public
8059
- */
8060
- SourceAlgorithmSpecification?: SourceAlgorithmSpecification;
8061
- /**
8062
- * <p>Configurations for one or more transform jobs that SageMaker runs to test the model
8063
- * package.</p>
8064
- * @public
8065
- */
8066
- ValidationSpecification?: ModelPackageValidationSpecification;
8067
- /**
8068
- * <p>The current status of the model package.</p>
8069
- * @public
8070
- */
8071
- ModelPackageStatus: ModelPackageStatus | undefined;
8072
- /**
8073
- * <p>Details about the current status of the model package.</p>
8074
- * @public
8075
- */
8076
- ModelPackageStatusDetails: ModelPackageStatusDetails | undefined;
8077
- /**
8078
- * <p>Whether the model package is certified for listing on Amazon Web Services Marketplace.</p>
8079
- * @public
8080
- */
8081
- CertifyForMarketplace?: boolean;
8082
- /**
8083
- * <p>The approval status of the model package.</p>
8084
- * @public
8085
- */
8086
- ModelApprovalStatus?: ModelApprovalStatus;
8087
- /**
8088
- * <p>Information about the user who created or modified an experiment, trial, trial
8089
- * component, lineage group, project, or model card.</p>
8090
- * @public
8091
- */
8092
- CreatedBy?: UserContext;
8093
- /**
8094
- * <p>Metadata properties of the tracking entity, trial, or trial component.</p>
8095
- * @public
8096
- */
8097
- MetadataProperties?: MetadataProperties;
8098
- /**
8099
- * <p>Metrics for the model.</p>
8100
- * @public
8101
- */
8102
- ModelMetrics?: ModelMetrics;
8103
- /**
8104
- * <p>The last time that the model package was modified.</p>
8105
- * @public
8106
- */
8107
- LastModifiedTime?: Date;
8108
- /**
8109
- * <p>Information about the user who created or modified an experiment, trial, trial
8110
- * component, lineage group, project, or model card.</p>
8111
- * @public
8112
- */
8113
- LastModifiedBy?: UserContext;
8114
- /**
8115
- * <p>A description provided for the model approval.</p>
8116
- * @public
8117
- */
8118
- ApprovalDescription?: string;
8119
- /**
8120
- * <p>The machine learning domain of the model package you specified. Common machine
8121
- * learning domains include computer vision and natural language processing.</p>
8122
- * @public
8123
- */
8124
- Domain?: string;
8125
- /**
8126
- * <p>The machine learning task you specified that your model package accomplishes.
8127
- * Common machine learning tasks include object detection and image classification.</p>
8128
- * @public
8129
- */
8130
- Task?: string;
8131
- /**
8132
- * <p>The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single
8133
- * gzip compressed tar archive (.tar.gz suffix).</p>
8134
- * @public
8135
- */
8136
- SamplePayloadUrl?: string;
8137
- /**
8138
- * <p>The metadata properties associated with the model package versions.</p>
8139
- * @public
8140
- */
8141
- CustomerMetadataProperties?: Record<string, string>;
8142
- /**
8143
- * <p>Represents the drift check baselines that can be used when the model monitor is set using the model package.
8144
- * For more information, see the topic on <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-quality-clarify-baseline-lifecycle.html#pipelines-quality-clarify-baseline-drift-detection">Drift Detection against Previous Baselines in SageMaker Pipelines</a> in the <i>Amazon SageMaker Developer Guide</i>.
8145
- * </p>
8146
- * @public
8147
- */
8148
- DriftCheckBaselines?: DriftCheckBaselines;
8149
- /**
8150
- * <p>An array of additional Inference Specification objects. Each additional
8151
- * Inference Specification specifies artifacts based on this model package that can
8152
- * be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.</p>
8153
- * @public
8154
- */
8155
- AdditionalInferenceSpecifications?: AdditionalInferenceSpecificationDefinition[];
8156
- /**
8157
- * <p>Indicates if you want to skip model validation.</p>
8158
- * @public
8159
- */
8160
- SkipModelValidation?: SkipModelValidation;
8161
- /**
8162
- * <p>The URI of the source for the model package.</p>
8163
- * @public
8164
- */
8165
- SourceUri?: string;
8166
- /**
8167
- * <p>The KMS Key ID (<code>KMSKeyId</code>) used for encryption of model package information.</p>
8168
- * @public
8169
- */
8170
- SecurityConfig?: ModelPackageSecurityConfig;
8171
- /**
8172
- * <p>The model card associated with the model package. Since <code>ModelPackageModelCard</code> is
8173
- * tied to a model package, it is a specific usage of a model card and its schema is
8174
- * simplified compared to the schema of <code>ModelCard</code>. The
8175
- * <code>ModelPackageModelCard</code> schema does not include <code>model_package_details</code>,
8176
- * and <code>model_overview</code> is composed of the <code>model_creator</code> and
8177
- * <code>model_artifact</code> properties. For more information about the model package model
8178
- * card schema, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html#model-card-schema">Model
8179
- * package model card schema</a>. For more information about
8180
- * the model card associated with the model package, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html">View
8181
- * the Details of a Model Version</a>.</p>
8182
- * @public
8183
- */
8184
- ModelCard?: ModelPackageModelCard;
8185
- }
8186
- /**
8187
- * @public
8188
- */
8189
- export interface DescribeModelPackageGroupInput {
8190
- /**
8191
- * <p>The name of the model group to describe.</p>
8192
- * @public
8193
- */
8194
- ModelPackageGroupName: string | undefined;
8195
- }
8196
- /**
8197
- * @public
8198
- * @enum
8199
- */
8200
- export declare const ModelPackageGroupStatus: {
8201
- readonly COMPLETED: "Completed";
8202
- readonly DELETE_FAILED: "DeleteFailed";
8203
- readonly DELETING: "Deleting";
8204
- readonly FAILED: "Failed";
8205
- readonly IN_PROGRESS: "InProgress";
8206
- readonly PENDING: "Pending";
8207
- };
8208
- /**
8209
- * @public
8210
- */
8211
- export type ModelPackageGroupStatus = (typeof ModelPackageGroupStatus)[keyof typeof ModelPackageGroupStatus];
8212
- /**
8213
- * @public
8214
- */
8215
- export interface DescribeModelPackageGroupOutput {
8216
- /**
8217
- * <p>The name of the model group.</p>
8218
- * @public
8219
- */
8220
- ModelPackageGroupName: string | undefined;
8221
- /**
8222
- * <p>The Amazon Resource Name (ARN) of the model group.</p>
8223
- * @public
8224
- */
8225
- ModelPackageGroupArn: string | undefined;
8226
- /**
8227
- * <p>A description of the model group.</p>
8228
- * @public
8229
- */
8230
- ModelPackageGroupDescription?: string;
8231
- /**
8232
- * <p>The time that the model group was created.</p>
8233
- * @public
8234
- */
8235
- CreationTime: Date | undefined;
8236
- /**
8237
- * <p>Information about the user who created or modified an experiment, trial, trial
8238
- * component, lineage group, project, or model card.</p>
8239
- * @public
8240
- */
8241
- CreatedBy: UserContext | undefined;
8242
- /**
8243
- * <p>The status of the model group.</p>
8244
- * @public
8245
- */
8246
- ModelPackageGroupStatus: ModelPackageGroupStatus | undefined;
8247
- }
8248
- /**
8249
- * @public
8250
- */
8251
- export interface DescribeModelQualityJobDefinitionRequest {
8252
- /**
8253
- * <p>The name of the model quality job. The name must be unique within an Amazon Web Services
8254
- * Region in the Amazon Web Services account.</p>
8255
- * @public
8256
- */
8257
- JobDefinitionName: string | undefined;
8258
- }
8259
- /**
8260
- * @public
8261
- */
8262
- export interface DescribeModelQualityJobDefinitionResponse {
8263
- /**
8264
- * <p>The Amazon Resource Name (ARN) of the model quality job.</p>
8265
- * @public
8266
- */
8267
- JobDefinitionArn: string | undefined;
8268
- /**
8269
- * <p>The name of the quality job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.</p>
8270
- * @public
8271
- */
8272
- JobDefinitionName: string | undefined;
8273
- /**
8274
- * <p>The time at which the model quality job was created.</p>
8275
- * @public
8276
- */
8277
- CreationTime: Date | undefined;
8278
- /**
8279
- * <p>The baseline configuration for a model quality job.</p>
8280
- * @public
8281
- */
8282
- ModelQualityBaselineConfig?: ModelQualityBaselineConfig;
8283
- /**
8284
- * <p>Configures the model quality job to run a specified Docker container image.</p>
8285
- * @public
8286
- */
8287
- ModelQualityAppSpecification: ModelQualityAppSpecification | undefined;
8288
- /**
8289
- * <p>Inputs for the model quality job.</p>
8290
- * @public
8291
- */
8292
- ModelQualityJobInput: ModelQualityJobInput | undefined;
8293
- /**
8294
- * <p>The output configuration for monitoring jobs.</p>
8295
- * @public
8296
- */
8297
- ModelQualityJobOutputConfig: MonitoringOutputConfig | undefined;
8298
- /**
8299
- * <p>Identifies the resources to deploy for a monitoring job.</p>
8300
- * @public
8301
- */
8302
- JobResources: MonitoringResources | undefined;
8303
- /**
8304
- * <p>Networking options for a model quality job.</p>
8305
- * @public
8306
- */
8307
- NetworkConfig?: MonitoringNetworkConfig;
8308
- /**
8309
- * <p>The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can
8310
- * assume to perform tasks on your behalf.</p>
8311
- * @public
8312
- */
8313
- RoleArn: string | undefined;
8314
- /**
8315
- * <p>A time limit for how long the monitoring job is allowed to run before stopping.</p>
8316
- * @public
8317
- */
8318
- StoppingCondition?: MonitoringStoppingCondition;
8319
- }
8320
- /**
8321
- * @public
8322
- */
8323
- export interface DescribeMonitoringScheduleRequest {
8324
- /**
8325
- * <p>Name of a previously created monitoring schedule.</p>
8326
- * @public
8327
- */
8328
- MonitoringScheduleName: string | undefined;
8329
- }
8330
- /**
8331
- * @internal
8215
+ * @internal
8332
8216
  */
8333
8217
  export declare const OidcConfigFilterSensitiveLog: (obj: OidcConfig) => any;
8334
8218
  /**
@@ -8339,7 +8223,3 @@ export declare const CreateWorkforceRequestFilterSensitiveLog: (obj: CreateWorkf
8339
8223
  * @internal
8340
8224
  */
8341
8225
  export declare const DescribeModelCardResponseFilterSensitiveLog: (obj: DescribeModelCardResponse) => any;
8342
- /**
8343
- * @internal
8344
- */
8345
- export declare const DescribeModelPackageOutputFilterSensitiveLog: (obj: DescribeModelPackageOutput) => any;