Skip to content

Commit 91fa4eb

Browse files
author
awstools
committed
feat(client-sagemaker): AWS SageMaker InferenceComponents now support rolling update deployments for Inference Components.
1 parent 618b5ed commit 91fa4eb

21 files changed

+925
-552
lines changed

‎clients/client-sagemaker/src/commands/CreateModelPackageCommand.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@ export interface CreateModelPackageCommandInput extends CreateModelPackageInput
3232
export interface CreateModelPackageCommandOutput extends CreateModelPackageOutput, __MetadataBearer {}
3333

3434
/**
35-
* <p>Creates a model package that you can use to create SageMaker models or list on Amazon Web Services
36-
* Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to
37-
* model packages listed on Amazon Web Services Marketplace to create models in SageMaker.</p>
35+
* <p>Creates a model package that you can use to create SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group. Buyers
36+
* can subscribe to model packages listed on Amazon Web Services Marketplace to create
37+
* models in SageMaker.</p>
3838
* <p>To create a model package by specifying a Docker container that contains your
3939
* inference code and the Amazon S3 location of your model artifacts, provide values for
40-
* <code>InferenceSpecification</code>. To create a model from an algorithm resource
40+
* <code>InferenceSpecification</code>. To create a model from an algorithm resource
4141
* that you created or subscribed to in Amazon Web Services Marketplace, provide a value for
42-
* <code>SourceAlgorithmSpecification</code>.</p>
42+
* <code>SourceAlgorithmSpecification</code>.</p>
4343
* <note>
4444
* <p>There are two types of model packages:</p>
4545
* <ul>

‎clients/client-sagemaker/src/commands/DeleteModelPackageCommand.ts

+3-2
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,9 @@ export interface DeleteModelPackageCommandOutput extends __MetadataBearer {}
2929

3030
/**
3131
* <p>Deletes a model package.</p>
32-
* <p>A model package is used to create SageMaker models or list on Amazon Web Services Marketplace. Buyers can
33-
* subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.</p>
32+
* <p>A model package is used to create SageMaker models or list on Amazon Web Services
33+
* Marketplace. Buyers can subscribe to model packages listed on Amazon Web Services
34+
* Marketplace to create models in SageMaker.</p>
3435
* @example
3536
* Use a bare-bones client and the command you need to make an API call.
3637
* ```javascript

‎clients/client-sagemaker/src/commands/DescribeInferenceComponentCommand.ts

+21
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,27 @@ export interface DescribeInferenceComponentCommandOutput extends DescribeInferen
7979
* // CreationTime: new Date("TIMESTAMP"), // required
8080
* // LastModifiedTime: new Date("TIMESTAMP"), // required
8181
* // InferenceComponentStatus: "InService" || "Creating" || "Updating" || "Failed" || "Deleting",
82+
* // LastDeploymentConfig: { // InferenceComponentDeploymentConfig
83+
* // RollingUpdatePolicy: { // InferenceComponentRollingUpdatePolicy
84+
* // MaximumBatchSize: { // InferenceComponentCapacitySize
85+
* // Type: "COPY_COUNT" || "CAPACITY_PERCENT", // required
86+
* // Value: Number("int"), // required
87+
* // },
88+
* // WaitIntervalInSeconds: Number("int"), // required
89+
* // MaximumExecutionTimeoutInSeconds: Number("int"),
90+
* // RollbackMaximumBatchSize: {
91+
* // Type: "COPY_COUNT" || "CAPACITY_PERCENT", // required
92+
* // Value: Number("int"), // required
93+
* // },
94+
* // },
95+
* // AutoRollbackConfiguration: { // AutoRollbackConfig
96+
* // Alarms: [ // AlarmList
97+
* // { // Alarm
98+
* // AlarmName: "STRING_VALUE",
99+
* // },
100+
* // ],
101+
* // },
102+
* // },
82103
* // };
83104
*
84105
* ```

‎clients/client-sagemaker/src/commands/DescribeModelPackageCommand.ts

+3-4
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,10 @@ export interface DescribeModelPackageCommandOutput extends DescribeModelPackageO
3636
* models or list them on Amazon Web Services Marketplace.</p>
3737
* <important>
3838
* <p>If you provided a KMS Key ID when you created your model package,
39-
* you will see the <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html">KMS
40-
* Decrypt</a> API call in your CloudTrail logs when you use this API.</p>
39+
* you will see the <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html">KMS Decrypt</a> API call in
40+
* your CloudTrail logs when you use this API.</p>
4141
* </important>
42-
* <p>To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services
43-
* Marketplace.</p>
42+
* <p>To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace.</p>
4443
* @example
4544
* Use a bare-bones client and the command you need to make an API call.
4645
* ```javascript

‎clients/client-sagemaker/src/commands/GetModelPackageGroupPolicyCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ export interface GetModelPackageGroupPolicyCommandOutput extends GetModelPackage
3030
/**
3131
* <p>Gets a resource policy that manages access for a model group. For information about
3232
* resource policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html">Identity-based
33-
* policies and resource-based policies</a> in the <i>Amazon Web Services Identity and
34-
* Access Management User Guide.</i>.</p>
33+
* policies and resource-based policies</a> in the <i>Amazon Web Services
34+
* Identity and Access Management User Guide.</i>.</p>
3535
* @example
3636
* Use a bare-bones client and the command you need to make an API call.
3737
* ```javascript

‎clients/client-sagemaker/src/commands/ListDataQualityJobDefinitionsCommand.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ import { Command as $Command } from "@smithy/smithy-client";
55
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { commonParams } from "../endpoint/EndpointParameters";
8-
import { ListDataQualityJobDefinitionsRequest, ListDataQualityJobDefinitionsResponse } from "../models/models_3";
8+
import { ListDataQualityJobDefinitionsRequest } from "../models/models_3";
9+
import { ListDataQualityJobDefinitionsResponse } from "../models/models_4";
910
import {
1011
de_ListDataQualityJobDefinitionsCommand,
1112
se_ListDataQualityJobDefinitionsCommand,

‎clients/client-sagemaker/src/commands/ListDeviceFleetsCommand.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client";
55
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { commonParams } from "../endpoint/EndpointParameters";
8-
import { ListDeviceFleetsRequest } from "../models/models_3";
9-
import { ListDeviceFleetsResponse } from "../models/models_4";
8+
import { ListDeviceFleetsRequest, ListDeviceFleetsResponse } from "../models/models_4";
109
import { de_ListDeviceFleetsCommand, se_ListDeviceFleetsCommand } from "../protocols/Aws_json1_1";
1110
import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
1211

‎clients/client-sagemaker/src/commands/PutModelPackageGroupPolicyCommand.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ export interface PutModelPackageGroupPolicyCommandOutput extends PutModelPackage
3030
/**
3131
* <p>Adds a resouce policy to control access to a model group. For information about
3232
* resoure policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html">Identity-based
33-
* policies and resource-based policies</a> in the <i>Amazon Web Services Identity and Access Management User Guide.</i>.</p>
33+
* policies and resource-based policies</a> in the <i>Amazon Web Services
34+
* Identity and Access Management User Guide.</i>.</p>
3435
* @example
3536
* Use a bare-bones client and the command you need to make an API call.
3637
* ```javascript

‎clients/client-sagemaker/src/commands/StopProcessingJobCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client";
55
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { commonParams } from "../endpoint/EndpointParameters";
8-
import { StopProcessingJobRequest } from "../models/models_4";
8+
import { StopProcessingJobRequest } from "../models/models_5";
99
import { de_StopProcessingJobCommand, se_StopProcessingJobCommand } from "../protocols/Aws_json1_1";
1010
import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
1111

‎clients/client-sagemaker/src/commands/StopTrainingJobCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client";
55
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { commonParams } from "../endpoint/EndpointParameters";
8-
import { StopTrainingJobRequest } from "../models/models_4";
8+
import { StopTrainingJobRequest } from "../models/models_5";
99
import { de_StopTrainingJobCommand, se_StopTrainingJobCommand } from "../protocols/Aws_json1_1";
1010
import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
1111

‎clients/client-sagemaker/src/commands/StopTransformJobCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client";
55
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { commonParams } from "../endpoint/EndpointParameters";
8-
import { StopTransformJobRequest } from "../models/models_4";
8+
import { StopTransformJobRequest } from "../models/models_5";
99
import { de_StopTransformJobCommand, se_StopTransformJobCommand } from "../protocols/Aws_json1_1";
1010
import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
1111

‎clients/client-sagemaker/src/commands/UpdateActionCommand.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client";
55
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { commonParams } from "../endpoint/EndpointParameters";
8-
import { UpdateActionRequest } from "../models/models_4";
9-
import { UpdateActionResponse } from "../models/models_5";
8+
import { UpdateActionRequest, UpdateActionResponse } from "../models/models_5";
109
import { de_UpdateActionCommand, se_UpdateActionCommand } from "../protocols/Aws_json1_1";
1110
import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
1211

‎clients/client-sagemaker/src/commands/UpdateInferenceComponentCommand.ts

+21
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,27 @@ export interface UpdateInferenceComponentCommandOutput extends UpdateInferenceCo
6161
* RuntimeConfig: { // InferenceComponentRuntimeConfig
6262
* CopyCount: Number("int"), // required
6363
* },
64+
* DeploymentConfig: { // InferenceComponentDeploymentConfig
65+
* RollingUpdatePolicy: { // InferenceComponentRollingUpdatePolicy
66+
* MaximumBatchSize: { // InferenceComponentCapacitySize
67+
* Type: "COPY_COUNT" || "CAPACITY_PERCENT", // required
68+
* Value: Number("int"), // required
69+
* },
70+
* WaitIntervalInSeconds: Number("int"), // required
71+
* MaximumExecutionTimeoutInSeconds: Number("int"),
72+
* RollbackMaximumBatchSize: {
73+
* Type: "COPY_COUNT" || "CAPACITY_PERCENT", // required
74+
* Value: Number("int"), // required
75+
* },
76+
* },
77+
* AutoRollbackConfiguration: { // AutoRollbackConfig
78+
* Alarms: [ // AlarmList
79+
* { // Alarm
80+
* AlarmName: "STRING_VALUE",
81+
* },
82+
* ],
83+
* },
84+
* },
6485
* };
6586
* const command = new UpdateInferenceComponentCommand(input);
6687
* const response = await client.send(command);

‎clients/client-sagemaker/src/models/models_0.ts

+44-35
Original file line numberDiff line numberDiff line change
@@ -533,7 +533,7 @@ export interface ModelPackageContainerDefinition {
533533
* <p>The Amazon Elastic Container Registry (Amazon ECR) path where inference code is stored.</p>
534534
* <p>If you are using your own custom algorithm instead of an algorithm provided by SageMaker,
535535
* the inference code must meet SageMaker requirements. SageMaker supports both
536-
* <code>registry/repository[:tag]</code> and <code>registry/repository[@digest]</code>
536+
* <code>registry/repository[:tag]</code> and <code>registry/repository[@digest]</code>
537537
* image path formats. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html">Using Your Own Algorithms with Amazon
538538
* SageMaker</a>.</p>
539539
* @public
@@ -550,7 +550,7 @@ export interface ModelPackageContainerDefinition {
550550
/**
551551
* <p>The Amazon S3 path where the model artifacts, which result from model training, are stored.
552552
* This path must point to a single <code>gzip</code> compressed tar archive
553-
* (<code>.tar.gz</code> suffix).</p>
553+
* (<code>.tar.gz</code> suffix).</p>
554554
* <note>
555555
* <p>The model artifacts must be in an S3 bucket that is in the same region as the
556556
* model package.</p>
@@ -573,7 +573,7 @@ export interface ModelPackageContainerDefinition {
573573

574574
/**
575575
* <p>The environment variables to set in the Docker container. Each key and value in the
576-
* <code>Environment</code> string to string map can have length of up to 1024. We
576+
* <code>Environment</code> string to string map can have length of up to 1024. We
577577
* support up to 16 entries in the map.</p>
578578
* @public
579579
*/
@@ -7783,8 +7783,15 @@ export interface BatchDeleteClusterNodesRequest {
77837783
/**
77847784
* <p>A list of node IDs to be deleted from the specified cluster.</p>
77857785
* <note>
7786-
* <p>For SageMaker HyperPod clusters using the Slurm workload manager, you cannot remove instances
7787-
* that are configured as Slurm controller nodes.</p>
7786+
* <ul>
7787+
* <li>
7788+
* <p>For SageMaker HyperPod clusters using the Slurm workload manager, you cannot remove
7789+
* instances that are configured as Slurm controller nodes.</p>
7790+
* </li>
7791+
* <li>
7792+
* <p>If you need to delete more than 99 instances, contact <a href="http://aws.amazon.com/contact-us/">Support</a> for assistance.</p>
7793+
* </li>
7794+
* </ul>
77887795
* </note>
77897796
* @public
77907797
*/
@@ -8018,8 +8025,8 @@ export interface BatchDescribeModelPackageOutput {
80188025
ModelPackageSummaries?: Record<string, BatchDescribeModelPackageSummary> | undefined;
80198026

80208027
/**
8021-
* <p>A map of the resource and BatchDescribeModelPackageError objects
8022-
* reporting the error associated with describing the model package.</p>
8028+
* <p>A map of the resource and BatchDescribeModelPackageError objects reporting the error
8029+
* associated with describing the model package.</p>
80238030
* @public
80248031
*/
80258032
BatchDescribeModelPackageErrorMap?: Record<string, BatchDescribeModelPackageError> | undefined;
@@ -8324,8 +8331,8 @@ export const TrafficRoutingConfigType = {
83248331
export type TrafficRoutingConfigType = (typeof TrafficRoutingConfigType)[keyof typeof TrafficRoutingConfigType];
83258332

83268333
/**
8327-
* <p>Defines the traffic routing strategy during an endpoint deployment to shift traffic from the
8328-
* old fleet to the new fleet.</p>
8334+
* <p>Defines the traffic routing strategy during an endpoint deployment to shift traffic
8335+
* from the old fleet to the new fleet.</p>
83298336
* @public
83308337
*/
83318338
export interface TrafficRoutingConfig {
@@ -8334,45 +8341,43 @@ export interface TrafficRoutingConfig {
83348341
* <ul>
83358342
* <li>
83368343
* <p>
8337-
* <code>ALL_AT_ONCE</code>: Endpoint traffic shifts to the new fleet
8338-
* in a single step.
8339-
* </p>
8344+
* <code>ALL_AT_ONCE</code>: Endpoint traffic shifts to the new fleet in a single
8345+
* step. </p>
83408346
* </li>
83418347
* <li>
83428348
* <p>
8343-
* <code>CANARY</code>: Endpoint traffic shifts to the new fleet
8344-
* in two steps. The first step is the canary, which is a small portion of the traffic. The
8345-
* second step is the remainder of the traffic.
8346-
* </p>
8349+
* <code>CANARY</code>: Endpoint traffic shifts to the new fleet in two steps.
8350+
* The first step is the canary, which is a small portion of the traffic. The
8351+
* second step is the remainder of the traffic. </p>
83478352
* </li>
83488353
* <li>
83498354
* <p>
8350-
* <code>LINEAR</code>: Endpoint traffic shifts to the new fleet in
8351-
* n steps of a configurable size.
8352-
* </p>
8355+
* <code>LINEAR</code>: Endpoint traffic shifts to the new fleet in n steps of a
8356+
* configurable size. </p>
83538357
* </li>
83548358
* </ul>
83558359
* @public
83568360
*/
83578361
Type: TrafficRoutingConfigType | undefined;
83588362

83598363
/**
8360-
* <p>The waiting time (in seconds) between incremental steps to turn on traffic on the
8361-
* new endpoint fleet.</p>
8364+
* <p>The waiting time (in seconds) between incremental steps to turn on traffic on the new
8365+
* endpoint fleet.</p>
83628366
* @public
83638367
*/
83648368
WaitIntervalInSeconds: number | undefined;
83658369

83668370
/**
8367-
* <p>Batch size for the first step to turn on traffic on the new endpoint fleet. <code>Value</code> must be less than
8368-
* or equal to 50% of the variant's total instance count.</p>
8371+
* <p>Batch size for the first step to turn on traffic on the new endpoint fleet.
8372+
* <code>Value</code> must be less than or equal to 50% of the variant's total instance
8373+
* count.</p>
83698374
* @public
83708375
*/
83718376
CanarySize?: CapacitySize | undefined;
83728377

83738378
/**
8374-
* <p>Batch size for each step to turn on traffic on the new endpoint fleet. <code>Value</code> must be
8375-
* 10-50% of the variant's total instance count.</p>
8379+
* <p>Batch size for each step to turn on traffic on the new endpoint fleet.
8380+
* <code>Value</code> must be 10-50% of the variant's total instance count.</p>
83768381
* @public
83778382
*/
83788383
LinearStepSize?: CapacitySize | undefined;
@@ -8907,9 +8912,9 @@ export interface CheckpointConfig {
89078912
}
89088913

89098914
/**
8910-
* <p>The container for the metadata for the ClarifyCheck step. For more information,
8911-
* see the topic on <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/build-and-manage-steps.html#step-type-clarify-check">ClarifyCheck step</a> in the <i>Amazon SageMaker Developer Guide</i>.
8912-
* </p>
8915+
* <p>The container for the metadata for the ClarifyCheck step. For more information, see
8916+
* the topic on <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/build-and-manage-steps.html#step-type-clarify-check">ClarifyCheck step</a> in the <i>Amazon SageMaker Developer
8917+
* Guide</i>. </p>
89138918
* @public
89148919
*/
89158920
export interface ClarifyCheckStepMetadata {
@@ -8944,23 +8949,27 @@ export interface ClarifyCheckStepMetadata {
89448949
ViolationReport?: string | undefined;
89458950

89468951
/**
8947-
* <p>The Amazon Resource Name (ARN) of the check processing job that was run by this step's execution.</p>
8952+
* <p>The Amazon Resource Name (ARN) of the check processing job that was run by this step's
8953+
* execution.</p>
89488954
* @public
89498955
*/
89508956
CheckJobArn?: string | undefined;
89518957

89528958
/**
8953-
* <p>This flag indicates if the drift check against the previous baseline will be skipped or not.
8954-
* If it is set to <code>False</code>, the previous baseline of the configured check type must be available.</p>
8959+
* <p>This flag indicates if the drift check against the previous baseline will be skipped
8960+
* or not. If it is set to <code>False</code>, the previous baseline of the configured
8961+
* check type must be available.</p>
89558962
* @public
89568963
*/
89578964
SkipCheck?: boolean | undefined;
89588965

89598966
/**
8960-
* <p>This flag indicates if a newly calculated baseline can be accessed through step properties
8961-
* <code>BaselineUsedForDriftCheckConstraints</code> and <code>BaselineUsedForDriftCheckStatistics</code>.
8962-
* If it is set to <code>False</code>, the previous baseline of the configured check type must also be available.
8963-
* These can be accessed through the <code>BaselineUsedForDriftCheckConstraints</code> property. </p>
8967+
* <p>This flag indicates if a newly calculated baseline can be accessed through step
8968+
* properties <code>BaselineUsedForDriftCheckConstraints</code> and
8969+
* <code>BaselineUsedForDriftCheckStatistics</code>. If it is set to
8970+
* <code>False</code>, the previous baseline of the configured check type must also be
8971+
* available. These can be accessed through the
8972+
* <code>BaselineUsedForDriftCheckConstraints</code> property. </p>
89648973
* @public
89658974
*/
89668975
RegisterNewBaseline?: boolean | undefined;

0 commit comments

Comments
 (0)