feat(client-sagemaker): Add new fields in SageMaker Hyperpod DescribeCluster API response: TargetStateCount, SoftwareUpdateStatus and ActiveSoftwareDeploymentConfig to provide AMI update progress visibility .

Author: awstools

clients/client-sagemaker/src/commands/CreateLabelingJobCommand.ts

@@ -5,8 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 
 import { commonParams } from "../endpoint/EndpointParameters";
-import { CreateLabelingJobRequest } from "../models/models_1";
-import { CreateLabelingJobResponse } from "../models/models_2";
+import { CreateLabelingJobRequest, CreateLabelingJobResponse } from "../models/models_2";
 import { de_CreateLabelingJobCommand, se_CreateLabelingJobCommand } from "../protocols/Aws_json1_1";
 import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
 

clients/client-sagemaker/src/commands/DescribeClusterCommand.ts

@@ -5,7 +5,8 @@ import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 
 import { commonParams } from "../endpoint/EndpointParameters";
-import { DescribeClusterRequest, DescribeClusterResponse } from "../models/models_2";
+import { DescribeClusterRequest } from "../models/models_2";
+import { DescribeClusterResponse } from "../models/models_3";
 import { de_DescribeClusterCommand, se_DescribeClusterCommand } from "../protocols/Aws_json1_1";
 import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
 
@@ -106,6 +107,26 @@ export interface DescribeClusterCommandOutput extends DescribeClusterResponse, _
  * //       },
  * //       CurrentImageId: "STRING_VALUE",
  * //       DesiredImageId: "STRING_VALUE",
+ * //       TargetStateCount: Number("int"),
+ * //       SoftwareUpdateStatus: "Pending" || "InProgress" || "Succeeded" || "Failed" || "RollbackInProgress" || "RollbackComplete",
+ * //       ActiveSoftwareUpdateConfig: {
+ * //         RollingUpdatePolicy: {
+ * //           MaximumBatchSize: {
+ * //             Type: "INSTANCE_COUNT" || "CAPACITY_PERCENTAGE", // required
+ * //             Value: Number("int"), // required
+ * //           },
+ * //           RollbackMaximumBatchSize: {
+ * //             Type: "INSTANCE_COUNT" || "CAPACITY_PERCENTAGE", // required
+ * //             Value: Number("int"), // required
+ * //           },
+ * //         },
+ * //         WaitIntervalInSeconds: Number("int"),
+ * //         AutoRollbackConfiguration: [
+ * //           {
+ * //             AlarmName: "STRING_VALUE", // required
+ * //           },
+ * //         ],
+ * //       },
  * //     },
  * //   ],
  * //   RestrictedInstanceGroups: [ // ClusterRestrictedInstanceGroupDetailsList
@@ -147,10 +168,7 @@ export interface DescribeClusterCommandOutput extends DescribeClusterResponse, _
  * //               Type: "INSTANCE_COUNT" || "CAPACITY_PERCENTAGE", // required
  * //               Value: Number("int"), // required
  * //             },
- * //             RollbackMaximumBatchSize: {
- * //               Type: "INSTANCE_COUNT" || "CAPACITY_PERCENTAGE", // required
- * //               Value: Number("int"), // required
- * //             },
+ * //             RollbackMaximumBatchSize: "<CapacitySizeConfig>",
  * //           },
  * //           WaitIntervalInSeconds: Number("int"),
  * //           AutoRollbackConfiguration: [

clients/client-sagemaker/src/commands/ListTrialsCommand.ts

@@ -5,8 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 
 import { commonParams } from "../endpoint/EndpointParameters";
-import { ListTrialsRequest } from "../models/models_4";
-import { ListTrialsResponse } from "../models/models_5";
+import { ListTrialsRequest, ListTrialsResponse } from "../models/models_5";
 import { de_ListTrialsCommand, se_ListTrialsCommand } from "../protocols/Aws_json1_1";
 import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
 

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

@@ -7206,6 +7206,48 @@ export interface ClusterEventSummary {
   Description?: string | undefined;
 }
 
+/**
+ * <p>The configurations that SageMaker uses when updating the AMI versions.</p>
+ * @public
+ */
+export interface RollingDeploymentPolicy {
+  /**
+   * <p>The maximum amount of instances in the cluster that SageMaker can update at a time.</p>
+   * @public
+   */
+  MaximumBatchSize: CapacitySizeConfig | undefined;
+
+  /**
+   * <p>The maximum amount of instances in the cluster that SageMaker can roll back at a time.</p>
+   * @public
+   */
+  RollbackMaximumBatchSize?: CapacitySizeConfig | undefined;
+}
+
+/**
+ * <p>The configuration to use when updating the AMI versions.</p>
+ * @public
+ */
+export interface DeploymentConfiguration {
+  /**
+   * <p>The policy that SageMaker uses when updating the AMI versions of the cluster. </p>
+   * @public
+   */
+  RollingUpdatePolicy?: RollingDeploymentPolicy | undefined;
+
+  /**
+   * <p>The duration in seconds that SageMaker waits before updating more instances in the cluster.</p>
+   * @public
+   */
+  WaitIntervalInSeconds?: number | undefined;
+
+  /**
+   * <p>An array that contains the alarms that SageMaker monitors to know whether to roll back the AMI update.</p>
+   * @public
+   */
+  AutoRollbackConfiguration?: AlarmDetails[] | undefined;
+}
+
 /**
  * <p>Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. To learn more, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-release-notes.html#sagemaker-hyperpod-release-notes-20240620">SageMaker HyperPod release notes: June 20, 2024</a>.</p>
  * @public
@@ -7404,64 +7446,40 @@ export const DeepHealthCheckType = {
 export type DeepHealthCheckType = (typeof DeepHealthCheckType)[keyof typeof DeepHealthCheckType];
 
 /**
- * <p>The configurations that SageMaker uses when updating the AMI versions.</p>
+ * <p>The configuration object of the schedule that SageMaker follows when updating the AMI.</p>
  * @public
  */
-export interface RollingDeploymentPolicy {
+export interface ScheduledUpdateConfig {
   /**
-   * <p>The maximum amount of instances in the cluster that SageMaker can update at a time.</p>
+   * <p>A cron expression that specifies the schedule that SageMaker follows when updating the AMI.</p>
    * @public
    */
-  MaximumBatchSize: CapacitySizeConfig | undefined;
+  ScheduleExpression: string | undefined;
 
   /**
-   * <p>The maximum amount of instances in the cluster that SageMaker can roll back at a time.</p>
+   * <p>The configuration to use when updating the AMI versions.</p>
    * @public
    */
-  RollbackMaximumBatchSize?: CapacitySizeConfig | undefined;
+  DeploymentConfig?: DeploymentConfiguration | undefined;
 }
 
 /**
- * <p>The configuration to use when updating the AMI versions.</p>
  * @public
+ * @enum
  */
-export interface DeploymentConfiguration {
-  /**
-   * <p>The policy that SageMaker uses when updating the AMI versions of the cluster. </p>
-   * @public
-   */
-  RollingUpdatePolicy?: RollingDeploymentPolicy | undefined;
-
-  /**
-   * <p>The duration in seconds that SageMaker waits before updating more instances in the cluster.</p>
-   * @public
-   */
-  WaitIntervalInSeconds?: number | undefined;
-
-  /**
-   * <p>An array that contains the alarms that SageMaker monitors to know whether to roll back the AMI update.</p>
-   * @public
-   */
-  AutoRollbackConfiguration?: AlarmDetails[] | undefined;
-}
+export const SoftwareUpdateStatus = {
+  FAILED: "Failed",
+  IN_PROGRESS: "InProgress",
+  PENDING: "Pending",
+  ROLLBACK_COMPLETE: "RollbackComplete",
+  ROLLBACK_IN_PROGRESS: "RollbackInProgress",
+  SUCCEEDED: "Succeeded",
+} as const;
 
 /**
- * <p>The configuration object of the schedule that SageMaker follows when updating the AMI.</p>
  * @public
  */
-export interface ScheduledUpdateConfig {
-  /**
-   * <p>A cron expression that specifies the schedule that SageMaker follows when updating the AMI.</p>
-   * @public
-   */
-  ScheduleExpression: string | undefined;
-
-  /**
-   * <p>The configuration to use when updating the AMI versions.</p>
-   * @public
-   */
-  DeploymentConfig?: DeploymentConfiguration | undefined;
-}
+export type SoftwareUpdateStatus = (typeof SoftwareUpdateStatus)[keyof typeof SoftwareUpdateStatus];
 
 /**
  * @public
@@ -7582,6 +7600,24 @@ export interface ClusterInstanceGroupDetails {
    * @public
    */
   DesiredImageId?: string | undefined;
+
+  /**
+   * <p>The number of nodes running a specific image ID since the last software update request.</p>
+   * @public
+   */
+  TargetStateCount?: number | undefined;
+
+  /**
+   * <p>Status of the last software udpate request.</p>
+   * @public
+   */
+  SoftwareUpdateStatus?: SoftwareUpdateStatus | undefined;
+
+  /**
+   * <p>The configuration to use when updating the AMI versions.</p>
+   * @public
+   */
+  ActiveSoftwareUpdateConfig?: DeploymentConfiguration | undefined;
 }
 
 /**
@@ -7917,15 +7953,3 @@ export interface ClusterOrchestratorEksConfig {
    */
   ClusterArn: string | undefined;
 }
-
-/**
- * <p>The type of orchestrator used for the SageMaker HyperPod cluster.</p>
- * @public
- */
-export interface ClusterOrchestrator {
-  /**
-   * <p>The Amazon EKS cluster used as the orchestrator for the SageMaker HyperPod cluster.</p>
-   * @public
-   */
-  Eks: ClusterOrchestratorEksConfig | undefined;
-}

clients/client-sagemaker/src/models/models_1.ts

@@ -58,7 +58,7 @@ import {
   ClusterInstanceType,
   ClusterNodeProvisioningMode,
   ClusterNodeRecovery,
-  ClusterOrchestrator,
+  ClusterOrchestratorEksConfig,
   CodeEditorAppImageConfig,
   DeepHealthCheckType,
   FeatureStatus,
@@ -85,6 +85,18 @@ import {
 
 import { SageMakerServiceException as __BaseException } from "./SageMakerServiceException";
 
+/**
+ * <p>The type of orchestrator used for the SageMaker HyperPod cluster.</p>
+ * @public
+ */
+export interface ClusterOrchestrator {
+  /**
+   * <p>The Amazon EKS cluster used as the orchestrator for the SageMaker HyperPod cluster.</p>
+   * @public
+   */
+  Eks: ClusterOrchestratorEksConfig | undefined;
+}
+
 /**
  * <p>Configuration settings for an Amazon FSx for Lustre file system to be used with the cluster.</p>
  * @public
@@ -8049,68 +8061,3 @@ export interface LabelingJobStoppingConditions {
    */
   MaxPercentageOfInputDatasetLabeled?: number | undefined;
 }
-
-/**
- * @public
- */
-export interface CreateLabelingJobRequest {
-  /**
-   * <p>The name of the labeling job. This name is used to identify the job in a list of labeling jobs. Labeling job names must be unique within an Amazon Web Services account and region. <code>LabelingJobName</code> is not case sensitive. For example, Example-job and example-job are considered the same labeling job name by Ground Truth.</p>
-   * @public
-   */
-  LabelingJobName: string | undefined;
-
-  /**
-   * <p>The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The <code>LabelAttributeName</code> must meet the following requirements.</p> <ul> <li> <p>The name can't end with "-metadata". </p> </li> <li> <p>If you are using one of the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html">built-in task types</a> or one of the following, the attribute name <i>must</i> end with "-ref".</p> <ul> <li> <p>Image semantic segmentation (<code>SemanticSegmentation)</code> and adjustment (<code>AdjustmentSemanticSegmentation</code>) labeling jobs for this task type. One exception is that verification (<code>VerificationSemanticSegmentation</code>) <i>must not</i> end with -"ref".</p> </li> <li> <p>Video frame object detection (<code>VideoObjectDetection</code>), and adjustment and verification (<code>AdjustmentVideoObjectDetection</code>) labeling jobs for this task type.</p> </li> <li> <p>Video frame object tracking (<code>VideoObjectTracking</code>), and adjustment and verification (<code>AdjustmentVideoObjectTracking</code>) labeling jobs for this task type.</p> </li> <li> <p>3D point cloud semantic segmentation (<code>3DPointCloudSemanticSegmentation</code>), and adjustment and verification (<code>Adjustment3DPointCloudSemanticSegmentation</code>) labeling jobs for this task type. </p> </li> <li> <p>3D point cloud object tracking (<code>3DPointCloudObjectTracking</code>), and adjustment and verification (<code>Adjustment3DPointCloudObjectTracking</code>) labeling jobs for this task type. </p> </li> </ul> </li> </ul> <p/> <important> <p>If you are creating an adjustment or verification labeling job, you must use a <i>different</i> <code>LabelAttributeName</code> than the one used in the original labeling job. The original labeling job is the Ground Truth labeling job that produced the labels that you want verified or adjusted. To learn more about adjustment and verification labeling jobs, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-verification-data.html">Verify and Adjust Labels</a>.</p> </important>
-   * @public
-   */
-  LabelAttributeName: string | undefined;
-
-  /**
-   * <p>Input data for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.</p> <p>You must specify at least one of the following: <code>S3DataSource</code> or <code>SnsDataSource</code>. </p> <ul> <li> <p>Use <code>SnsDataSource</code> to specify an SNS input topic for a streaming labeling job. If you do not specify and SNS input topic ARN, Ground Truth will create a one-time labeling job that stops after all data objects in the input manifest file have been labeled.</p> </li> <li> <p>Use <code>S3DataSource</code> to specify an input manifest file for both streaming and one-time labeling jobs. Adding an <code>S3DataSource</code> is optional if you use <code>SnsDataSource</code> to create a streaming labeling job.</p> </li> </ul> <p>If you use the Amazon Mechanical Turk workforce, your input data should not include confidential information, personal information or protected health information. Use <code>ContentClassifiers</code> to specify that your data is free of personally identifiable information and adult content.</p>
-   * @public
-   */
-  InputConfig: LabelingJobInputConfig | undefined;
-
-  /**
-   * <p>The location of the output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.</p>
-   * @public
-   */
-  OutputConfig: LabelingJobOutputConfig | undefined;
-
-  /**
-   * <p>The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.</p>
-   * @public
-   */
-  RoleArn: string | undefined;
-
-  /**
-   * <p>The S3 URI of the file, referred to as a <i>label category configuration file</i>, that defines the categories used to label the data objects.</p> <p>For 3D point cloud and video frame task types, you can add label category attributes and frame attributes to your label category configuration file. To learn how, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-point-cloud-label-category-config.html">Create a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs</a>. </p> <p>For named entity recognition jobs, in addition to <code>"labels"</code>, you must provide worker instructions in the label category configuration file using the <code>"instructions"</code> parameter: <code>"instructions": \{"shortInstruction":"&lt;h1&gt;Add header&lt;/h1&gt;&lt;p&gt;Add Instructions&lt;/p&gt;", "fullInstruction":"&lt;p&gt;Add additional instructions.&lt;/p&gt;"\}</code>. For details and an example, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-named-entity-recg.html#sms-creating-ner-api">Create a Named Entity Recognition Labeling Job (API) </a>.</p> <p>For all other <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html">built-in task types</a> and <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-custom-templates.html">custom tasks</a>, your label category configuration file must be a JSON file in the following format. Identify the labels you want to use by replacing <code>label_1</code>, <code>label_2</code>,<code>...</code>,<code>label_n</code> with your label categories.</p> <p> <code>\{ </code> </p> <p> <code>"document-version": "2018-11-28",</code> </p> <p> <code>"labels": [\{"label": "label_1"\},\{"label": "label_2"\},...\{"label": "label_n"\}]</code> </p> <p> <code>\}</code> </p> <p>Note the following about the label category configuration file:</p> <ul> <li> <p>For image classification and text classification (single and multi-label) you must specify at least two label categories. For all other task types, the minimum number of label categories required is one. </p> </li> <li> <p>Each label category must be unique, you cannot specify duplicate label categories.</p> </li> <li> <p>If you create a 3D point cloud or video frame adjustment or verification labeling job, you must include <code>auditLabelAttributeName</code> in the label category configuration. Use this parameter to enter the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateLabelingJob.html#sagemaker-CreateLabelingJob-request-LabelAttributeName"> <code>LabelAttributeName</code> </a> of the labeling job you want to adjust or verify annotations of.</p> </li> </ul>
-   * @public
-   */
-  LabelCategoryConfigS3Uri?: string | undefined;
-
-  /**
-   * <p>A set of conditions for stopping the labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.</p>
-   * @public
-   */
-  StoppingConditions?: LabelingJobStoppingConditions | undefined;
-
-  /**
-   * <p>Configures the information required to perform automated data labeling.</p>
-   * @public
-   */
-  LabelingJobAlgorithmsConfig?: LabelingJobAlgorithmsConfig | undefined;
-
-  /**
-   * <p>Configures the labeling task and how it is presented to workers; including, but not limited to price, keywords, and batch size (task count).</p>
-   * @public
-   */
-  HumanTaskConfig: HumanTaskConfig | undefined;
-
-  /**
-   * <p>An array of key/value pairs. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what">Using Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User Guide</i>.</p>
-   * @public
-   */
-  Tags?: Tag[] | undefined;
-}