feat(client-sagemaker): Amazon SageMaker Training now provides model …

…training container access for debugging purposes. Amazon SageMaker Search now provides the ability to use visibility conditions to limit resource access to a single domain or multiple domains.
aws · Dec 21, 2023 · d7c4e6f · d7c4e6f
1 parent 6325d6e
commit d7c4e6f
Show file tree

Hide file tree

Showing 9 changed files with 414 additions and 184 deletions.
diff --git a/clients/client-sagemaker/src/commands/CreateTrainingJobCommand.ts b/clients/client-sagemaker/src/commands/CreateTrainingJobCommand.ts
@@ -292,6 +292,9 @@ export interface CreateTrainingJobCommandOutput extends CreateTrainingJobRespons
  *   RetryStrategy: { // RetryStrategy
  *     MaximumRetryAttempts: Number("int"), // required
  *   },
+ *   RemoteDebugConfig: { // RemoteDebugConfig
+ *     EnableRemoteDebug: true || false,
+ *   },
  *   InfraCheckConfig: { // InfraCheckConfig
  *     EnableInfraCheck: true || false,
  *   },

diff --git a/clients/client-sagemaker/src/commands/DescribeTrainingJobCommand.ts b/clients/client-sagemaker/src/commands/DescribeTrainingJobCommand.ts
@@ -276,6 +276,9 @@ export interface DescribeTrainingJobCommandOutput extends DescribeTrainingJobRes
  * //   RetryStrategy: { // RetryStrategy
  * //     MaximumRetryAttempts: Number("int"), // required
  * //   },
+ * //   RemoteDebugConfig: { // RemoteDebugConfig
+ * //     EnableRemoteDebug: true || false,
+ * //   },
  * //   InfraCheckConfig: { // InfraCheckConfig
  * //     EnableInfraCheck: true || false,
  * //   },

diff --git a/clients/client-sagemaker/src/commands/SearchCommand.ts b/clients/client-sagemaker/src/commands/SearchCommand.ts
@@ -103,6 +103,12 @@ export interface SearchCommandOutput extends SearchResponse, __MetadataBearer {}
  *   NextToken: "STRING_VALUE",
  *   MaxResults: Number("int"),
  *   CrossAccountFilterOption: "SameAccount" || "CrossAccount",
+ *   VisibilityConditions: [ // VisibilityConditionsList
+ *     { // VisibilityConditions
+ *       Key: "STRING_VALUE",
+ *       Value: "STRING_VALUE",
+ *     },
+ *   ],
  * };
  * const command = new SearchCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-sagemaker/src/commands/UpdateTrainingJobCommand.ts b/clients/client-sagemaker/src/commands/UpdateTrainingJobCommand.ts
@@ -71,6 +71,9 @@ export interface UpdateTrainingJobCommandOutput extends UpdateTrainingJobRespons
  *   ResourceConfig: { // ResourceConfigForUpdate
  *     KeepAlivePeriodInSeconds: Number("int"), // required
  *   },
+ *   RemoteDebugConfig: { // RemoteDebugConfigForUpdate
+ *     EnableRemoteDebug: true || false,
+ *   },
  * };
  * const command = new UpdateTrainingJobCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-sagemaker/src/models/models_2.ts b/clients/client-sagemaker/src/models/models_2.ts
@@ -224,6 +224,20 @@ export interface ProfilerRuleConfiguration {
   RuleParameters?: Record<string, string>;
 }
 
+/**
+ * @public
+ * <p>Configuration for remote debugging for the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html">CreateTrainingJob</a> API. To learn more about the remote
+ *             debugging functionality of SageMaker, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html">Access a training container through Amazon Web Services Systems Manager (SSM)
+ *                 for remote debugging</a>.</p>
+ */
+export interface RemoteDebugConfig {
+  /**
+   * @public
+   * <p>If set to True, enables remote debugging.</p>
+   */
+  EnableRemoteDebug?: boolean;
+}
+
 /**
  * @public
  * <p>Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.</p>
@@ -476,6 +490,14 @@ export interface CreateTrainingJobRequest {
    */
   RetryStrategy?: RetryStrategy;
 
+  /**
+   * @public
+   * <p>Configuration for remote debugging. To learn more about the remote
+   *             debugging functionality of SageMaker, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html">Access a training container through Amazon Web Services Systems Manager (SSM)
+   *                 for remote debugging</a>.</p>
+   */
+  RemoteDebugConfig?: RemoteDebugConfig;
+
   /**
    * @public
    * <p>Contains information about the infrastructure health check configuration for the training job.</p>
@@ -10002,30 +10024,6 @@ export interface DescribeTrainingJobRequest {
   TrainingJobName: string | undefined;
 }
 
-/**
- * @public
- * <p>The name, value, and date and time of a metric that was emitted to Amazon CloudWatch.</p>
- */
-export interface MetricData {
-  /**
-   * @public
-   * <p>The name of the metric.</p>
-   */
-  MetricName?: string;
-
-  /**
-   * @public
-   * <p>The value of the metric.</p>
-   */
-  Value?: number;
-
-  /**
-   * @public
-   * <p>The date and time that the algorithm emitted the metric.</p>
-   */
-  Timestamp?: Date;
-}
-
 /**
  * @internal
  */

diff --git a/clients/client-sagemaker/src/models/models_3.ts b/clients/client-sagemaker/src/models/models_3.ts
@@ -14,18 +14,15 @@ import {
   AssociationSummary,
   AutoMLCandidate,
   AutoMLJobStatus,
-  AutoMLJobStepMetadata,
   AutoMLJobSummary,
   AutoMLSortBy,
   AutoMLSortOrder,
   BatchDataCaptureConfig,
   BatchStrategy,
-  CallbackStepMetadata,
   CandidateSortBy,
   CandidateStatus,
   Channel,
   CheckpointConfig,
-  ClarifyCheckStepMetadata,
   ClusterNodeSummary,
   ClusterSortBy,
   ClusterSummary,
@@ -35,7 +32,6 @@ import {
   CognitoConfig,
   CompilationJobStatus,
   CompilationJobSummary,
-  ConditionStepMetadata,
   ContextSummary,
   MetadataProperties,
   ModelApprovalStatus,
@@ -113,7 +109,6 @@ import {
   LabelingJobStatus,
   LastUpdateStatus,
   MemberDefinition,
-  MetricData,
   ModelArtifacts,
   ModelCardExportJobStatus,
   ModelClientConfig,
@@ -130,6 +125,7 @@ import {
   ProfilerRuleConfiguration,
   RecommendationJobStatus,
   RecommendationMetrics,
+  RemoteDebugConfig,
   RuleEvaluationStatus,
   ScheduleStatus,
   SourceIpConfig,
@@ -141,6 +137,30 @@ import {
   TrialComponentStatus,
 } from "./models_2";
 
+/**
+ * @public
+ * <p>The name, value, and date and time of a metric that was emitted to Amazon CloudWatch.</p>
+ */
+export interface MetricData {
+  /**
+   * @public
+   * <p>The name of the metric.</p>
+   */
+  MetricName?: string;
+
+  /**
+   * @public
+   * <p>The value of the metric.</p>
+   */
+  Value?: number;
+
+  /**
+   * @public
+   * <p>The date and time that the algorithm emitted the metric.</p>
+   */
+  Timestamp?: Date;
+}
+
 /**
  * @public
  * <p>Information about the status of the rule evaluation.</p>
@@ -378,9 +398,6 @@ export interface SecondaryStatusTransition {
    *             <dd>
    *                <ul>
    *                   <li>
-   *                      <p>Downloading the training image.</p>
-   *                   </li>
-   *                   <li>
    *                      <p>Training
    *                                 image download completed. Training in
    *                                 progress.</p>
@@ -931,6 +948,14 @@ export interface DescribeTrainingJobResponse {
    */
   RetryStrategy?: RetryStrategy;
 
+  /**
+   * @public
+   * <p>Configuration for remote debugging. To learn more about the remote
+   *             debugging functionality of SageMaker, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html">Access a training container through Amazon Web Services Systems Manager (SSM)
+   *                 for remote debugging</a>.</p>
+   */
+  RemoteDebugConfig?: RemoteDebugConfig;
+
   /**
    * @public
    * <p>Contains information about the infrastructure health check configuration for the training job.</p>
@@ -11091,150 +11116,3 @@ export interface TuningJobStepMetaData {
    */
   Arn?: string;
 }
-
-/**
- * @public
- * <p>Metadata for a step execution.</p>
- */
-export interface PipelineExecutionStepMetadata {
-  /**
-   * @public
-   * <p>The Amazon Resource Name (ARN) of the training job that was run by this step execution.</p>
-   */
-  TrainingJob?: TrainingJobStepMetadata;
-
-  /**
-   * @public
-   * <p>The Amazon Resource Name (ARN) of the processing job that was run by this step execution.</p>
-   */
-  ProcessingJob?: ProcessingJobStepMetadata;
-
-  /**
-   * @public
-   * <p>The Amazon Resource Name (ARN) of the transform job that was run by this step execution.</p>
-   */
-  TransformJob?: TransformJobStepMetadata;
-
-  /**
-   * @public
-   * <p>The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.</p>
-   */
-  TuningJob?: TuningJobStepMetaData;
-
-  /**
-   * @public
-   * <p>The Amazon Resource Name (ARN) of the model that was created by this step execution.</p>
-   */
-  Model?: ModelStepMetadata;
-
-  /**
-   * @public
-   * <p>The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.</p>
-   */
-  RegisterModel?: RegisterModelStepMetadata;
-
-  /**
-   * @public
-   * <p>The outcome of the condition evaluation that was run by this step execution.</p>
-   */
-  Condition?: ConditionStepMetadata;
-
-  /**
-   * @public
-   * <p>The URL of the Amazon SQS queue used by this step execution, the pipeline generated token,
-   *         and a list of output parameters.</p>
-   */
-  Callback?: CallbackStepMetadata;
-
-  /**
-   * @public
-   * <p>The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of
-   *         output parameters.</p>
-   */
-  Lambda?: LambdaStepMetadata;
-
-  /**
-   * @public
-   * <p>The configurations and outcomes of an Amazon EMR step execution.</p>
-   */
-  EMR?: EMRStepMetadata;
-
-  /**
-   * @public
-   * <p>The configurations and outcomes of the check step execution. This includes: </p>
-   *          <ul>
-   *             <li>
-   *                <p>The type of the check conducted.</p>
-   *             </li>
-   *             <li>
-   *                <p>The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.</p>
-   *             </li>
-   *             <li>
-   *                <p>The Amazon S3 URIs of newly calculated baseline constraints and statistics.</p>
-   *             </li>
-   *             <li>
-   *                <p>The model package group name provided.</p>
-   *             </li>
-   *             <li>
-   *                <p>The Amazon S3 URI of the violation report if violations detected.</p>
-   *             </li>
-   *             <li>
-   *                <p>The Amazon Resource Name (ARN) of check processing job initiated by the step execution.</p>
-   *             </li>
-   *             <li>
-   *                <p>The Boolean flags indicating if the drift check is skipped.</p>
-   *             </li>
-   *             <li>
-   *                <p>If step property <code>BaselineUsedForDriftCheck</code> is set the same as
-   *             <code>CalculatedBaseline</code>.</p>
-   *             </li>
-   *          </ul>
-   */
-  QualityCheck?: QualityCheckStepMetadata;
-
-  /**
-   * @public
-   * <p>Container for the metadata for a Clarify check step. The configurations
-   *          and outcomes of the check step execution. This includes: </p>
-   *          <ul>
-   *             <li>
-   *                <p>The type of the check conducted,</p>
-   *             </li>
-   *             <li>
-   *                <p>The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.</p>
-   *             </li>
-   *             <li>
-   *                <p>The Amazon S3 URIs of newly calculated baseline constraints and statistics.</p>
-   *             </li>
-   *             <li>
-   *                <p>The model package group name provided.</p>
-   *             </li>
-   *             <li>
-   *                <p>The Amazon S3 URI of the violation report if violations detected.</p>
-   *             </li>
-   *             <li>
-   *                <p>The Amazon Resource Name (ARN) of check processing job initiated by the step execution.</p>
-   *             </li>
-   *             <li>
-   *                <p>The boolean flags indicating if the drift check is skipped.</p>
-   *             </li>
-   *             <li>
-   *                <p>If step property <code>BaselineUsedForDriftCheck</code> is set the same as
-   *             <code>CalculatedBaseline</code>.</p>
-   *             </li>
-   *          </ul>
-   */
-  ClarifyCheck?: ClarifyCheckStepMetadata;
-
-  /**
-   * @public
-   * <p>The configurations and outcomes of a Fail step execution.</p>
-   */
-  Fail?: FailStepMetadata;
-
-  /**
-   * @public
-   * <p>The Amazon Resource Name (ARN) of the AutoML job that was run by this step.</p>
-   */
-  AutoMLJob?: AutoMLJobStepMetadata;
-}