@aws-sdk/client-sagemaker 3.145.0 → 3.146.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 (36) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/dist-cjs/commands/DescribeHumanTaskUiCommand.js +2 -1
  3. package/dist-cjs/commands/ListPipelineExecutionsCommand.js +3 -3
  4. package/dist-cjs/models/models_1.js +19 -20
  5. package/dist-cjs/models/models_2.js +19 -18
  6. package/dist-cjs/models/models_3.js +16 -4
  7. package/dist-cjs/protocols/Aws_json1_1.js +62 -0
  8. package/dist-es/commands/DescribeHumanTaskUiCommand.js +2 -1
  9. package/dist-es/commands/ListPipelineExecutionsCommand.js +1 -1
  10. package/dist-es/models/models_1.js +6 -7
  11. package/dist-es/models/models_2.js +7 -3
  12. package/dist-es/models/models_3.js +3 -0
  13. package/dist-es/protocols/Aws_json1_1.js +51 -1
  14. package/dist-types/SageMaker.d.ts +28 -29
  15. package/dist-types/commands/AddTagsCommand.d.ts +1 -2
  16. package/dist-types/commands/CreateAlgorithmCommand.d.ts +1 -2
  17. package/dist-types/commands/CreateCodeRepositoryCommand.d.ts +2 -2
  18. package/dist-types/commands/CreateEndpointCommand.d.ts +8 -6
  19. package/dist-types/commands/CreateModelCommand.d.ts +2 -4
  20. package/dist-types/commands/CreatePresignedNotebookInstanceUrlCommand.d.ts +1 -1
  21. package/dist-types/commands/DeleteEndpointCommand.d.ts +6 -6
  22. package/dist-types/commands/DeleteModelCommand.d.ts +3 -3
  23. package/dist-types/commands/DescribeHumanTaskUiCommand.d.ts +2 -1
  24. package/dist-types/commands/ListNotebookInstancesCommand.d.ts +2 -2
  25. package/dist-types/commands/ListPipelineExecutionsCommand.d.ts +1 -1
  26. package/dist-types/commands/ListTrainingJobsCommand.d.ts +2 -1
  27. package/dist-types/models/models_0.d.ts +218 -193
  28. package/dist-types/models/models_1.d.ts +235 -157
  29. package/dist-types/models/models_2.d.ts +83 -120
  30. package/dist-types/models/models_3.d.ts +115 -23
  31. package/dist-types/ts3.4/commands/DescribeHumanTaskUiCommand.d.ts +2 -1
  32. package/dist-types/ts3.4/commands/ListPipelineExecutionsCommand.d.ts +1 -1
  33. package/dist-types/ts3.4/models/models_1.d.ts +35 -29
  34. package/dist-types/ts3.4/models/models_2.d.ts +26 -42
  35. package/dist-types/ts3.4/models/models_3.d.ts +44 -1
  36. package/package.json +1 -1
@@ -1,4 +1,4 @@
1
- import { ActionSource, ActionStatus, AdditionalInferenceSpecificationDefinition, AlgorithmSpecification, AlgorithmStatus, AlgorithmStatusDetails, AlgorithmValidationSpecification, AnnotationConsolidationConfig, AppNetworkAccessType, AppSecurityGroupManagement, AppSpecification, AppStatus, AppType, ArtifactSource, AsyncInferenceConfig, AthenaDatasetDefinition, AuthMode, AutoMLCandidate, AutoMLChannel, AutoMLJobArtifacts, AutoMLJobCompletionCriteria, AutoMLJobConfig, AutoMLJobObjective, AutoMLJobSecondaryStatus, AutoMLJobStatus, AutoMLOutputDataConfig, AutoMLPartialFailureReason, BatchStrategy, Bias, CaptureStatus, CategoricalParameter, Channel, CheckpointConfig, CognitoConfig, CognitoMemberDefinition, CollectionConfiguration, CompilationJobStatus, ContainerDefinition, ContentClassifier, ContextSource, DataCaptureConfig, DataQualityAppSpecification, DataQualityBaselineConfig, DataQualityJobInput, DeploymentConfig, DeviceSelectionConfig, DomainSettings, EdgeDeploymentConfig, EdgeDeploymentModelConfig, EdgeOutputConfig, EdgePresetDeploymentType, EndpointInput, FeatureDefinition, FeatureType, FlowDefinitionOutputConfig, GitConfig, HumanLoopActivationConfig, HumanLoopConfig, HumanLoopRequestSource, HyperParameterTuningJobObjective, HyperParameterTuningJobStrategyType, InferenceSpecification, InputConfig, KernelGatewayImageConfig, MetadataProperties, MetricDefinition, MetricsSource, ModelApprovalStatus, ModelDeployConfig, MonitoringConstraintsResource, MonitoringNetworkConfig, MonitoringOutputConfig, MonitoringResources, MonitoringStatisticsResource, MonitoringStoppingCondition, NeoVpcConfig, OfflineStoreConfig, OnlineStoreConfig, OutputConfig, OutputDataConfig, ParameterRanges, ProblemType, ProcessingInstanceType, ProcessingS3DataDistributionType, ProcessingS3InputMode, ProcessingS3UploadMode, ProductionVariant, ProductionVariantAcceleratorType, ProductionVariantInstanceType, ProductionVariantServerlessConfig, PublicWorkforceTaskPrice, ResourceConfig, ResourceLimits, ResourceSpec, StoppingCondition, Tag, TrainingInputMode, TrainingJobEarlyStoppingType, TrainingSpecification, TransformInput, TransformJobDefinition, TransformOutput, TransformResources, TuningJobCompletionCriteria, UserContext, UserSettings, VpcConfig } from "./models_0";
1
+ import { ActionSource, ActionStatus, AdditionalInferenceSpecificationDefinition, AlgorithmSpecification, AlgorithmStatus, AlgorithmStatusDetails, AlgorithmValidationSpecification, AnnotationConsolidationConfig, AppNetworkAccessType, AppSecurityGroupManagement, AppSpecification, AppStatus, AppType, ArtifactSource, AsyncInferenceConfig, AthenaDatasetDefinition, AuthMode, AutoMLCandidate, AutoMLChannel, AutoMLJobArtifacts, AutoMLJobCompletionCriteria, AutoMLJobConfig, AutoMLJobObjective, AutoMLJobSecondaryStatus, AutoMLJobStatus, AutoMLOutputDataConfig, AutoMLPartialFailureReason, BatchStrategy, Bias, CaptureStatus, CategoricalParameter, Channel, CheckpointConfig, CognitoConfig, CognitoMemberDefinition, CollectionConfiguration, CompilationJobStatus, ContainerDefinition, ContentClassifier, ContextSource, DataCaptureConfig, DataQualityAppSpecification, DataQualityBaselineConfig, DataQualityJobInput, DeploymentConfig, DeviceSelectionConfig, DomainSettings, EdgeDeploymentConfig, EdgeDeploymentModelConfig, EdgeOutputConfig, EdgePresetDeploymentType, EndpointInput, FeatureDefinition, FeatureType, FlowDefinitionOutputConfig, GitConfig, HumanLoopActivationConfig, HumanLoopConfig, HumanLoopRequestSource, HyperParameterTuningJobObjective, HyperParameterTuningJobStrategyType, InferenceSpecification, InputConfig, KernelGatewayImageConfig, MetadataProperties, MetricDefinition, MetricsSource, ModelApprovalStatus, ModelDeployConfig, MonitoringConstraintsResource, MonitoringNetworkConfig, MonitoringOutputConfig, MonitoringResources, MonitoringStatisticsResource, MonitoringStoppingCondition, NeoVpcConfig, OfflineStoreConfig, OnlineStoreConfig, OutputConfig, OutputDataConfig, ParameterRanges, ProblemType, ProcessingInstanceType, ProcessingS3DataDistributionType, ProcessingS3InputMode, ProcessingS3UploadMode, ProductionVariant, ProductionVariantAcceleratorType, ProductionVariantInstanceType, ProductionVariantServerlessConfig, PublicWorkforceTaskPrice, ResourceConfig, ResourceLimits, ResourceSpec, StoppingCondition, Tag, TrainingInputMode, TrainingInstanceType, TrainingJobEarlyStoppingType, TrainingSpecification, TransformInput, TransformJobDefinition, TransformOutput, TransformResources, TuningJobCompletionCriteria, UserContext, UserSettings, VpcConfig } from "./models_0";
2
2
  /**
3
3
  * <p>Configures a hyperparameter tuning job.</p>
4
4
  */
@@ -71,43 +71,42 @@ export interface HyperParameterAlgorithmSpecification {
71
71
  */
72
72
  TrainingImage?: string;
73
73
  /**
74
- * <p>The training input mode that the algorithm supports. For more information about input modes, see
75
- * <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html">Algorithms</a>.</p>
74
+ * <p>The training input mode that the algorithm supports. For more information about input
75
+ * modes, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html">Algorithms</a>.</p>
76
76
  *
77
77
  * <p>
78
78
  * <b>Pipe mode</b>
79
79
  * </p>
80
- * <p>If an algorithm supports <code>Pipe</code> mode, Amazon SageMaker streams data directly
81
- * from Amazon S3 to the container.</p>
80
+ * <p>If an algorithm supports <code>Pipe</code> mode, Amazon SageMaker streams data directly from
81
+ * Amazon S3 to the container.</p>
82
82
  *
83
83
  * <p>
84
84
  * <b>File mode</b>
85
85
  * </p>
86
- * <p>If an algorithm supports <code>File</code> mode, SageMaker
87
- * downloads the training data from S3 to the provisioned ML storage volume, and mounts the
88
- * directory to the Docker volume for the training container.</p>
89
- * <p>You must provision the ML storage volume with sufficient capacity
90
- * to accommodate the data downloaded from S3. In addition to the training data, the ML
91
- * storage volume also stores the output model. The algorithm container uses the ML storage
92
- * volume to also store intermediate information, if any.</p>
93
- * <p>For distributed algorithms, training data is distributed uniformly.
94
- * Your training duration is predictable if the input data objects sizes are
95
- * approximately the same. SageMaker does not split the files any further for model training.
96
- * If the object sizes are skewed, training won't be optimal as the data distribution is also
97
- * skewed when one host in a training cluster is overloaded, thus becoming a bottleneck in
98
- * training.</p>
86
+ * <p>If an algorithm supports <code>File</code> mode, SageMaker downloads the training data from
87
+ * S3 to the provisioned ML storage volume, and mounts the directory to the Docker volume
88
+ * for the training container.</p>
89
+ * <p>You must provision the ML storage volume with sufficient capacity to accommodate the
90
+ * data downloaded from S3. In addition to the training data, the ML storage volume also
91
+ * stores the output model. The algorithm container uses the ML storage volume to also
92
+ * store intermediate information, if any.</p>
93
+ * <p>For distributed algorithms, training data is distributed uniformly. Your training
94
+ * duration is predictable if the input data objects sizes are approximately the same. SageMaker
95
+ * does not split the files any further for model training. If the object sizes are skewed,
96
+ * training won't be optimal as the data distribution is also skewed when one host in a
97
+ * training cluster is overloaded, thus becoming a bottleneck in training.</p>
99
98
  *
100
99
  * <p>
101
100
  * <b>FastFile mode</b>
102
101
  * </p>
103
- * <p>If an algorithm supports <code>FastFile</code> mode, SageMaker streams data directly
104
- * from S3 to the container with no code changes, and provides file system access to
105
- * the data. Users can author their training script to interact with these files as if
106
- * they were stored on disk.</p>
102
+ * <p>If an algorithm supports <code>FastFile</code> mode, SageMaker streams data directly from
103
+ * S3 to the container with no code changes, and provides file system access to the data.
104
+ * Users can author their training script to interact with these files as if they were
105
+ * stored on disk.</p>
107
106
  * <p>
108
- * <code>FastFile</code> mode works best when the data is read sequentially.
109
- * Augmented manifest files aren't supported.
110
- * The startup time is lower when there are fewer files in the S3 bucket provided.</p>
107
+ * <code>FastFile</code> mode works best when the data is read sequentially. Augmented
108
+ * manifest files aren't supported. The startup time is lower when there are fewer files in
109
+ * the S3 bucket provided.</p>
111
110
  */
112
111
  TrainingInputMode: TrainingInputMode | string | undefined;
113
112
  /**
@@ -123,6 +122,109 @@ export interface HyperParameterAlgorithmSpecification {
123
122
  */
124
123
  MetricDefinitions?: MetricDefinition[];
125
124
  }
125
+ export declare enum HyperParameterTuningAllocationStrategy {
126
+ PRIORITIZED = "Prioritized"
127
+ }
128
+ /**
129
+ * <p>The configuration for hyperparameter tuning resources for use in training jobs
130
+ * launched by the tuning job. These resources include compute instances and storage
131
+ * volumes. Specify one or more compute instance configurations and allocation strategies
132
+ * to select resources (optional).</p>
133
+ */
134
+ export interface HyperParameterTuningInstanceConfig {
135
+ /**
136
+ * <p>The instance type used for processing of hyperparameter optimization jobs. Choose from
137
+ * general purpose (no GPUs) instance types: ml.m5.xlarge, ml.m5.2xlarge, and ml.m5.4xlarge
138
+ * or compute optimized (no GPUs) instance types: ml.c5.xlarge and ml.c5.2xlarge. For more
139
+ * information about instance types, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebooks-available-instance-types.html">instance type
140
+ * descriptions</a>.</p>
141
+ */
142
+ InstanceType: TrainingInstanceType | string | undefined;
143
+ /**
144
+ * <p>The number of instances of the type specified by <code>InstanceType</code>. Choose an
145
+ * instance count larger than 1 for distributed training algorithms. See <a href="https://docs.aws.amazon.com/data-parallel-use-api.html">SageMaker distributed training
146
+ * jobs</a> for more information.</p>
147
+ */
148
+ InstanceCount: number | undefined;
149
+ /**
150
+ * <p>The volume size in GB of the data to be processed for hyperparameter optimization
151
+ * (optional).</p>
152
+ */
153
+ VolumeSizeInGB: number | undefined;
154
+ }
155
+ /**
156
+ * <p>The configuration of resources, including compute instances and storage volumes for
157
+ * use in training jobs launched by hyperparameter tuning jobs. Specify one or more
158
+ * instance type and count and the allocation strategy for instance selection.</p>
159
+ * <note>
160
+ * <p>HyperParameterTuningResourceConfig supports all of the capabilities of
161
+ * ResourceConfig with added functionality for flexible instance management.</p>
162
+ * </note>
163
+ */
164
+ export interface HyperParameterTuningResourceConfig {
165
+ /**
166
+ * <p>The instance type used to run hyperparameter optimization tuning jobs. See <a href="https://docs.aws.amazon.com/notebooks-available-instance-types.html"> descriptions of
167
+ * instance types</a> for more information.</p>
168
+ */
169
+ InstanceType?: TrainingInstanceType | string;
170
+ /**
171
+ * <p>The number of compute instances of type <code>InstanceType</code> to use. For <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/data-parallel-use-api.html">distributed training</a>, select a value greater than 1.</p>
172
+ */
173
+ InstanceCount?: number;
174
+ /**
175
+ * <p>The volume size in GB for the storage volume to be used in processing hyperparameter
176
+ * optimization jobs (optional). These volumes store model artifacts, incremental states
177
+ * and optionally, scratch space for training algorithms. Do not provide a value for this
178
+ * parameter if a value for <code>InstanceConfigs</code> is also specified.</p>
179
+ * <p>Some instance types have a fixed total local storage size. If you select one of these
180
+ * instances for training, <code>VolumeSizeInGB</code> cannot be greater than this total
181
+ * size. For a list of instance types with local instance storage and their sizes, see
182
+ * <a href="https://aws.amazon.com/releasenotes/host-instance-storage-volumes-table/">instance store volumes</a>.</p>
183
+ * <note>
184
+ * <p>SageMaker supports only the <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html">General Purpose SSD (gp2)</a> storage volume type.</p>
185
+ * </note>
186
+ */
187
+ VolumeSizeInGB?: number;
188
+ /**
189
+ * <p>A key used by AWS Key Management Service to encrypt data on the storage volume attached to the compute
190
+ * instances used to run the training job. You can use either of the following formats to
191
+ * specify a key.</p>
192
+ * <p>KMS Key ID:</p>
193
+ * <p>
194
+ * <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code>
195
+ * </p>
196
+ * <p>Amazon Resource Name (ARN) of a AWS KMS key:</p>
197
+ * <p>
198
+ * <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code>
199
+ * </p>
200
+ * <p>Some instances use local storage, which use a <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html">hardware module to encrypt</a> storage volumes. If you choose one of these
201
+ * instance types, you cannot request a <code>VolumeKmsKeyId</code>. For a list of instance
202
+ * types that use local storage, see <a href="https://aws.amazon.com/releasenotes/host-instance-storage-volumes-table/">instance store volumes</a>. For more information about AWS Key Management Service, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-security-kms-permissions.html">AWS KMS encryption</a> for more information.</p>
203
+ */
204
+ VolumeKmsKeyId?: string;
205
+ /**
206
+ * <p>The strategy that determines the order of preference for resources specified in
207
+ * <code>InstanceConfigs</code> used in hyperparameter optimization.</p>
208
+ */
209
+ AllocationStrategy?: HyperParameterTuningAllocationStrategy | string;
210
+ /**
211
+ * <p>A list containing the configuration(s) for one or more resources for processing
212
+ * hyperparameter jobs. These resources include compute instances and storage volumes to
213
+ * use in model training jobs launched by hyperparameter tuning jobs. The
214
+ * <code>AllocationStrategy</code> controls the order in which multiple configurations
215
+ * provided in <code>InstanceConfigs</code> are used.</p>
216
+ * <note>
217
+ * <p>If you only want to use a single InstanceConfig inside the
218
+ * <code>HyperParameterTuningResourceConfig</code> API, do not provide a value for
219
+ * <code>InstanceConfigs</code>. Instead, use <code>InstanceType</code>,
220
+ * <code>VolumeSizeInGB</code> and <code>InstanceCount</code>. If you use
221
+ * <code>InstanceConfigs</code>, do not provide values for
222
+ * <code>InstanceType</code>, <code>VolumeSizeInGB</code> or
223
+ * <code>InstanceCount</code>.</p>
224
+ * </note>
225
+ */
226
+ InstanceConfigs?: HyperParameterTuningInstanceConfig[];
227
+ }
126
228
  /**
127
229
  * <p>The retry strategy to use when a training job fails due to an
128
230
  * <code>InternalServerError</code>. <code>RetryStrategy</code> is specified as part of
@@ -162,8 +264,8 @@ export interface HyperParameterTrainingJobDefinition {
162
264
  * result in the training job with the best performance as measured by the objective metric
163
265
  * of the hyperparameter tuning job.</p>
164
266
  * <note>
165
- * <p>The maximum number of items specified for <code>Array Members</code> refers to
166
- * the maximum number of hyperparameters for each range and also the maximum for the
267
+ * <p>The maximum number of items specified for <code>Array Members</code> refers to the
268
+ * maximum number of hyperparameters for each range and also the maximum for the
167
269
  * hyperparameter tuning job itself. That is, the sum of the number of hyperparameters
168
270
  * for all the ranges can't exceed the maximum number specified.</p>
169
271
  * </note>
@@ -225,8 +327,11 @@ export interface HyperParameterTrainingJobDefinition {
225
327
  * training data, choose <code>File</code> as the <code>TrainingInputMode</code> in the
226
328
  * algorithm specification. For distributed training algorithms, specify an instance count
227
329
  * greater than 1.</p>
330
+ * <note>
331
+ * <p>If you want to use hyperparameter optimization with instance type flexibility, use <code>HyperParameterTuningResourceConfig</code> instead.</p>
332
+ * </note>
228
333
  */
229
- ResourceConfig: ResourceConfig | undefined;
334
+ ResourceConfig?: ResourceConfig;
230
335
  /**
231
336
  * <p>Specifies a limit to how long a model hyperparameter training job can run. It also
232
337
  * specifies how long a managed spot training job has to complete. When the job reaches the
@@ -264,6 +369,15 @@ export interface HyperParameterTrainingJobDefinition {
264
369
  * <code>InternalServerError</code>.</p>
265
370
  */
266
371
  RetryStrategy?: RetryStrategy;
372
+ /**
373
+ * <p>The configuration for the hyperparameter tuning resources, including the compute
374
+ * instances and storage volumes, used for training jobs launched by the tuning job. By
375
+ * default, storage volumes hold model artifacts and incremental states. Choose
376
+ * <code>File</code> for <code>TrainingInputMode</code> in the
377
+ * <code>AlgorithmSpecification</code>parameter to additionally store training data in
378
+ * the storage volume (optional).</p>
379
+ */
380
+ HyperParameterTuningResourceConfig?: HyperParameterTuningResourceConfig;
267
381
  }
268
382
  /**
269
383
  * <p>A previously completed or stopped hyperparameter tuning job to be used as a starting
@@ -342,9 +456,9 @@ export interface HyperParameterTuningJobWarmStartConfig {
342
456
  export interface CreateHyperParameterTuningJobRequest {
343
457
  /**
344
458
  * <p>The name of the tuning job. This name is the prefix for the names of all training jobs
345
- * that this tuning job launches. The name must be unique within the same Amazon Web Services account and
346
- * Amazon Web Services Region. The name must have 1 to 32 characters. Valid characters are a-z, A-Z, 0-9,
347
- * and : + = @ _ % - (hyphen). The name is not case sensitive.</p>
459
+ * that this tuning job launches. The name must be unique within the same Amazon Web Services account and Amazon Web Services Region. The name must have 1 to 32 characters. Valid
460
+ * characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case
461
+ * sensitive.</p>
348
462
  */
349
463
  HyperParameterTuningJobName: string | undefined;
350
464
  /**
@@ -386,10 +500,9 @@ export interface CreateHyperParameterTuningJobRequest {
386
500
  */
387
501
  WarmStartConfig?: HyperParameterTuningJobWarmStartConfig;
388
502
  /**
389
- * <p>An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in
390
- * different ways, for example, by purpose, owner, or environment. For more information,
391
- * see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
392
- * Resources</a>.</p>
503
+ * <p>An array of key-value pairs. You can use tags to categorize your Amazon Web Services
504
+ * resources in different ways, for example, by purpose, owner, or environment. For more
505
+ * information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</p>
393
506
  * <p>Tags that you specify for the tuning job are also added to all training jobs that the
394
507
  * tuning job launches.</p>
395
508
  */
@@ -2903,10 +3016,9 @@ export interface CreateModelInput {
2903
3016
  */
2904
3017
  ExecutionRoleArn: string | undefined;
2905
3018
  /**
2906
- * <p>An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in
2907
- * different ways, for example, by purpose, owner, or environment. For more information,
2908
- * see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
2909
- * Resources</a>.</p>
3019
+ * <p>An array of key-value pairs. You can use tags to categorize your Amazon Web Services
3020
+ * resources in different ways, for example, by purpose, owner, or environment. For more
3021
+ * information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</p>
2910
3022
  */
2911
3023
  Tags?: Tag[];
2912
3024
  /**
@@ -3288,8 +3400,7 @@ export interface ModelMetrics {
3288
3400
  }
3289
3401
  /**
3290
3402
  * <p>Specifies an algorithm that was used to create the model package. The algorithm must
3291
- * be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you
3292
- * are subscribed to.</p>
3403
+ * be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.</p>
3293
3404
  */
3294
3405
  export interface SourceAlgorithm {
3295
3406
  /**
@@ -3304,8 +3415,7 @@ export interface SourceAlgorithm {
3304
3415
  ModelDataUrl?: string;
3305
3416
  /**
3306
3417
  * <p>The name of an algorithm that was used to create the model package. The algorithm must
3307
- * be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you
3308
- * are subscribed to.</p>
3418
+ * be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.</p>
3309
3419
  */
3310
3420
  AlgorithmName: string | undefined;
3311
3421
  }
@@ -3974,11 +4084,11 @@ export interface CreateNotebookInstanceInput {
3974
4084
  */
3975
4085
  SecurityGroupIds?: string[];
3976
4086
  /**
3977
- * <p> When you send any requests to Amazon Web Services resources from the notebook instance, SageMaker
3978
- * assumes this role to perform tasks on your behalf. You must grant this role necessary
3979
- * permissions so SageMaker can perform these tasks. The policy must allow the SageMaker service
3980
- * principal (sagemaker.amazonaws.com) permissions to assume this role. For more
3981
- * information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html">SageMaker Roles</a>. </p>
4087
+ * <p> When you send any requests to Amazon Web Services resources from the notebook
4088
+ * instance, SageMaker assumes this role to perform tasks on your behalf. You must grant this
4089
+ * role necessary permissions so SageMaker can perform these tasks. The policy must allow the
4090
+ * SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For
4091
+ * more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html">SageMaker Roles</a>. </p>
3982
4092
  * <note>
3983
4093
  * <p>To be able to pass this role to SageMaker, the caller of this API must have the
3984
4094
  * <code>iam:PassRole</code> permission.</p>
@@ -3986,17 +4096,17 @@ export interface CreateNotebookInstanceInput {
3986
4096
  */
3987
4097
  RoleArn: string | undefined;
3988
4098
  /**
3989
- * <p>The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on
3990
- * the storage volume attached to your notebook instance. The KMS key you provide must be
3991
- * enabled. For information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html">Enabling and Disabling
3992
- * Keys</a> in the <i>Amazon Web Services Key Management Service Developer Guide</i>.</p>
4099
+ * <p>The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that
4100
+ * SageMaker uses to encrypt data on the storage volume attached to your notebook instance. The
4101
+ * KMS key you provide must be enabled. For information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html">Enabling and Disabling
4102
+ * Keys</a> in the <i>Amazon Web Services Key Management Service Developer
4103
+ * Guide</i>.</p>
3993
4104
  */
3994
4105
  KmsKeyId?: string;
3995
4106
  /**
3996
- * <p>An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in
3997
- * different ways, for example, by purpose, owner, or environment. For more information,
3998
- * see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
3999
- * Resources</a>.</p>
4107
+ * <p>An array of key-value pairs. You can use tags to categorize your Amazon Web Services
4108
+ * resources in different ways, for example, by purpose, owner, or environment. For more
4109
+ * information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</p>
4000
4110
  */
4001
4111
  Tags?: Tag[];
4002
4112
  /**
@@ -4029,18 +4139,18 @@ export interface CreateNotebookInstanceInput {
4029
4139
  /**
4030
4140
  * <p>A Git repository to associate with the notebook instance as its default code
4031
4141
  * repository. This can be either the name of a Git repository stored as a resource in your
4032
- * account, or the URL of a Git repository in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a> or in any
4033
- * other Git repository. When you open a notebook instance, it opens in the directory that
4034
- * contains this repository. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git Repositories with SageMaker
4035
- * Notebook Instances</a>.</p>
4142
+ * account, or the URL of a Git repository in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a>
4143
+ * or in any other Git repository. When you open a notebook instance, it opens in the
4144
+ * directory that contains this repository. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git
4145
+ * Repositories with SageMaker Notebook Instances</a>.</p>
4036
4146
  */
4037
4147
  DefaultCodeRepository?: string;
4038
4148
  /**
4039
4149
  * <p>An array of up to three Git repositories to associate with the notebook instance.
4040
4150
  * These can be either the names of Git repositories stored as resources in your account,
4041
- * or the URL of Git repositories in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a> or in any
4042
- * other Git repository. These repositories are cloned at the same level as the default
4043
- * repository of your notebook instance. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git
4151
+ * or the URL of Git repositories in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a>
4152
+ * or in any other Git repository. These repositories are cloned at the same level as the
4153
+ * default repository of your notebook instance. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git
4044
4154
  * Repositories with SageMaker Notebook Instances</a>.</p>
4045
4155
  */
4046
4156
  AdditionalCodeRepositories?: string[];
@@ -4891,8 +5001,8 @@ export interface TensorBoardOutputConfig {
4891
5001
  }
4892
5002
  export interface CreateTrainingJobRequest {
4893
5003
  /**
4894
- * <p>The name of the training job. The name must be unique within an Amazon Web Services Region in an
4895
- * Amazon Web Services account. </p>
5004
+ * <p>The name of the training job. The name must be unique within an Amazon Web Services
5005
+ * Region in an Amazon Web Services account. </p>
4896
5006
  */
4897
5007
  TrainingJobName: string | undefined;
4898
5008
  /**
@@ -4938,8 +5048,7 @@ export interface CreateTrainingJobRequest {
4938
5048
  * <p>Depending on the input mode that the algorithm supports, SageMaker either copies input
4939
5049
  * data files from an S3 bucket to a local directory in the Docker container, or makes it
4940
5050
  * available as input streams. For example, if you specify an EFS location, input data
4941
- * files are available as input streams. They do not need to be
4942
- * downloaded.</p>
5051
+ * files are available as input streams. They do not need to be downloaded.</p>
4943
5052
  */
4944
5053
  InputDataConfig?: Channel[];
4945
5054
  /**
@@ -4974,10 +5083,9 @@ export interface CreateTrainingJobRequest {
4974
5083
  */
4975
5084
  StoppingCondition: StoppingCondition | undefined;
4976
5085
  /**
4977
- * <p>An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in
4978
- * different ways, for example, by purpose, owner, or environment. For more information,
4979
- * see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
4980
- * Resources</a>.</p>
5086
+ * <p>An array of key-value pairs. You can use tags to categorize your Amazon Web Services
5087
+ * resources in different ways, for example, by purpose, owner, or environment. For more
5088
+ * information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</p>
4981
5089
  */
4982
5090
  Tags?: Tag[];
4983
5091
  /**
@@ -5138,11 +5246,13 @@ export interface DataProcessing {
5138
5246
  */
5139
5247
  export interface ModelClientConfig {
5140
5248
  /**
5141
- * <p>The timeout value in seconds for an invocation request. The default value is 600.</p>
5249
+ * <p>The timeout value in seconds for an invocation request. The default value is
5250
+ * 600.</p>
5142
5251
  */
5143
5252
  InvocationsTimeoutInSeconds?: number;
5144
5253
  /**
5145
- * <p>The maximum number of retries when invocation requests are failing. The default value is 3.</p>
5254
+ * <p>The maximum number of retries when invocation requests are failing. The default value
5255
+ * is 3.</p>
5146
5256
  */
5147
5257
  InvocationsMaxRetries?: number;
5148
5258
  }
@@ -6337,7 +6447,8 @@ export interface DescribeAlgorithmOutput {
6337
6447
  */
6338
6448
  ProductId?: string;
6339
6449
  /**
6340
- * <p>Whether the algorithm is certified to be listed in Amazon Web Services Marketplace.</p>
6450
+ * <p>Whether the algorithm is certified to be listed in Amazon Web Services
6451
+ * Marketplace.</p>
6341
6452
  */
6342
6453
  CertifyForMarketplace?: boolean;
6343
6454
  }
@@ -6641,8 +6752,8 @@ export interface DescribeCodeRepositoryOutput {
6641
6752
  LastModifiedTime: Date | undefined;
6642
6753
  /**
6643
6754
  * <p>Configuration details about the repository, including the URL where the repository is
6644
- * located, the default branch, and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets
6645
- * Manager secret that contains the credentials used to access the repository.</p>
6755
+ * located, the default branch, and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the
6756
+ * repository.</p>
6646
6757
  */
6647
6758
  GitConfig?: GitConfig;
6648
6759
  }
@@ -7101,12 +7212,16 @@ export interface DescribeDomainResponse {
7101
7212
  */
7102
7213
  DomainSettings?: DomainSettings;
7103
7214
  /**
7104
- * <p>The entity that creates and manages the required security groups for inter-app communication in <code>VPCOnly</code> mode.
7105
- * Required when <code>CreateDomain.AppNetworkAccessType</code> is <code>VPCOnly</code> and <code>DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn</code> is provided.</p>
7215
+ * <p>The entity that creates and manages the required security groups for inter-app
7216
+ * communication in <code>VPCOnly</code> mode. Required when
7217
+ * <code>CreateDomain.AppNetworkAccessType</code> is <code>VPCOnly</code> and
7218
+ * <code>DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn</code> is
7219
+ * provided.</p>
7106
7220
  */
7107
7221
  AppSecurityGroupManagement?: AppSecurityGroupManagement | string;
7108
7222
  /**
7109
- * <p>The ID of the security group that authorizes traffic between the <code>RSessionGateway</code> apps and the <code>RStudioServerPro</code> app.</p>
7223
+ * <p>The ID of the security group that authorizes traffic between the
7224
+ * <code>RSessionGateway</code> apps and the <code>RStudioServerPro</code> app.</p>
7110
7225
  */
7111
7226
  SecurityGroupIdForDomainBoundary?: string;
7112
7227
  }
@@ -7300,15 +7415,18 @@ export declare enum VariantStatus {
7300
7415
  */
7301
7416
  export interface ProductionVariantStatus {
7302
7417
  /**
7303
- * <p>The endpoint variant status which describes the current deployment stage status or operational status.</p>
7418
+ * <p>The endpoint variant status which describes the current deployment stage status or
7419
+ * operational status.</p>
7304
7420
  * <ul>
7305
7421
  * <li>
7306
7422
  * <p>
7307
- * <code>Creating</code>: Creating inference resources for the production variant.</p>
7423
+ * <code>Creating</code>: Creating inference resources for the production
7424
+ * variant.</p>
7308
7425
  * </li>
7309
7426
  * <li>
7310
7427
  * <p>
7311
- * <code>Deleting</code>: Terminating inference resources for the production variant.</p>
7428
+ * <code>Deleting</code>: Terminating inference resources for the production
7429
+ * variant.</p>
7312
7430
  * </li>
7313
7431
  * <li>
7314
7432
  * <p>
@@ -7316,12 +7434,13 @@ export interface ProductionVariantStatus {
7316
7434
  * </li>
7317
7435
  * <li>
7318
7436
  * <p>
7319
- * <code>ActivatingTraffic</code>: Turning on traffic for the production variant.</p>
7437
+ * <code>ActivatingTraffic</code>: Turning on traffic for the production
7438
+ * variant.</p>
7320
7439
  * </li>
7321
7440
  * <li>
7322
7441
  * <p>
7323
7442
  * <code>Baking</code>: Waiting period to monitor the CloudWatch alarms in the
7324
- * automatic rollback configuration.</p>
7443
+ * automatic rollback configuration.</p>
7325
7444
  * </li>
7326
7445
  * </ul>
7327
7446
  */
@@ -7336,16 +7455,14 @@ export interface ProductionVariantStatus {
7336
7455
  StartTime?: Date;
7337
7456
  }
7338
7457
  /**
7339
- * <p>The production variant summary for a deployment when an endpoint is
7340
- * creating or updating with the <code>
7458
+ * <p>The production variant summary for a deployment when an endpoint is creating or
7459
+ * updating with the <code>
7341
7460
  * <a>CreateEndpoint</a>
7342
- * </code>
7343
- * or <code>
7461
+ * </code> or <code>
7344
7462
  * <a>UpdateEndpoint</a>
7345
- * </code> operations.
7346
- * Describes the <code>VariantStatus </code>, weight and capacity for a production
7347
- * variant associated with an endpoint.
7348
- * </p>
7463
+ * </code> operations. Describes the <code>VariantStatus
7464
+ * </code>, weight and capacity for a production variant associated with an endpoint.
7465
+ * </p>
7349
7466
  */
7350
7467
  export interface PendingProductionVariantSummary {
7351
7468
  /**
@@ -7353,9 +7470,9 @@ export interface PendingProductionVariantSummary {
7353
7470
  */
7354
7471
  VariantName: string | undefined;
7355
7472
  /**
7356
- * <p>An array of <code>DeployedImage</code> objects that specify the Amazon EC2
7357
- * Container Registry paths of the inference images deployed on instances of this
7358
- * <code>ProductionVariant</code>.</p>
7473
+ * <p>An array of <code>DeployedImage</code> objects that specify the Amazon EC2 Container
7474
+ * Registry paths of the inference images deployed on instances of this
7475
+ * <code>ProductionVariant</code>.</p>
7359
7476
  */
7360
7477
  DeployedImages?: DeployedImage[];
7361
7478
  /**
@@ -7363,8 +7480,8 @@ export interface PendingProductionVariantSummary {
7363
7480
  */
7364
7481
  CurrentWeight?: number;
7365
7482
  /**
7366
- * <p>The requested weight for the variant in this deployment, as specified in the endpoint configuration
7367
- * for the endpoint. The value is taken from the request to the <code>
7483
+ * <p>The requested weight for the variant in this deployment, as specified in the endpoint
7484
+ * configuration for the endpoint. The value is taken from the request to the <code>
7368
7485
  * <a>CreateEndpointConfig</a>
7369
7486
  * </code> operation.</p>
7370
7487
  */
@@ -7374,8 +7491,8 @@ export interface PendingProductionVariantSummary {
7374
7491
  */
7375
7492
  CurrentInstanceCount?: number;
7376
7493
  /**
7377
- * <p>The number of instances requested in this deployment, as specified in the endpoint configuration
7378
- * for the endpoint. The value is taken from the request to the <code>
7494
+ * <p>The number of instances requested in this deployment, as specified in the endpoint
7495
+ * configuration for the endpoint. The value is taken from the request to the <code>
7379
7496
  * <a>CreateEndpointConfig</a>
7380
7497
  * </code> operation.</p>
7381
7498
  */
@@ -7387,12 +7504,13 @@ export interface PendingProductionVariantSummary {
7387
7504
  /**
7388
7505
  * <p>The size of the Elastic Inference (EI) instance to use for the production variant. EI
7389
7506
  * instances provide on-demand GPU computing for inference. For more information, see
7390
- * <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html">Using Elastic
7507
+ * <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html">Using Elastic
7391
7508
  * Inference in Amazon SageMaker</a>.</p>
7392
7509
  */
7393
7510
  AcceleratorType?: ProductionVariantAcceleratorType | string;
7394
7511
  /**
7395
- * <p>The endpoint variant status which describes the current deployment stage status or operational status.</p>
7512
+ * <p>The endpoint variant status which describes the current deployment stage status or
7513
+ * operational status.</p>
7396
7514
  */
7397
7515
  VariantStatus?: ProductionVariantStatus[];
7398
7516
  /**
@@ -7405,8 +7523,8 @@ export interface PendingProductionVariantSummary {
7405
7523
  DesiredServerlessConfig?: ProductionVariantServerlessConfig;
7406
7524
  }
7407
7525
  /**
7408
- * <p>The summary of an in-progress deployment when an endpoint is creating or
7409
- * updating with a new endpoint configuration.</p>
7526
+ * <p>The summary of an in-progress deployment when an endpoint is creating or updating with
7527
+ * a new endpoint configuration.</p>
7410
7528
  */
7411
7529
  export interface PendingDeploymentSummary {
7412
7530
  /**
@@ -7457,7 +7575,8 @@ export interface ProductionVariantSummary {
7457
7575
  */
7458
7576
  DesiredInstanceCount?: number;
7459
7577
  /**
7460
- * <p>The endpoint variant status which describes the current deployment stage status or operational status.</p>
7578
+ * <p>The endpoint variant status which describes the current deployment stage status or
7579
+ * operational status.</p>
7461
7580
  */
7462
7581
  VariantStatus?: ProductionVariantStatus[];
7463
7582
  /**
@@ -7561,8 +7680,7 @@ export interface DescribeEndpointOutput {
7561
7680
  */
7562
7681
  LastDeploymentConfig?: DeploymentConfig;
7563
7682
  /**
7564
- * <p>Returns the description of an endpoint configuration created
7565
- * using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html">
7683
+ * <p>Returns the description of an endpoint configuration created using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html">
7566
7684
  * <code>CreateEndpointConfig</code>
7567
7685
  * </a> API.</p>
7568
7686
  */
@@ -7598,8 +7716,8 @@ export interface DescribeEndpointConfigOutput {
7598
7716
  */
7599
7717
  DataCaptureConfig?: DataCaptureConfig;
7600
7718
  /**
7601
- * <p>Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage
7602
- * volume attached to the instance.</p>
7719
+ * <p>Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on
7720
+ * the ML storage volume attached to the instance.</p>
7603
7721
  */
7604
7722
  KmsKeyId?: string;
7605
7723
  /**
@@ -7607,8 +7725,7 @@ export interface DescribeEndpointConfigOutput {
7607
7725
  */
7608
7726
  CreationTime: Date | undefined;
7609
7727
  /**
7610
- * <p>Returns the description of an endpoint configuration created using the
7611
- * <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html">
7728
+ * <p>Returns the description of an endpoint configuration created using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html">
7612
7729
  * <code>CreateEndpointConfig</code>
7613
7730
  * </a> API.</p>
7614
7731
  */
@@ -7941,45 +8058,6 @@ export interface DescribeHumanTaskUiRequest {
7941
8058
  */
7942
8059
  HumanTaskUiName: string | undefined;
7943
8060
  }
7944
- export declare enum HumanTaskUiStatus {
7945
- ACTIVE = "Active",
7946
- DELETING = "Deleting"
7947
- }
7948
- /**
7949
- * <p>Container for user interface template information.</p>
7950
- */
7951
- export interface UiTemplateInfo {
7952
- /**
7953
- * <p>The URL for the user interface template.</p>
7954
- */
7955
- Url?: string;
7956
- /**
7957
- * <p>The SHA-256 digest of the contents of the template.</p>
7958
- */
7959
- ContentSha256?: string;
7960
- }
7961
- export interface DescribeHumanTaskUiResponse {
7962
- /**
7963
- * <p>The Amazon Resource Name (ARN) of the human task user interface (worker task template).</p>
7964
- */
7965
- HumanTaskUiArn: string | undefined;
7966
- /**
7967
- * <p>The name of the human task user interface (worker task template).</p>
7968
- */
7969
- HumanTaskUiName: string | undefined;
7970
- /**
7971
- * <p>The status of the human task user interface (worker task template). Valid values are listed below.</p>
7972
- */
7973
- HumanTaskUiStatus?: HumanTaskUiStatus | string;
7974
- /**
7975
- * <p>The timestamp when the human task user interface was created.</p>
7976
- */
7977
- CreationTime: Date | undefined;
7978
- /**
7979
- * <p>Container for user interface template information.</p>
7980
- */
7981
- UiTemplate: UiTemplateInfo | undefined;
7982
- }
7983
8061
  /**
7984
8062
  * @internal
7985
8063
  */
@@ -7988,6 +8066,14 @@ export declare const HyperParameterTuningJobConfigFilterSensitiveLog: (obj: Hype
7988
8066
  * @internal
7989
8067
  */
7990
8068
  export declare const HyperParameterAlgorithmSpecificationFilterSensitiveLog: (obj: HyperParameterAlgorithmSpecification) => any;
8069
+ /**
8070
+ * @internal
8071
+ */
8072
+ export declare const HyperParameterTuningInstanceConfigFilterSensitiveLog: (obj: HyperParameterTuningInstanceConfig) => any;
8073
+ /**
8074
+ * @internal
8075
+ */
8076
+ export declare const HyperParameterTuningResourceConfigFilterSensitiveLog: (obj: HyperParameterTuningResourceConfig) => any;
7991
8077
  /**
7992
8078
  * @internal
7993
8079
  */
@@ -9044,11 +9130,3 @@ export declare const DescribeFlowDefinitionResponseFilterSensitiveLog: (obj: Des
9044
9130
  * @internal
9045
9131
  */
9046
9132
  export declare const DescribeHumanTaskUiRequestFilterSensitiveLog: (obj: DescribeHumanTaskUiRequest) => any;
9047
- /**
9048
- * @internal
9049
- */
9050
- export declare const UiTemplateInfoFilterSensitiveLog: (obj: UiTemplateInfo) => any;
9051
- /**
9052
- * @internal
9053
- */
9054
- export declare const DescribeHumanTaskUiResponseFilterSensitiveLog: (obj: DescribeHumanTaskUiResponse) => any;