@aws-sdk/client-sagemaker 3.287.0 → 3.288.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.
@@ -17977,6 +17977,7 @@ const serializeAws_json1_1ProductionVariant = (input, context) => {
17977
17977
  ...(input.CoreDumpConfig != null && {
17978
17978
  CoreDumpConfig: serializeAws_json1_1ProductionVariantCoreDumpConfig(input.CoreDumpConfig, context),
17979
17979
  }),
17980
+ ...(input.EnableSSMAccess != null && { EnableSSMAccess: input.EnableSSMAccess }),
17980
17981
  ...(input.InitialInstanceCount != null && { InitialInstanceCount: input.InitialInstanceCount }),
17981
17982
  ...(input.InitialVariantWeight != null && { InitialVariantWeight: (0, smithy_client_1.serializeFloat)(input.InitialVariantWeight) }),
17982
17983
  ...(input.InstanceType != null && { InstanceType: input.InstanceType }),
@@ -27189,6 +27190,7 @@ const deserializeAws_json1_1ProductionVariant = (output, context) => {
27189
27190
  CoreDumpConfig: output.CoreDumpConfig != null
27190
27191
  ? deserializeAws_json1_1ProductionVariantCoreDumpConfig(output.CoreDumpConfig, context)
27191
27192
  : undefined,
27193
+ EnableSSMAccess: (0, smithy_client_1.expectBoolean)(output.EnableSSMAccess),
27192
27194
  InitialInstanceCount: (0, smithy_client_1.expectInt32)(output.InitialInstanceCount),
27193
27195
  InitialVariantWeight: (0, smithy_client_1.limitedParseFloat32)(output.InitialVariantWeight),
27194
27196
  InstanceType: (0, smithy_client_1.expectString)(output.InstanceType),
@@ -17363,6 +17363,7 @@ const serializeAws_json1_1ProductionVariant = (input, context) => {
17363
17363
  ...(input.CoreDumpConfig != null && {
17364
17364
  CoreDumpConfig: serializeAws_json1_1ProductionVariantCoreDumpConfig(input.CoreDumpConfig, context),
17365
17365
  }),
17366
+ ...(input.EnableSSMAccess != null && { EnableSSMAccess: input.EnableSSMAccess }),
17366
17367
  ...(input.InitialInstanceCount != null && { InitialInstanceCount: input.InitialInstanceCount }),
17367
17368
  ...(input.InitialVariantWeight != null && { InitialVariantWeight: __serializeFloat(input.InitialVariantWeight) }),
17368
17369
  ...(input.InstanceType != null && { InstanceType: input.InstanceType }),
@@ -26575,6 +26576,7 @@ const deserializeAws_json1_1ProductionVariant = (output, context) => {
26575
26576
  CoreDumpConfig: output.CoreDumpConfig != null
26576
26577
  ? deserializeAws_json1_1ProductionVariantCoreDumpConfig(output.CoreDumpConfig, context)
26577
26578
  : undefined,
26579
+ EnableSSMAccess: __expectBoolean(output.EnableSSMAccess),
26578
26580
  InitialInstanceCount: __expectInt32(output.InitialInstanceCount),
26579
26581
  InitialVariantWeight: __limitedParseFloat32(output.InitialVariantWeight),
26580
26582
  InstanceType: __expectString(output.InstanceType),
@@ -600,9 +600,10 @@ export declare class SageMaker extends SageMakerClient {
600
600
  * API.</p>
601
601
  * <p>If any of the models hosted at this endpoint get model data from an Amazon S3 location,
602
602
  * SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the
603
- * S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services account by
604
- * default. If you previously deactivated Amazon Web Services STS for a region, you need to
605
- * reactivate Amazon Web Services STS for that region. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and
603
+ * S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services
604
+ * account by default. If you previously deactivated Amazon Web Services STS for a region,
605
+ * you need to reactivate Amazon Web Services STS for that region. For more information, see
606
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and
606
607
  * Deactivating Amazon Web Services STS in an Amazon Web Services Region</a> in the
607
608
  * <i>Amazon Web Services Identity and Access Management User
608
609
  * Guide</i>.</p>
@@ -50,9 +50,10 @@ export interface CreateEndpointCommandOutput extends CreateEndpointOutput, __Met
50
50
  * API.</p>
51
51
  * <p>If any of the models hosted at this endpoint get model data from an Amazon S3 location,
52
52
  * SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the
53
- * S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services account by
54
- * default. If you previously deactivated Amazon Web Services STS for a region, you need to
55
- * reactivate Amazon Web Services STS for that region. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and
53
+ * S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services
54
+ * account by default. If you previously deactivated Amazon Web Services STS for a region,
55
+ * you need to reactivate Amazon Web Services STS for that region. For more information, see
56
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and
56
57
  * Deactivating Amazon Web Services STS in an Amazon Web Services Region</a> in the
57
58
  * <i>Amazon Web Services Identity and Access Management User
58
59
  * Guide</i>.</p>
@@ -673,7 +673,8 @@ export interface AlgorithmSpecification {
673
673
  */
674
674
  ContainerArguments?: string[];
675
675
  /**
676
- * <p>The configuration to use an image from a private Docker registry for a training job.</p>
676
+ * <p>The configuration to use an image from a private Docker registry for a training
677
+ * job.</p>
677
678
  */
678
679
  TrainingImageConfig?: TrainingImageConfig;
679
680
  }
@@ -4803,11 +4804,14 @@ export interface BatchTransformInput {
4803
4804
  EndTimeOffset?: string;
4804
4805
  }
4805
4806
  /**
4806
- * <p>A structure that keeps track of which training jobs launched by your hyperparameter tuning job are not improving model performance as evaluated against an objective function.</p>
4807
+ * <p>A structure that keeps track of which training jobs launched by your hyperparameter
4808
+ * tuning job are not improving model performance as evaluated against an objective
4809
+ * function.</p>
4807
4810
  */
4808
4811
  export interface BestObjectiveNotImproving {
4809
4812
  /**
4810
- * <p>The number of training jobs that have failed to improve model performance by 1% or greater over prior training jobs as evaluated against an objective function.</p>
4813
+ * <p>The number of training jobs that have failed to improve model performance by 1% or
4814
+ * greater over prior training jobs as evaluated against an objective function.</p>
4811
4815
  */
4812
4816
  MaxNumberOfTrainingJobsNotImproving?: number;
4813
4817
  }
@@ -5900,9 +5904,8 @@ export interface ContainerDefinition {
5900
5904
  * </note>
5901
5905
  * <p>If you provide a value for this parameter, SageMaker uses Amazon Web Services Security Token
5902
5906
  * Service to download model artifacts from the S3 path you provide. Amazon Web Services STS
5903
- * is activated in your Amazon Web Services account by default. If you previously deactivated
5904
- * Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS
5905
- * for that region. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and
5907
+ * is activated in your Amazon Web Services account by default. If you previously
5908
+ * deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and
5906
5909
  * Deactivating Amazon Web Services STS in an Amazon Web Services Region</a> in the
5907
5910
  * <i>Amazon Web Services Identity and Access Management User
5908
5911
  * Guide</i>.</p>
@@ -6055,7 +6058,9 @@ export interface ContinuousParameterRangeSpecification {
6055
6058
  MaxValue: string | undefined;
6056
6059
  }
6057
6060
  /**
6058
- * <p>A flag to indicating that automatic model tuning (AMT) has detected model convergence, defined as a lack of significant improvement (1% or less) against an objective metric.</p>
6061
+ * <p>A flag to indicating that automatic model tuning (AMT) has detected model convergence,
6062
+ * defined as a lack of significant improvement (1% or less) against an objective
6063
+ * metric.</p>
6059
6064
  */
6060
6065
  export interface ConvergenceDetected {
6061
6066
  /**
@@ -1,9 +1,13 @@
1
1
  import { LazyJsonString as __LazyJsonString } from "@aws-sdk/smithy-client";
2
2
  import { AdditionalInferenceSpecificationDefinition, AlgorithmSpecification, AnnotationConsolidationConfig, AppSpecification, AppType, ArtifactSource, AsyncInferenceConfig, AthenaDatasetDefinition, AwsManagedHumanLoopRequestSource, BatchDataCaptureConfig, BatchStrategy, BatchTransformInput, BestObjectiveNotImproving, Bias, CaptureContentTypeHeader, CaptureStatus, CategoricalParameter, CategoricalParameterRange, Channel, CheckpointConfig, CognitoConfig, CognitoMemberDefinition, CollectionConfiguration, ContainerDefinition, ContentClassifier, ContinuousParameterRange, ConvergenceDetected, DataCaptureConfig, EndpointInput, ExplainerConfig, HyperParameterScalingType, HyperParameterTuningJobObjective, InferenceSpecification, JupyterServerAppSettings, KernelGatewayAppSettings, MetadataProperties, MetricDefinition, MetricsSource, ModelApprovalStatus, MonitoringConstraintsResource, MonitoringNetworkConfig, MonitoringOutputConfig, MonitoringResources, MonitoringStatisticsResource, MonitoringStoppingCondition, OutputDataConfig, ProcessingInstanceType, ProcessingS3DataDistributionType, ProcessingS3InputMode, ProcessingS3UploadMode, ProductionVariantAcceleratorType, ProductionVariantCoreDumpConfig, ProductionVariantInstanceType, ProductionVariantServerlessConfig, ResourceConfig, StoppingCondition, Tag, TrainingInputMode, TrainingInstanceType, TransformInput, TransformJobDefinition, TransformOutput, TransformResources, UserSettings, VpcConfig } from "./models_0";
3
3
  /**
4
- * <p>Identifies a model that you want to host and the resources chosen to deploy for
4
+ * <p>
5
+ * Identifies a model that you want to host and the resources chosen to deploy for
5
6
  * hosting it. If you are deploying multiple models, tell SageMaker how to distribute traffic
6
- * among the models by specifying variant weights. </p>
7
+ * among the models by specifying variant weights. For more information on production
8
+ * variants, check <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-ab-testing.html">
9
+ * Production variants</a>.
10
+ * </p>
7
11
  */
8
12
  export interface ProductionVariant {
9
13
  /**
@@ -34,8 +38,8 @@ export interface ProductionVariant {
34
38
  /**
35
39
  * <p>The size of the Elastic Inference (EI) instance to use for the production variant. EI
36
40
  * instances provide on-demand GPU computing for inference. For more information, see
37
- * <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html">Using Elastic
38
- * Inference in Amazon SageMaker</a>.</p>
41
+ * <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html">Using Elastic
42
+ * Inference in Amazon SageMaker</a>.</p>
39
43
  */
40
44
  AcceleratorType?: ProductionVariantAcceleratorType | string;
41
45
  /**
@@ -64,6 +68,16 @@ export interface ProductionVariant {
64
68
  * SageMaker Hosting. For more information about health check, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-inference-code.html#your-algorithms-inference-algo-ping-requests">How Your Container Should Respond to Health Check (Ping) Requests</a>.</p>
65
69
  */
66
70
  ContainerStartupHealthCheckTimeoutInSeconds?: number;
71
+ /**
72
+ * <p>
73
+ * You can use this parameter to turn on native Amazon Web Services Systems Manager (SSM)
74
+ * access for a production variant behind an endpoint. By default, SSM access is disabled
75
+ * for all production variants behind an endpoints. You can turn on or turn off SSM access
76
+ * for a production variant behind an existing endpoint by creating a new endpoint
77
+ * configuration and calling <code>UpdateEndpoint</code>.
78
+ * </p>
79
+ */
80
+ EnableSSMAccess?: boolean;
67
81
  }
68
82
  export interface CreateEndpointConfigInput {
69
83
  /**
@@ -232,7 +246,7 @@ export interface S3StorageConfig {
232
246
  */
233
247
  S3Uri: string | undefined;
234
248
  /**
235
- * <p>The Amazon Web Services Key Management Service (KMS) key ID of the key used to encrypt any objects
249
+ * <p>The Amazon Web Services Key Management Service (KMS) key ARN of the key used to encrypt any objects
236
250
  * written into the <code>OfflineStore</code> S3 location.</p>
237
251
  * <p>The IAM <code>roleARN</code> that is passed as a parameter to
238
252
  * <code>CreateFeatureGroup</code> must have below permissions to the
@@ -288,7 +302,7 @@ export interface OfflineStoreConfig {
288
302
  */
289
303
  export interface OnlineStoreSecurityConfig {
290
304
  /**
291
- * <p>The ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker Feature Store uses
305
+ * <p>The Amazon Web Services Key Management Service (KMS) key ARN that SageMaker Feature Store uses
292
306
  * to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.</p>
293
307
  * <p>The caller (either IAM user or IAM role) of <code>CreateFeatureGroup</code> must have
294
308
  * below permissions to the <code>OnlineStore</code>
@@ -1539,11 +1553,14 @@ export interface TuningJobCompletionCriteria {
1539
1553
  */
1540
1554
  TargetObjectiveMetricValue?: number;
1541
1555
  /**
1542
- * <p>A flag to stop your hyperparameter tuning job if model performance fails to improve as evaluated against an objective function.</p>
1556
+ * <p>A flag to stop your hyperparameter tuning job if model performance fails to improve as
1557
+ * evaluated against an objective function.</p>
1543
1558
  */
1544
1559
  BestObjectiveNotImproving?: BestObjectiveNotImproving;
1545
1560
  /**
1546
- * <p>A flag to top your hyperparameter tuning job if automatic model tuning (AMT) has detected that your model has converged as evaluated against your objective function.</p>
1561
+ * <p>A flag to top your hyperparameter tuning job if automatic model tuning (AMT) has
1562
+ * detected that your model has converged as evaluated against your objective
1563
+ * function.</p>
1547
1564
  */
1548
1565
  ConvergenceDetected?: ConvergenceDetected;
1549
1566
  }
@@ -1946,7 +1963,7 @@ export interface HyperParameterTrainingJobDefinition {
1946
1963
  HyperParameterTuningResourceConfig?: HyperParameterTuningResourceConfig;
1947
1964
  /**
1948
1965
  * <p>An environment variable that you can pass into the SageMaker <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html">CreateTrainingJob</a> API. You can use an existing <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html#sagemaker-CreateTrainingJob-request-Environment">environment variable from the training container</a> or use your own. See
1949
- * <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics.html">Define metrics
1966
+ * <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics.html">Define metrics
1950
1967
  * and variables</a> for more information.</p>
1951
1968
  * <note>
1952
1969
  * <p>The maximum number of items specified for <code>Map Entries</code> refers to the
@@ -2093,24 +2093,21 @@ export interface DescribeHyperParameterTuningJobRequest {
2093
2093
  HyperParameterTuningJobName: string | undefined;
2094
2094
  }
2095
2095
  /**
2096
- * <p>Shows the final value for the
2097
- * objective
2098
- * metric for a training job that was launched by a hyperparameter
2099
- * tuning job. You define the objective metric in the
2096
+ * <p>Shows the latest objective metric emitted by a training job that was launched by a
2097
+ * hyperparameter tuning job. You define the objective metric in the
2100
2098
  * <code>HyperParameterTuningJobObjective</code> parameter of <a>HyperParameterTuningJobConfig</a>.</p>
2101
2099
  */
2102
2100
  export interface FinalHyperParameterTuningJobObjectiveMetric {
2103
2101
  /**
2104
- * <p>Whether to
2105
- * minimize
2106
- * or maximize the objective metric. Valid values are Minimize and
2107
- * Maximize.</p>
2102
+ * <p>Select if you want to minimize or maximize the objective metric during hyperparameter
2103
+ * tuning. </p>
2108
2104
  */
2109
2105
  Type?: HyperParameterTuningJobObjectiveType | string;
2110
2106
  /**
2111
- * <p>The name of the
2112
- * objective
2113
- * metric.</p>
2107
+ * <p>The name of the objective metric. For SageMaker built-in algorithms, metrics are defined
2108
+ * per algorithm. See the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/xgboost-tuning.html">metrics for XGBoost</a> as an
2109
+ * example. You can also use a custom algorithm for training and define your own metrics.
2110
+ * For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics-variables.html">Define metrics and environment variables</a>.</p>
2114
2111
  */
2115
2112
  MetricName: string | undefined;
2116
2113
  /**
@@ -2292,15 +2289,19 @@ export interface TrainingJobStatusCounters {
2292
2289
  Stopped?: number;
2293
2290
  }
2294
2291
  /**
2295
- * <p>A structure that contains runtime information about both current and completed hyperparameter tuning jobs.</p>
2292
+ * <p>A structure that contains runtime information about both current and completed
2293
+ * hyperparameter tuning jobs.</p>
2296
2294
  */
2297
2295
  export interface HyperParameterTuningJobCompletionDetails {
2298
2296
  /**
2299
- * <p>The number of training jobs launched by a tuning job that are not improving (1% or less) as measured by model performance evaluated against an objective function.</p>
2297
+ * <p>The number of training jobs launched by a tuning job that are not improving (1% or
2298
+ * less) as measured by model performance evaluated against an objective function.</p>
2300
2299
  */
2301
2300
  NumberOfTrainingJobsObjectiveNotImproving?: number;
2302
2301
  /**
2303
- * <p>The time in timestamp format that AMT detected model convergence, as defined by a lack of significant improvement over time based on criteria developed over a wide range of diverse benchmarking tests.</p>
2302
+ * <p>The time in timestamp format that AMT detected model convergence, as defined by a lack
2303
+ * of significant improvement over time based on criteria developed over a wide range of
2304
+ * diverse benchmarking tests.</p>
2304
2305
  */
2305
2306
  ConvergenceDetectedTime?: Date;
2306
2307
  }
@@ -2381,7 +2382,10 @@ export interface DescribeHyperParameterTuningJobResponse {
2381
2382
  */
2382
2383
  FailureReason?: string;
2383
2384
  /**
2384
- * <p>Tuning job completion information returned as the response from a hyperparameter tuning job. This information tells if your tuning job has or has not converged. It also includes the number of training jobs that have not improved model performance as evaluated against the objective function.</p>
2385
+ * <p>Tuning job completion information returned as the response from a hyperparameter
2386
+ * tuning job. This information tells if your tuning job has or has not converged. It also
2387
+ * includes the number of training jobs that have not improved model performance as
2388
+ * evaluated against the objective function.</p>
2385
2389
  */
2386
2390
  TuningJobCompletionDetails?: HyperParameterTuningJobCompletionDetails;
2387
2391
  /**
@@ -78,6 +78,7 @@ export interface ProductionVariant {
78
78
  VolumeSizeInGB?: number;
79
79
  ModelDataDownloadTimeoutInSeconds?: number;
80
80
  ContainerStartupHealthCheckTimeoutInSeconds?: number;
81
+ EnableSSMAccess?: boolean;
81
82
  }
82
83
  export interface CreateEndpointConfigInput {
83
84
  EndpointConfigName: string | undefined;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-sagemaker",
3
3
  "description": "AWS SDK for JavaScript Sagemaker Client for Node.js, Browser and React Native",
4
- "version": "3.287.0",
4
+ "version": "3.288.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,16 +20,16 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.287.0",
23
+ "@aws-sdk/client-sts": "3.288.0",
24
24
  "@aws-sdk/config-resolver": "3.287.0",
25
- "@aws-sdk/credential-provider-node": "3.287.0",
25
+ "@aws-sdk/credential-provider-node": "3.288.0",
26
26
  "@aws-sdk/fetch-http-handler": "3.282.0",
27
27
  "@aws-sdk/hash-node": "3.272.0",
28
28
  "@aws-sdk/invalid-dependency": "3.272.0",
29
29
  "@aws-sdk/middleware-content-length": "3.282.0",
30
30
  "@aws-sdk/middleware-endpoint": "3.282.0",
31
31
  "@aws-sdk/middleware-host-header": "3.282.0",
32
- "@aws-sdk/middleware-logger": "3.287.0",
32
+ "@aws-sdk/middleware-logger": "3.288.0",
33
33
  "@aws-sdk/middleware-recursion-detection": "3.282.0",
34
34
  "@aws-sdk/middleware-retry": "3.287.0",
35
35
  "@aws-sdk/middleware-serde": "3.272.0",