feat(client-sagemaker): Amazon Sagemaker Autopilot releases CreateAut…

…oMLJobV2 and DescribeAutoMLJobV2 for Autopilot customers with ImageClassification, TextClassification and Tabular problem type config support.
aws · Jun 19, 2023 · cf5df1e · cf5df1e
1 parent a02f0d7
commit cf5df1e
Show file tree

Hide file tree

Showing 21 changed files with 1,161 additions and 626 deletions.
diff --git a/clients/client-sagemaker/src/commands/CreateAutoMLJobCommand.ts b/clients/client-sagemaker/src/commands/CreateAutoMLJobCommand.ts
@@ -36,10 +36,17 @@ export interface CreateAutoMLJobCommandOutput extends CreateAutoMLJobResponse, _
 
 /**
  * @public
- * <p>Creates an Autopilot job.</p>
- *          <p>Find the best-performing model after you run an Autopilot job by calling <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJob.html">DescribeAutoMLJob</a>.</p>
- *          <p>For information about how to use Autopilot, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html">Automate Model
- *             Development with Amazon SageMaker Autopilot</a>.</p>
+ * <p>Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.</p>
+ *          <p>Find the best-performing model after you run an AutoML job by calling <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJobV2.html">DescribeAutoMLJobV2</a> (recommended) or <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJob.html">DescribeAutoMLJob</a>.</p>
+ *          <note>
+ *             <p>
+ *                <code>CreateAutoMLJob</code> only accepts tabular input data. We recommend using
+ *                <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html">CreateAutoMLJobV2</a> for all problem types. <code>CreateAutoMLJobV2</code> can
+ *             process the same tabular data as its previous version <code>CreateAutoMLJob</code>, as
+ *             well as non-tabular data for problem types such as image or text classification.</p>
+ *             <p>Find guidelines about how to migrate <code>CreateAutoMLJob</code> to
+ *                <code>CreateAutoMLJobV2</code> in <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development-create-experiment-api.html#autopilot-create-experiment-api-migrate-v1-v2">Migrate a CreateAutoMLJob to CreateAutoMLJobV2</a>.</p>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-sagemaker/src/commands/CreateAutoMLJobV2Command.ts b/clients/client-sagemaker/src/commands/CreateAutoMLJobV2Command.ts
@@ -36,14 +36,17 @@ export interface CreateAutoMLJobV2CommandOutput extends CreateAutoMLJobV2Respons
 
 /**
  * @public
- * <p>Creates an Amazon SageMaker AutoML job that uses non-tabular data such as images or text for
- *          Computer Vision or Natural Language Processing problems.</p>
- *          <p>Find the resulting model after you run an AutoML job V2 by calling <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJobV2.html">DescribeAutoMLJobV2</a>.</p>
- *          <p>To create an <code>AutoMLJob</code> using tabular data, see <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html">CreateAutoMLJob</a>.</p>
- *          <note>
- *             <p>This API action is callable through SageMaker Canvas only. Calling it directly from the CLI
- *             or an SDK results in an error.</p>
- *          </note>
+ * <p>Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.</p>
+ *          <p>We recommend using <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html">CreateAutoMLJobV2</a>
+ *          for all problem types. <code>CreateAutoMLJobV2</code> can process the same tabular data as
+ *          its previous version <code>CreateAutoMLJob</code>, as well as non-tabular data for problem
+ *          types such as image or text classification.</p>
+ *          <p>Find guidelines about how to migrate <code>CreateAutoMLJob</code> to
+ *             <code>CreateAutoMLJobV2</code> in <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development-create-experiment-api.html#autopilot-create-experiment-api-migrate-v1-v2">Migrate a CreateAutoMLJob to CreateAutoMLJobV2</a>.</p>
+ *          <p>For the list of available problem types supported by <code>CreateAutoMLJobV2</code>, see
+ *             <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLProblemTypeConfig.html">AutoMLProblemTypeConfig</a>.</p>
+ *          <p>Find the best-performing model after you run an AutoML job V2 by calling <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJobV2.html">DescribeAutoMLJobV2</a>. Calling <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJob.html">DescribeAutoMLJob</a>
+ *          on a AutoML job V2 results in an error.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -86,6 +89,28 @@ export interface CreateAutoMLJobV2CommandOutput extends CreateAutoMLJobV2Respons
  *       ContentColumn: "STRING_VALUE",
  *       TargetLabelColumn: "STRING_VALUE",
  *     },
+ *     TabularJobConfig: { // TabularJobConfig
+ *       CandidateGenerationConfig: { // CandidateGenerationConfig
+ *         AlgorithmsConfig: [ // AutoMLAlgorithmsConfig
+ *           { // AutoMLAlgorithmConfig
+ *             AutoMLAlgorithms: [ // AutoMLAlgorithms // required
+ *               "xgboost" || "linear-learner" || "mlp" || "lightgbm" || "catboost" || "randomforest" || "extra-trees" || "nn-torch" || "fastai",
+ *             ],
+ *           },
+ *         ],
+ *       },
+ *       CompletionCriteria: {
+ *         MaxCandidates: Number("int"),
+ *         MaxRuntimePerTrainingJobInSeconds: Number("int"),
+ *         MaxAutoMLJobRuntimeInSeconds: Number("int"),
+ *       },
+ *       FeatureSpecificationS3Uri: "STRING_VALUE",
+ *       Mode: "AUTO" || "ENSEMBLING" || "HYPERPARAMETER_TUNING",
+ *       GenerateCandidateDefinitionsOnly: true || false,
+ *       ProblemType: "BinaryClassification" || "MulticlassClassification" || "Regression",
+ *       TargetAttributeName: "STRING_VALUE", // required
+ *       SampleWeightAttributeName: "STRING_VALUE",
+ *     },
  *   },
  *   RoleArn: "STRING_VALUE", // required
  *   Tags: [ // TagList

diff --git a/clients/client-sagemaker/src/commands/DeleteModelQualityJobDefinitionCommand.ts b/clients/client-sagemaker/src/commands/DeleteModelQualityJobDefinitionCommand.ts
@@ -13,7 +13,7 @@ import {
 import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
 import { SerdeContext as __SerdeContext } from "@smithy/types";
 
-import { DeleteModelQualityJobDefinitionRequest } from "../models/models_1";
+import { DeleteModelQualityJobDefinitionRequest } from "../models/models_2";
 import {
   de_DeleteModelQualityJobDefinitionCommand,
   se_DeleteModelQualityJobDefinitionCommand,

diff --git a/clients/client-sagemaker/src/commands/DeleteMonitoringScheduleCommand.ts b/clients/client-sagemaker/src/commands/DeleteMonitoringScheduleCommand.ts
@@ -13,7 +13,7 @@ import {
 import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
 import { SerdeContext as __SerdeContext } from "@smithy/types";
 
-import { DeleteMonitoringScheduleRequest } from "../models/models_1";
+import { DeleteMonitoringScheduleRequest } from "../models/models_2";
 import { de_DeleteMonitoringScheduleCommand, se_DeleteMonitoringScheduleCommand } from "../protocols/Aws_json1_1";
 import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
 

diff --git a/clients/client-sagemaker/src/commands/DeleteNotebookInstanceCommand.ts b/clients/client-sagemaker/src/commands/DeleteNotebookInstanceCommand.ts
@@ -13,7 +13,7 @@ import {
 import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
 import { SerdeContext as __SerdeContext } from "@smithy/types";
 
-import { DeleteNotebookInstanceInput } from "../models/models_1";
+import { DeleteNotebookInstanceInput } from "../models/models_2";
 import { de_DeleteNotebookInstanceCommand, se_DeleteNotebookInstanceCommand } from "../protocols/Aws_json1_1";
 import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
 

diff --git a/clients/client-sagemaker/src/commands/DeleteNotebookInstanceLifecycleConfigCommand.ts b/clients/client-sagemaker/src/commands/DeleteNotebookInstanceLifecycleConfigCommand.ts
@@ -13,7 +13,7 @@ import {
 import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
 import { SerdeContext as __SerdeContext } from "@smithy/types";
 
-import { DeleteNotebookInstanceLifecycleConfigInput } from "../models/models_1";
+import { DeleteNotebookInstanceLifecycleConfigInput } from "../models/models_2";
 import {
   de_DeleteNotebookInstanceLifecycleConfigCommand,
   se_DeleteNotebookInstanceLifecycleConfigCommand,

diff --git a/clients/client-sagemaker/src/commands/DeletePipelineCommand.ts b/clients/client-sagemaker/src/commands/DeletePipelineCommand.ts
@@ -13,7 +13,7 @@ import {
 import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
 import { SerdeContext as __SerdeContext } from "@smithy/types";
 
-import { DeletePipelineRequest, DeletePipelineResponse } from "../models/models_1";
+import { DeletePipelineRequest, DeletePipelineResponse } from "../models/models_2";
 import { de_DeletePipelineCommand, se_DeletePipelineCommand } from "../protocols/Aws_json1_1";
 import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
 

diff --git a/clients/client-sagemaker/src/commands/DescribeAutoMLJobCommand.ts b/clients/client-sagemaker/src/commands/DescribeAutoMLJobCommand.ts
@@ -36,7 +36,7 @@ export interface DescribeAutoMLJobCommandOutput extends DescribeAutoMLJobRespons
 
 /**
  * @public
- * <p>Returns information about an Amazon SageMaker AutoML job.</p>
+ * <p>Returns information about an AutoML job created by calling <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html">CreateAutoMLJob</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-sagemaker/src/commands/DescribeAutoMLJobV2Command.ts b/clients/client-sagemaker/src/commands/DescribeAutoMLJobV2Command.ts
@@ -36,11 +36,7 @@ export interface DescribeAutoMLJobV2CommandOutput extends DescribeAutoMLJobV2Res
 
 /**
  * @public
- * <p>Returns information about an Amazon SageMaker AutoML V2 job.</p>
- *          <note>
- *             <p>This API action is callable through SageMaker Canvas only. Calling it directly from the CLI
- *             or an SDK results in an error.</p>
- *          </note>
+ * <p>Returns information about an AutoML job V2 created by calling <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html">CreateAutoMLJobV2</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -93,6 +89,28 @@ export interface DescribeAutoMLJobV2CommandOutput extends DescribeAutoMLJobV2Res
  * //       ContentColumn: "STRING_VALUE",
  * //       TargetLabelColumn: "STRING_VALUE",
  * //     },
+ * //     TabularJobConfig: { // TabularJobConfig
+ * //       CandidateGenerationConfig: { // CandidateGenerationConfig
+ * //         AlgorithmsConfig: [ // AutoMLAlgorithmsConfig
+ * //           { // AutoMLAlgorithmConfig
+ * //             AutoMLAlgorithms: [ // AutoMLAlgorithms // required
+ * //               "xgboost" || "linear-learner" || "mlp" || "lightgbm" || "catboost" || "randomforest" || "extra-trees" || "nn-torch" || "fastai",
+ * //             ],
+ * //           },
+ * //         ],
+ * //       },
+ * //       CompletionCriteria: {
+ * //         MaxCandidates: Number("int"),
+ * //         MaxRuntimePerTrainingJobInSeconds: Number("int"),
+ * //         MaxAutoMLJobRuntimeInSeconds: Number("int"),
+ * //       },
+ * //       FeatureSpecificationS3Uri: "STRING_VALUE",
+ * //       Mode: "AUTO" || "ENSEMBLING" || "HYPERPARAMETER_TUNING",
+ * //       GenerateCandidateDefinitionsOnly: true || false,
+ * //       ProblemType: "BinaryClassification" || "MulticlassClassification" || "Regression",
+ * //       TargetAttributeName: "STRING_VALUE", // required
+ * //       SampleWeightAttributeName: "STRING_VALUE",
+ * //     },
  * //   },
  * //   CreationTime: new Date("TIMESTAMP"), // required
  * //   EndTime: new Date("TIMESTAMP"),
@@ -183,6 +201,26 @@ export interface DescribeAutoMLJobV2CommandOutput extends DescribeAutoMLJobV2Res
  * //       ],
  * //     },
  * //   },
+ * //   AutoMLJobArtifacts: { // AutoMLJobArtifacts
+ * //     CandidateDefinitionNotebookLocation: "STRING_VALUE",
+ * //     DataExplorationNotebookLocation: "STRING_VALUE",
+ * //   },
+ * //   ResolvedAttributes: { // AutoMLResolvedAttributes
+ * //     AutoMLJobObjective: {
+ * //       MetricName: "Accuracy" || "MSE" || "F1" || "F1macro" || "AUC" || "RMSE" || "MAE" || "R2" || "BalancedAccuracy" || "Precision" || "PrecisionMacro" || "Recall" || "RecallMacro", // required
+ * //     },
+ * //     CompletionCriteria: {
+ * //       MaxCandidates: Number("int"),
+ * //       MaxRuntimePerTrainingJobInSeconds: Number("int"),
+ * //       MaxAutoMLJobRuntimeInSeconds: Number("int"),
+ * //     },
+ * //     AutoMLProblemTypeResolvedAttributes: { // AutoMLProblemTypeResolvedAttributes Union: only one key present
+ * //       TabularResolvedAttributes: { // TabularResolvedAttributes
+ * //         ProblemType: "BinaryClassification" || "MulticlassClassification" || "Regression",
+ * //       },
+ * //     },
+ * //   },
+ * //   AutoMLProblemTypeConfigName: "ImageClassification" || "TextClassification" || "Tabular",
  * // };
  *
  * ```

diff --git a/clients/client-sagemaker/src/commands/StopCompilationJobCommand.ts b/clients/client-sagemaker/src/commands/StopCompilationJobCommand.ts
@@ -13,7 +13,7 @@ import {
 import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
 import { SerdeContext as __SerdeContext } from "@smithy/types";
 
-import { StopCompilationJobRequest } from "../models/models_3";
+import { StopCompilationJobRequest } from "../models/models_4";
 import { de_StopCompilationJobCommand, se_StopCompilationJobCommand } from "../protocols/Aws_json1_1";
 import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
 

diff --git a/clients/client-sagemaker/src/commands/StopEdgeDeploymentStageCommand.ts b/clients/client-sagemaker/src/commands/StopEdgeDeploymentStageCommand.ts
@@ -13,7 +13,7 @@ import {
 import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
 import { SerdeContext as __SerdeContext } from "@smithy/types";
 
-import { StopEdgeDeploymentStageRequest } from "../models/models_3";
+import { StopEdgeDeploymentStageRequest } from "../models/models_4";
 import { de_StopEdgeDeploymentStageCommand, se_StopEdgeDeploymentStageCommand } from "../protocols/Aws_json1_1";
 import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
 

diff --git a/clients/client-sagemaker/src/commands/StopEdgePackagingJobCommand.ts b/clients/client-sagemaker/src/commands/StopEdgePackagingJobCommand.ts
@@ -13,7 +13,7 @@ import {
 import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
 import { SerdeContext as __SerdeContext } from "@smithy/types";
 
-import { StopEdgePackagingJobRequest } from "../models/models_3";
+import { StopEdgePackagingJobRequest } from "../models/models_4";
 import { de_StopEdgePackagingJobCommand, se_StopEdgePackagingJobCommand } from "../protocols/Aws_json1_1";
 import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
 

diff --git a/clients/client-sagemaker/src/commands/StopHyperParameterTuningJobCommand.ts b/clients/client-sagemaker/src/commands/StopHyperParameterTuningJobCommand.ts
@@ -13,7 +13,7 @@ import {
 import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
 import { SerdeContext as __SerdeContext } from "@smithy/types";
 
-import { StopHyperParameterTuningJobRequest } from "../models/models_3";
+import { StopHyperParameterTuningJobRequest } from "../models/models_4";
 import { de_StopHyperParameterTuningJobCommand, se_StopHyperParameterTuningJobCommand } from "../protocols/Aws_json1_1";
 import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
 

diff --git a/clients/client-sagemaker/src/commands/StopInferenceExperimentCommand.ts b/clients/client-sagemaker/src/commands/StopInferenceExperimentCommand.ts
@@ -13,7 +13,7 @@ import {
 import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
 import { SerdeContext as __SerdeContext } from "@smithy/types";
 
-import { StopInferenceExperimentRequest, StopInferenceExperimentResponse } from "../models/models_3";
+import { StopInferenceExperimentRequest, StopInferenceExperimentResponse } from "../models/models_4";
 import { de_StopInferenceExperimentCommand, se_StopInferenceExperimentCommand } from "../protocols/Aws_json1_1";
 import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";