@aws-sdk/client-sagemaker 3.161.0 → 3.164.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 +30 -0
  2. package/dist-cjs/commands/DescribeFlowDefinitionCommand.js +2 -1
  3. package/dist-cjs/commands/DescribeHumanTaskUiCommand.js +1 -2
  4. package/dist-cjs/commands/ListNotebookInstancesCommand.js +2 -1
  5. package/dist-cjs/models/models_0.js +10 -9
  6. package/dist-cjs/models/models_1.js +19 -22
  7. package/dist-cjs/models/models_2.js +21 -19
  8. package/dist-cjs/models/models_3.js +17 -4
  9. package/dist-cjs/protocols/Aws_json1_1.js +95 -0
  10. package/dist-es/commands/DescribeFlowDefinitionCommand.js +2 -1
  11. package/dist-es/commands/DescribeHumanTaskUiCommand.js +1 -2
  12. package/dist-es/commands/ListNotebookInstancesCommand.js +2 -1
  13. package/dist-es/models/models_0.js +5 -1
  14. package/dist-es/models/models_1.js +3 -9
  15. package/dist-es/models/models_2.js +9 -7
  16. package/dist-es/models/models_3.js +7 -0
  17. package/dist-es/protocols/Aws_json1_1.js +84 -3
  18. package/dist-types/SageMaker.d.ts +3 -3
  19. package/dist-types/commands/CreatePresignedDomainUrlCommand.d.ts +1 -1
  20. package/dist-types/commands/CreateUserProfileCommand.d.ts +1 -1
  21. package/dist-types/commands/DeleteDomainCommand.d.ts +1 -1
  22. package/dist-types/commands/DescribeFlowDefinitionCommand.d.ts +2 -1
  23. package/dist-types/commands/DescribeHumanTaskUiCommand.d.ts +1 -2
  24. package/dist-types/commands/ListNotebookInstancesCommand.d.ts +2 -1
  25. package/dist-types/models/models_0.d.ts +30 -32
  26. package/dist-types/models/models_1.d.ts +113 -84
  27. package/dist-types/models/models_2.d.ts +71 -86
  28. package/dist-types/models/models_3.d.ts +85 -1
  29. package/dist-types/ts3.4/commands/DescribeFlowDefinitionCommand.d.ts +2 -1
  30. package/dist-types/ts3.4/commands/DescribeHumanTaskUiCommand.d.ts +1 -2
  31. package/dist-types/ts3.4/commands/ListNotebookInstancesCommand.d.ts +2 -1
  32. package/dist-types/ts3.4/models/models_0.d.ts +6 -7
  33. package/dist-types/ts3.4/models/models_1.d.ts +38 -37
  34. package/dist-types/ts3.4/models/models_2.d.ts +39 -38
  35. package/dist-types/ts3.4/models/models_3.d.ts +38 -1
  36. package/package.json +27 -27
@@ -929,7 +929,6 @@ export interface OutputDataConfig {
929
929
  * </p>
930
930
  * </li>
931
931
  * </ul>
932
- *
933
932
  * <p>If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must
934
933
  * include permissions to call <code>kms:Encrypt</code>. If you don't provide a KMS key ID,
935
934
  * SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side
@@ -1041,20 +1040,21 @@ export interface ResourceConfig {
1041
1040
  * algorithms might also use the ML storage volume for scratch space. If you want to store
1042
1041
  * the training data in the ML storage volume, choose <code>File</code> as the
1043
1042
  * <code>TrainingInputMode</code> in the algorithm specification. </p>
1044
- * <p>You must specify sufficient ML storage for your scenario. </p>
1045
- * <note>
1046
- * <p> SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.
1047
- * </p>
1048
- * </note>
1049
- * <note>
1050
- * <p>Certain Nitro-based instances include local storage with a fixed total size,
1051
- * dependent on the instance type. When using these instances for training, SageMaker mounts
1052
- * the local instance storage instead of Amazon EBS gp2 storage. You can't request a
1053
- * <code>VolumeSizeInGB</code> greater than the total size of the local instance
1054
- * storage.</p>
1055
- * <p>For a list of instance types that support local instance storage, including the
1056
- * 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>
1057
- * </note>
1043
+ * <p>When using an ML instance with <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html#nvme-ssd-volumes">NVMe SSD
1044
+ * volumes</a>, SageMaker doesn't provision Amazon EBS General Purpose SSD (gp2) storage.
1045
+ * Available storage is fixed to the NVMe-type instance's storage capacity. SageMaker configures
1046
+ * storage paths for training datasets, checkpoints, model artifacts, and outputs to use
1047
+ * the entire capacity of the instance storage. For example, ML instance families with the
1048
+ * NVMe-type instance storage include <code>ml.p4d</code>, <code>ml.g4dn</code>, and
1049
+ * <code>ml.g5</code>. </p>
1050
+ * <p>When using an ML instance with the EBS-only storage option and without instance
1051
+ * storage, you must define the size of EBS volume through <code>VolumeSizeInGB</code> in
1052
+ * the <code>ResourceConfig</code> API. For example, ML instance families that use EBS
1053
+ * volumes include <code>ml.c5</code> and <code>ml.p2</code>. </p>
1054
+ * <p>To look up instance types and their instance storage types and volumes, see <a href="http://aws.amazon.com/ec2/instance-types/">Amazon EC2 Instance Types</a>.</p>
1055
+ * <p>To find the default local paths defined by the SageMaker training platform, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-train-storage.html">Amazon SageMaker
1056
+ * Training Storage Folders for Training Datasets, Checkpoints, Model Artifacts, and
1057
+ * Outputs</a>.</p>
1058
1058
  */
1059
1059
  VolumeSizeInGB: number | undefined;
1060
1060
  /**
@@ -1113,8 +1113,8 @@ export interface ResourceConfig {
1113
1113
  */
1114
1114
  export interface StoppingCondition {
1115
1115
  /**
1116
- * <p>The maximum length of time, in seconds, that a training or compilation job can
1117
- * run.</p>
1116
+ * <p>The maximum length of time, in seconds, that a training or compilation job can run
1117
+ * before it is stopped.</p>
1118
1118
  * <p>For compilation jobs, if the job does not complete during this time, a
1119
1119
  * <code>TimeOut</code> error is generated. We recommend starting with 900 seconds and
1120
1120
  * increasing as necessary based on your model.</p>
@@ -1123,6 +1123,9 @@ export interface StoppingCondition {
1123
1123
  * <code>MaxRuntimeInSeconds</code> specifies the maximum time for all of the attempts
1124
1124
  * in total, not each individual attempt. The default value is 1 day. The maximum value is
1125
1125
  * 28 days.</p>
1126
+ * <p>The maximum time that a <code>TrainingJob</code> can run in total, including any time spent
1127
+ * publishing metrics or archiving and uploading models after it has been stopped, is 30
1128
+ * days.</p>
1126
1129
  */
1127
1130
  MaxRuntimeInSeconds?: number;
1128
1131
  /**
@@ -3887,7 +3890,7 @@ export interface AutoMLJobCompletionCriteria {
3887
3890
  */
3888
3891
  MaxCandidates?: number;
3889
3892
  /**
3890
- * <p>The maximum time, in seconds, that each training job is allowed to run as part of a
3893
+ * <p>The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a
3891
3894
  * hyperparameter tuning job. For more information, see the used by the action.</p>
3892
3895
  */
3893
3896
  MaxRuntimePerTrainingJobInSeconds?: number;
@@ -7176,6 +7179,10 @@ export interface UserSettings {
7176
7179
  */
7177
7180
  RSessionAppSettings?: RSessionAppSettings;
7178
7181
  }
7182
+ export declare enum ExecutionRoleIdentityConfig {
7183
+ DISABLED = "DISABLED",
7184
+ USER_PROFILE_NAME = "USER_PROFILE_NAME"
7185
+ }
7179
7186
  /**
7180
7187
  * <p>A collection of settings that configure the <code>RStudioServerPro</code> Domain-level
7181
7188
  * app.</p>
@@ -7215,6 +7222,11 @@ export interface DomainSettings {
7215
7222
  * app.</p>
7216
7223
  */
7217
7224
  RStudioServerProDomainSettings?: RStudioServerProDomainSettings;
7225
+ /**
7226
+ * <p>The configuration for attaching a SageMaker user profile name to the execution role as a <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html">
7227
+ * <code>sts:SourceIdentity</code> key</a>.</p>
7228
+ */
7229
+ ExecutionRoleIdentityConfig?: ExecutionRoleIdentityConfig | string;
7218
7230
  }
7219
7231
  export interface CreateDomainRequest {
7220
7232
  /**
@@ -7592,7 +7604,6 @@ export interface ProductionVariantCoreDumpConfig {
7592
7604
  * </p>
7593
7605
  * </li>
7594
7606
  * </ul>
7595
- *
7596
7607
  * <p>If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must
7597
7608
  * include permissions to call <code>kms:Encrypt</code>. If you don't provide a KMS key ID,
7598
7609
  * SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side
@@ -8997,15 +9008,6 @@ export declare enum TrainingJobEarlyStoppingType {
8997
9008
  AUTO = "Auto",
8998
9009
  OFF = "Off"
8999
9010
  }
9000
- /**
9001
- * <p>The job completion criteria.</p>
9002
- */
9003
- export interface TuningJobCompletionCriteria {
9004
- /**
9005
- * <p>The value of the objective metric.</p>
9006
- */
9007
- TargetObjectiveMetricValue: number | undefined;
9008
- }
9009
9011
  /**
9010
9012
  * @internal
9011
9013
  */
@@ -9858,7 +9860,3 @@ export declare const ParameterRangesFilterSensitiveLog: (obj: ParameterRanges) =
9858
9860
  * @internal
9859
9861
  */
9860
9862
  export declare const ResourceLimitsFilterSensitiveLog: (obj: ResourceLimits) => any;
9861
- /**
9862
- * @internal
9863
- */
9864
- export declare const TuningJobCompletionCriteriaFilterSensitiveLog: (obj: TuningJobCompletionCriteria) => any;
@@ -1,4 +1,13 @@
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";
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, GitConfig, 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, UserContext, UserSettings, VpcConfig } from "./models_0";
2
+ /**
3
+ * <p>The job completion criteria.</p>
4
+ */
5
+ export interface TuningJobCompletionCriteria {
6
+ /**
7
+ * <p>The value of the objective metric.</p>
8
+ */
9
+ TargetObjectiveMetricValue: number | undefined;
10
+ }
2
11
  /**
3
12
  * <p>Configures a hyperparameter tuning job.</p>
4
13
  */
@@ -157,8 +166,9 @@ export interface HyperParameterTuningInstanceConfig {
157
166
  * use in training jobs launched by hyperparameter tuning jobs. Specify one or more
158
167
  * instance type and count and the allocation strategy for instance selection.</p>
159
168
  * <note>
160
- * <p>HyperParameterTuningResourceConfig supports all of the capabilities of
161
- * ResourceConfig with added functionality for flexible instance management.</p>
169
+ * <p>
170
+ * <code>HyperParameterTuningResourceConfig</code> supports all of the capabilities
171
+ * of ResourceConfig with added functionality for flexible instance management.</p>
162
172
  * </note>
163
173
  */
164
174
  export interface HyperParameterTuningResourceConfig {
@@ -179,27 +189,31 @@ export interface HyperParameterTuningResourceConfig {
179
189
  * <p>Some instance types have a fixed total local storage size. If you select one of these
180
190
  * instances for training, <code>VolumeSizeInGB</code> cannot be greater than this total
181
191
  * 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>
192
+ * <a href="http://aws.amazon.com/releasenotes/host-instance-storage-volumes-table/">instance store volumes</a>.</p>
183
193
  * <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>
194
+ * <p>SageMaker supports only the <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html">General Purpose SSD
195
+ * (gp2)</a> storage volume type.</p>
185
196
  * </note>
186
197
  */
187
198
  VolumeSizeInGB?: number;
188
199
  /**
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>
200
+ * <p>A key used by Amazon Web Services Key Management Service to encrypt data on the storage volume
201
+ * attached to the compute instances used to run the training job. You can use either of
202
+ * the following formats to specify a key.</p>
192
203
  * <p>KMS Key ID:</p>
193
204
  * <p>
194
205
  * <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code>
195
206
  * </p>
196
- * <p>Amazon Resource Name (ARN) of a AWS KMS key:</p>
207
+ * <p>Amazon Resource Name (ARN) of a KMS key:</p>
197
208
  * <p>
198
209
  * <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code>
199
210
  * </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>
211
+ * <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
212
+ * encrypt</a> storage volumes. If you choose one of these instance types, you
213
+ * cannot request a <code>VolumeKmsKeyId</code>. For a list of instance types that use
214
+ * local storage, see <a href="http://aws.amazon.com/releasenotes/host-instance-storage-volumes-table/">instance store
215
+ * volumes</a>. For more information about Amazon Web Services Key Management Service, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-security-kms-permissions.html">KMS
216
+ * encryption</a> for more information.</p>
203
217
  */
204
218
  VolumeKmsKeyId?: string;
205
219
  /**
@@ -214,7 +228,7 @@ export interface HyperParameterTuningResourceConfig {
214
228
  * <code>AllocationStrategy</code> controls the order in which multiple configurations
215
229
  * provided in <code>InstanceConfigs</code> are used.</p>
216
230
  * <note>
217
- * <p>If you only want to use a single InstanceConfig inside the
231
+ * <p>If you only want to use a single instance configuration inside the
218
232
  * <code>HyperParameterTuningResourceConfig</code> API, do not provide a value for
219
233
  * <code>InstanceConfigs</code>. Instead, use <code>InstanceType</code>,
220
234
  * <code>VolumeSizeInGB</code> and <code>InstanceCount</code>. If you use
@@ -328,8 +342,9 @@ export interface HyperParameterTrainingJobDefinition {
328
342
  * algorithm specification. For distributed training algorithms, specify an instance count
329
343
  * greater than 1.</p>
330
344
  * <note>
331
- * <p>If you want to use hyperparameter optimization with instance type flexibility, use <code>HyperParameterTuningResourceConfig</code> instead.</p>
332
- * </note>
345
+ * <p>If you want to use hyperparameter optimization with instance type flexibility, use
346
+ * <code>HyperParameterTuningResourceConfig</code> instead.</p>
347
+ * </note>
333
348
  */
334
349
  ResourceConfig?: ResourceConfig;
335
350
  /**
@@ -374,7 +389,7 @@ export interface HyperParameterTrainingJobDefinition {
374
389
  * instances and storage volumes, used for training jobs launched by the tuning job. By
375
390
  * default, storage volumes hold model artifacts and incremental states. Choose
376
391
  * <code>File</code> for <code>TrainingInputMode</code> in the
377
- * <code>AlgorithmSpecification</code>parameter to additionally store training data in
392
+ * <code>AlgorithmSpecification</code> parameter to additionally store training data in
378
393
  * the storage volume (optional).</p>
379
394
  */
380
395
  HyperParameterTuningResourceConfig?: HyperParameterTuningResourceConfig;
@@ -568,6 +583,67 @@ export interface CreateImageVersionResponse {
568
583
  */
569
584
  ImageVersionArn?: string;
570
585
  }
586
+ /**
587
+ * <p>The configuration for the payload for a recommendation job.</p>
588
+ */
589
+ export interface RecommendationJobPayloadConfig {
590
+ /**
591
+ * <p>The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).</p>
592
+ */
593
+ SamplePayloadUrl?: string;
594
+ /**
595
+ * <p>The supported MIME types for the input data.</p>
596
+ */
597
+ SupportedContentTypes?: string[];
598
+ }
599
+ /**
600
+ * <p>Specifies mandatory fields for running an Inference Recommender job directly in the
601
+ * <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceRecommendationsJob.html">CreateInferenceRecommendationsJob</a>
602
+ * API. The fields specified in <code>ContainerConfig</code> override the corresponding fields in the model package. Use
603
+ * <code>ContainerConfig</code> if you want to specify these fields for the recommendation job but don't want to edit them in your model package.</p>
604
+ */
605
+ export interface RecommendationJobContainerConfig {
606
+ /**
607
+ * <p>The machine learning domain of the model and its components.</p>
608
+ * <p>Valid Values: <code>COMPUTER_VISION | NATURAL_LANGUAGE_PROCESSING |
609
+ * MACHINE_LEARNING</code>
610
+ * </p>
611
+ */
612
+ Domain?: string;
613
+ /**
614
+ * <p>The machine learning task that the model accomplishes.</p>
615
+ * <p>Valid Values: <code>IMAGE_CLASSIFICATION | OBJECT_DETECTION
616
+ * | TEXT_GENERATION | IMAGE_SEGMENTATION | FILL_MASK | CLASSIFICATION |
617
+ * REGRESSION | OTHER</code>
618
+ * </p>
619
+ */
620
+ Task?: string;
621
+ /**
622
+ * <p>The machine learning framework of the container image.</p>
623
+ * <p>Valid Values: <code>TENSORFLOW | PYTORCH | XGBOOST | SAGEMAKER-SCIKIT-LEARN</code>
624
+ * </p>
625
+ */
626
+ Framework?: string;
627
+ /**
628
+ * <p>The framework version of the container image.</p>
629
+ */
630
+ FrameworkVersion?: string;
631
+ /**
632
+ * <p>Specifies the <code>SamplePayloadUrl</code> and all other sample payload-related fields.</p>
633
+ */
634
+ PayloadConfig?: RecommendationJobPayloadConfig;
635
+ /**
636
+ * <p>The name of a pre-trained machine learning model benchmarked by Amazon SageMaker Inference Recommender that matches your model.</p>
637
+ * <p>Valid Values: <code>efficientnetb7 | unet | xgboost | faster-rcnn-resnet101 | nasnetlarge | vgg16 | inception-v3 | mask-rcnn | sagemaker-scikit-learn |
638
+ * densenet201-gluon | resnet18v2-gluon | xception | densenet201 | yolov4 | resnet152 | bert-base-cased | xceptionV1-keras | resnet50 | retinanet</code>
639
+ * </p>
640
+ */
641
+ NearestModelName?: string;
642
+ /**
643
+ * <p>A list of the instance types that are used to generate inferences in real-time.</p>
644
+ */
645
+ SupportedInstanceTypes?: string[];
646
+ }
571
647
  /**
572
648
  * <p>Specifies the range of environment parameters</p>
573
649
  */
@@ -707,6 +783,11 @@ export interface RecommendationJobInputConfig {
707
783
  * Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.</p>
708
784
  */
709
785
  VolumeKmsKeyId?: string;
786
+ /**
787
+ * <p>Specifies mandatory fields for running an Inference Recommender job. The fields specified in <code>ContainerConfig</code>
788
+ * override the corresponding fields in the model package.</p>
789
+ */
790
+ ContainerConfig?: RecommendationJobContainerConfig;
710
791
  }
711
792
  export declare enum RecommendationJobType {
712
793
  ADVANCED = "Advanced",
@@ -5570,13 +5651,13 @@ export interface CreateUserProfileRequest {
5570
5651
  UserProfileName: string | undefined;
5571
5652
  /**
5572
5653
  * <p>A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName".
5573
- * If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified.
5654
+ * If the Domain's AuthMode is Amazon Web Services SSO, this field is required. If the Domain's AuthMode is not Amazon Web Services SSO, this field cannot be specified.
5574
5655
  * </p>
5575
5656
  */
5576
5657
  SingleSignOnUserIdentifier?: string;
5577
5658
  /**
5578
- * <p>The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is SSO, this field is
5579
- * required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified.
5659
+ * <p>The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is Amazon Web Services SSO, this field is
5660
+ * required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not Amazon Web Services SSO, this field cannot be specified.
5580
5661
  * </p>
5581
5662
  */
5582
5663
  SingleSignOnUserValue?: string;
@@ -7139,7 +7220,7 @@ export interface DescribeDomainResponse {
7139
7220
  */
7140
7221
  HomeEfsFileSystemId?: string;
7141
7222
  /**
7142
- * <p>The SSO managed application instance ID.</p>
7223
+ * <p>The Amazon Web Services SSO managed application instance ID.</p>
7143
7224
  */
7144
7225
  SingleSignOnManagedApplicationInstanceId?: string;
7145
7226
  /**
@@ -8002,62 +8083,10 @@ export interface DescribeFlowDefinitionRequest {
8002
8083
  */
8003
8084
  FlowDefinitionName: string | undefined;
8004
8085
  }
8005
- export declare enum FlowDefinitionStatus {
8006
- ACTIVE = "Active",
8007
- DELETING = "Deleting",
8008
- FAILED = "Failed",
8009
- INITIALIZING = "Initializing"
8010
- }
8011
- export interface DescribeFlowDefinitionResponse {
8012
- /**
8013
- * <p>The Amazon Resource Name (ARN) of the flow defintion.</p>
8014
- */
8015
- FlowDefinitionArn: string | undefined;
8016
- /**
8017
- * <p>The Amazon Resource Name (ARN) of the flow definition.</p>
8018
- */
8019
- FlowDefinitionName: string | undefined;
8020
- /**
8021
- * <p>The status of the flow definition. Valid values are listed below.</p>
8022
- */
8023
- FlowDefinitionStatus: FlowDefinitionStatus | string | undefined;
8024
- /**
8025
- * <p>The timestamp when the flow definition was created.</p>
8026
- */
8027
- CreationTime: Date | undefined;
8028
- /**
8029
- * <p>Container for configuring the source of human task requests. Used to specify if
8030
- * Amazon Rekognition or Amazon Textract is used as an integration source.</p>
8031
- */
8032
- HumanLoopRequestSource?: HumanLoopRequestSource;
8033
- /**
8034
- * <p>An object containing information about what triggers a human review workflow.</p>
8035
- */
8036
- HumanLoopActivationConfig?: HumanLoopActivationConfig;
8037
- /**
8038
- * <p>An object containing information about who works on the task, the workforce task price, and other task details.</p>
8039
- */
8040
- HumanLoopConfig: HumanLoopConfig | undefined;
8041
- /**
8042
- * <p>An object containing information about the output file.</p>
8043
- */
8044
- OutputConfig: FlowDefinitionOutputConfig | undefined;
8045
- /**
8046
- * <p>The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.</p>
8047
- */
8048
- RoleArn: string | undefined;
8049
- /**
8050
- * <p>The reason your flow definition failed.</p>
8051
- */
8052
- FailureReason?: string;
8053
- }
8054
- export interface DescribeHumanTaskUiRequest {
8055
- /**
8056
- * <p>The name of the human task user interface
8057
- * (worker task template) you want information about.</p>
8058
- */
8059
- HumanTaskUiName: string | undefined;
8060
- }
8086
+ /**
8087
+ * @internal
8088
+ */
8089
+ export declare const TuningJobCompletionCriteriaFilterSensitiveLog: (obj: TuningJobCompletionCriteria) => any;
8061
8090
  /**
8062
8091
  * @internal
8063
8092
  */
@@ -8114,6 +8143,14 @@ export declare const CreateImageVersionRequestFilterSensitiveLog: (obj: CreateIm
8114
8143
  * @internal
8115
8144
  */
8116
8145
  export declare const CreateImageVersionResponseFilterSensitiveLog: (obj: CreateImageVersionResponse) => any;
8146
+ /**
8147
+ * @internal
8148
+ */
8149
+ export declare const RecommendationJobPayloadConfigFilterSensitiveLog: (obj: RecommendationJobPayloadConfig) => any;
8150
+ /**
8151
+ * @internal
8152
+ */
8153
+ export declare const RecommendationJobContainerConfigFilterSensitiveLog: (obj: RecommendationJobContainerConfig) => any;
8117
8154
  /**
8118
8155
  * @internal
8119
8156
  */
@@ -9122,11 +9159,3 @@ export declare const DescribeFeatureMetadataResponseFilterSensitiveLog: (obj: De
9122
9159
  * @internal
9123
9160
  */
9124
9161
  export declare const DescribeFlowDefinitionRequestFilterSensitiveLog: (obj: DescribeFlowDefinitionRequest) => any;
9125
- /**
9126
- * @internal
9127
- */
9128
- export declare const DescribeFlowDefinitionResponseFilterSensitiveLog: (obj: DescribeFlowDefinitionResponse) => any;
9129
- /**
9130
- * @internal
9131
- */
9132
- export declare const DescribeHumanTaskUiRequestFilterSensitiveLog: (obj: DescribeHumanTaskUiRequest) => any;
@@ -1,5 +1,61 @@
1
- import { ActionSummary, AdditionalInferenceSpecificationDefinition, AgentVersion, AlgorithmSortBy, AlgorithmSpecification, AlgorithmSummary, AppDetails, AppImageConfigDetails, AppImageConfigSortKey, AppSortKey, AppSpecification, ArtifactSummary, AssociationEdgeType, AssociationSummary, AutoMLCandidate, AutoMLJobStatus, AutoMLJobSummary, AutoMLSortBy, AutoMLSortOrder, BatchStrategy, CandidateSortBy, CandidateStatus, Channel, CheckpointConfig, CodeRepositorySortBy, CodeRepositorySortOrder, CodeRepositorySummary, CognitoConfig, CompilationJobStatus, CompilationJobSummary, ContainerDefinition, ContextSummary, EdgeOutputConfig, FeatureDefinition, FeatureType, HyperParameterTuningJobObjectiveType, HyperParameterTuningJobStrategyType, InferenceSpecification, MetadataProperties, ModelApprovalStatus, ModelPackageStatus, MonitoringNetworkConfig, MonitoringOutputConfig, MonitoringResources, MonitoringStoppingCondition, ObjectiveStatus, OfflineStoreConfig, OnlineStoreConfig, OutputDataConfig, OutputParameter, ProductionVariantInstanceType, ResourceConfig, ResourceLimits, ResourceSpec, StoppingCondition, Tag, TransformInput, TransformOutput, TransformResources, UserContext, UserSettings, VpcConfig } from "./models_0";
2
- import { _InstanceType, DataCaptureConfigSummary, DataProcessing, DebugHookConfig, DebugRuleConfiguration, DebugRuleEvaluationStatus, DirectInternetAccess, DomainStatus, DriftCheckBaselines, EdgePackagingJobStatus, EndpointStatus, ExperimentConfig, ExperimentSource, FeatureGroupStatus, FeatureParameter, FlowDefinitionStatus, HumanTaskConfig, HyperParameterTrainingJobDefinition, HyperParameterTuningJobConfig, HyperParameterTuningJobWarmStartConfig, InferenceExecutionConfig, InstanceMetadataServiceConfiguration, LabelingJobAlgorithmsConfig, LabelingJobInputConfig, LabelingJobOutputConfig, LabelingJobStoppingConditions, LastUpdateStatus, MemberDefinition, ModelArtifacts, ModelBiasAppSpecification, ModelBiasBaselineConfig, ModelBiasJobInput, ModelClientConfig, ModelExplainabilityAppSpecification, ModelExplainabilityBaselineConfig, ModelExplainabilityJobInput, ModelMetrics, ModelPackageValidationSpecification, ModelQualityAppSpecification, ModelQualityBaselineConfig, ModelQualityJobInput, MonitoringScheduleConfig, MonitoringType, NetworkConfig, NotebookInstanceAcceleratorType, NotebookInstanceLifecycleHook, NotificationConfiguration, OfflineStoreStatus, OfflineStoreStatusValue, ParallelismConfiguration, ProcessingInput, ProcessingOutputConfig, ProcessingResources, ProcessingStoppingCondition, ProductionVariantSummary, ProfilerConfig, ProfilerRuleConfiguration, RecommendationJobInputConfig, RecommendationJobStoppingConditions, RecommendationJobType, RetryStrategy, RootAccess, RuleEvaluationStatus, ServiceCatalogProvisioningDetails, SourceAlgorithmSpecification, SourceIpConfig, StudioLifecycleConfigAppType, TensorBoardOutputConfig, TrialComponentArtifact, TrialComponentParameterValue, TrialComponentStatus } from "./models_1";
1
+ import { ActionSummary, AdditionalInferenceSpecificationDefinition, AgentVersion, AlgorithmSortBy, AlgorithmSpecification, AlgorithmSummary, AppDetails, AppImageConfigDetails, AppImageConfigSortKey, AppSortKey, AppSpecification, ArtifactSummary, AssociationEdgeType, AssociationSummary, AutoMLCandidate, AutoMLJobStatus, AutoMLJobSummary, AutoMLSortBy, AutoMLSortOrder, BatchStrategy, CandidateSortBy, CandidateStatus, Channel, CheckpointConfig, CodeRepositorySortBy, CodeRepositorySortOrder, CodeRepositorySummary, CognitoConfig, CompilationJobStatus, CompilationJobSummary, ContainerDefinition, ContextSummary, EdgeOutputConfig, ExecutionRoleIdentityConfig, FeatureDefinition, FeatureType, FlowDefinitionOutputConfig, HumanLoopActivationConfig, HumanLoopConfig, HumanLoopRequestSource, HyperParameterTuningJobObjectiveType, HyperParameterTuningJobStrategyType, InferenceSpecification, MetadataProperties, ModelApprovalStatus, ModelPackageStatus, MonitoringNetworkConfig, MonitoringOutputConfig, MonitoringResources, MonitoringStoppingCondition, ObjectiveStatus, OfflineStoreConfig, OnlineStoreConfig, OutputDataConfig, OutputParameter, ProductionVariantInstanceType, ResourceConfig, ResourceLimits, ResourceSpec, StoppingCondition, Tag, TransformInput, TransformOutput, TransformResources, UserContext, UserSettings, VpcConfig } from "./models_0";
2
+ import { _InstanceType, DataCaptureConfigSummary, DataProcessing, DebugHookConfig, DebugRuleConfiguration, DebugRuleEvaluationStatus, DirectInternetAccess, DomainStatus, DriftCheckBaselines, EdgePackagingJobStatus, EndpointStatus, ExperimentConfig, ExperimentSource, FeatureGroupStatus, FeatureParameter, HumanTaskConfig, HyperParameterTrainingJobDefinition, HyperParameterTuningJobConfig, HyperParameterTuningJobWarmStartConfig, InferenceExecutionConfig, InstanceMetadataServiceConfiguration, LabelingJobAlgorithmsConfig, LabelingJobInputConfig, LabelingJobOutputConfig, LabelingJobStoppingConditions, LastUpdateStatus, MemberDefinition, ModelArtifacts, ModelBiasAppSpecification, ModelBiasBaselineConfig, ModelBiasJobInput, ModelClientConfig, ModelExplainabilityAppSpecification, ModelExplainabilityBaselineConfig, ModelExplainabilityJobInput, ModelMetrics, ModelPackageValidationSpecification, ModelQualityAppSpecification, ModelQualityBaselineConfig, ModelQualityJobInput, MonitoringScheduleConfig, MonitoringType, NetworkConfig, NotebookInstanceAcceleratorType, NotebookInstanceLifecycleHook, NotificationConfiguration, OfflineStoreStatus, OfflineStoreStatusValue, ParallelismConfiguration, ProcessingInput, ProcessingOutputConfig, ProcessingResources, ProcessingStoppingCondition, ProductionVariantSummary, ProfilerConfig, ProfilerRuleConfiguration, RecommendationJobInputConfig, RecommendationJobStoppingConditions, RecommendationJobType, RetryStrategy, RootAccess, RuleEvaluationStatus, ServiceCatalogProvisioningDetails, SourceAlgorithmSpecification, SourceIpConfig, StudioLifecycleConfigAppType, TensorBoardOutputConfig, TrialComponentArtifact, TrialComponentParameterValue, TrialComponentStatus } from "./models_1";
3
+ export declare enum FlowDefinitionStatus {
4
+ ACTIVE = "Active",
5
+ DELETING = "Deleting",
6
+ FAILED = "Failed",
7
+ INITIALIZING = "Initializing"
8
+ }
9
+ export interface DescribeFlowDefinitionResponse {
10
+ /**
11
+ * <p>The Amazon Resource Name (ARN) of the flow defintion.</p>
12
+ */
13
+ FlowDefinitionArn: string | undefined;
14
+ /**
15
+ * <p>The Amazon Resource Name (ARN) of the flow definition.</p>
16
+ */
17
+ FlowDefinitionName: string | undefined;
18
+ /**
19
+ * <p>The status of the flow definition. Valid values are listed below.</p>
20
+ */
21
+ FlowDefinitionStatus: FlowDefinitionStatus | string | undefined;
22
+ /**
23
+ * <p>The timestamp when the flow definition was created.</p>
24
+ */
25
+ CreationTime: Date | undefined;
26
+ /**
27
+ * <p>Container for configuring the source of human task requests. Used to specify if
28
+ * Amazon Rekognition or Amazon Textract is used as an integration source.</p>
29
+ */
30
+ HumanLoopRequestSource?: HumanLoopRequestSource;
31
+ /**
32
+ * <p>An object containing information about what triggers a human review workflow.</p>
33
+ */
34
+ HumanLoopActivationConfig?: HumanLoopActivationConfig;
35
+ /**
36
+ * <p>An object containing information about who works on the task, the workforce task price, and other task details.</p>
37
+ */
38
+ HumanLoopConfig: HumanLoopConfig | undefined;
39
+ /**
40
+ * <p>An object containing information about the output file.</p>
41
+ */
42
+ OutputConfig: FlowDefinitionOutputConfig | undefined;
43
+ /**
44
+ * <p>The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.</p>
45
+ */
46
+ RoleArn: string | undefined;
47
+ /**
48
+ * <p>The reason your flow definition failed.</p>
49
+ */
50
+ FailureReason?: string;
51
+ }
52
+ export interface DescribeHumanTaskUiRequest {
53
+ /**
54
+ * <p>The name of the human task user interface
55
+ * (worker task template) you want information about.</p>
56
+ */
57
+ HumanTaskUiName: string | undefined;
58
+ }
3
59
  export declare enum HumanTaskUiStatus {
4
60
  ACTIVE = "Active",
5
61
  DELETING = "Deleting"
@@ -3004,11 +3060,11 @@ export interface DescribeUserProfileResponse {
3004
3060
  */
3005
3061
  FailureReason?: string;
3006
3062
  /**
3007
- * <p>The SSO user identifier.</p>
3063
+ * <p>The Amazon Web Services SSO user identifier.</p>
3008
3064
  */
3009
3065
  SingleSignOnUserIdentifier?: string;
3010
3066
  /**
3011
- * <p>The SSO user value.</p>
3067
+ * <p>The Amazon Web Services SSO user value.</p>
3012
3068
  */
3013
3069
  SingleSignOnUserValue?: string;
3014
3070
  /**
@@ -3482,6 +3538,11 @@ export interface DomainSettingsForUpdate {
3482
3538
  * update.</p>
3483
3539
  */
3484
3540
  RStudioServerProDomainSettingsForUpdate?: RStudioServerProDomainSettingsForUpdate;
3541
+ /**
3542
+ * <p>The configuration for attaching a SageMaker user profile name to the execution role as a <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html">
3543
+ * <code>sts:SourceIdentity</code> key</a>. This configuration can only be modified if there are no apps in the <code>InService</code> or <code>Pending</code> state.</p>
3544
+ */
3545
+ ExecutionRoleIdentityConfig?: ExecutionRoleIdentityConfig | string;
3485
3546
  }
3486
3547
  /**
3487
3548
  * <p>A directed edge connecting two lineage entities.</p>
@@ -7312,81 +7373,13 @@ export interface ListNotebookInstancesInput {
7312
7373
  AdditionalCodeRepositoryEquals?: string;
7313
7374
  }
7314
7375
  /**
7315
- * <p>Provides summary information for an SageMaker notebook instance.</p>
7376
+ * @internal
7316
7377
  */
7317
- export interface NotebookInstanceSummary {
7318
- /**
7319
- * <p>The name of the notebook instance that you want a summary for.</p>
7320
- */
7321
- NotebookInstanceName: string | undefined;
7322
- /**
7323
- * <p>The Amazon Resource Name (ARN) of the notebook instance.</p>
7324
- */
7325
- NotebookInstanceArn: string | undefined;
7326
- /**
7327
- * <p>The status of the notebook instance.</p>
7328
- */
7329
- NotebookInstanceStatus?: NotebookInstanceStatus | string;
7330
- /**
7331
- * <p>The URL that you use to connect to the Jupyter notebook running in your notebook
7332
- * instance. </p>
7333
- */
7334
- Url?: string;
7335
- /**
7336
- * <p>The type of ML compute instance that the notebook instance is running on.</p>
7337
- */
7338
- InstanceType?: _InstanceType | string;
7339
- /**
7340
- * <p>A timestamp that shows when the notebook instance was created.</p>
7341
- */
7342
- CreationTime?: Date;
7343
- /**
7344
- * <p>A timestamp that shows when the notebook instance was last modified.</p>
7345
- */
7346
- LastModifiedTime?: Date;
7347
- /**
7348
- * <p>The name of a notebook instance lifecycle configuration associated with this notebook
7349
- * instance.</p>
7350
- * <p>For information about notebook instance lifestyle configurations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html">Step
7351
- * 2.1: (Optional) Customize a Notebook Instance</a>.</p>
7352
- */
7353
- NotebookInstanceLifecycleConfigName?: string;
7354
- /**
7355
- * <p>The Git repository associated with the notebook instance as its default code
7356
- * repository. This can be either the name of a Git repository stored as a resource in your
7357
- * 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>
7358
- * or in any other Git repository. When you open a notebook instance, it opens in the
7359
- * 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
7360
- * Repositories with SageMaker Notebook Instances</a>.</p>
7361
- */
7362
- DefaultCodeRepository?: string;
7363
- /**
7364
- * <p>An array of up to three Git repositories associated with the notebook instance. These
7365
- * can be either the names of Git repositories stored as resources in your account, or the
7366
- * URL of Git repositories in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a>
7367
- * or in any other Git repository. These repositories are cloned at the same level as the
7368
- * 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
7369
- * Repositories with SageMaker Notebook Instances</a>.</p>
7370
- */
7371
- AdditionalCodeRepositories?: string[];
7372
- }
7373
- export interface ListNotebookInstancesOutput {
7374
- /**
7375
- * <p>If the response to the previous <code>ListNotebookInstances</code> request was
7376
- * truncated, SageMaker returns this token. To retrieve the next set of notebook instances, use
7377
- * the token in the next request.</p>
7378
- */
7379
- NextToken?: string;
7380
- /**
7381
- * <p>An array of <code>NotebookInstanceSummary</code> objects, one for each notebook
7382
- * instance.</p>
7383
- */
7384
- NotebookInstances?: NotebookInstanceSummary[];
7385
- }
7386
- export declare enum SortPipelineExecutionsBy {
7387
- CREATION_TIME = "CreationTime",
7388
- PIPELINE_EXECUTION_ARN = "PipelineExecutionArn"
7389
- }
7378
+ export declare const DescribeFlowDefinitionResponseFilterSensitiveLog: (obj: DescribeFlowDefinitionResponse) => any;
7379
+ /**
7380
+ * @internal
7381
+ */
7382
+ export declare const DescribeHumanTaskUiRequestFilterSensitiveLog: (obj: DescribeHumanTaskUiRequest) => any;
7390
7383
  /**
7391
7384
  * @internal
7392
7385
  */
@@ -8323,11 +8316,3 @@ export declare const ListNotebookInstanceLifecycleConfigsOutputFilterSensitiveLo
8323
8316
  * @internal
8324
8317
  */
8325
8318
  export declare const ListNotebookInstancesInputFilterSensitiveLog: (obj: ListNotebookInstancesInput) => any;
8326
- /**
8327
- * @internal
8328
- */
8329
- export declare const NotebookInstanceSummaryFilterSensitiveLog: (obj: NotebookInstanceSummary) => any;
8330
- /**
8331
- * @internal
8332
- */
8333
- export declare const ListNotebookInstancesOutputFilterSensitiveLog: (obj: ListNotebookInstancesOutput) => any;