feat(client-sagemaker): This release adds support for one-time model …

…monitoring schedules that are executed immediately without delay, explicit data analysis windows for model monitoring schedules and exclude features attributes to remove features from model monitor analysis.
aws · Sep 19, 2023 · 2604b84 · 2604b84
1 parent 871a04d
commit 2604b84
Show file tree

Hide file tree

Showing 21 changed files with 334 additions and 223 deletions.
diff --git a/clients/client-sagemaker/src/commands/CreateAutoMLJobCommand.ts b/clients/client-sagemaker/src/commands/CreateAutoMLJobCommand.ts
@@ -41,8 +41,8 @@ export interface CreateAutoMLJobCommandOutput extends CreateAutoMLJobResponse, _
  *             <p>We recommend using the new versions <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html">CreateAutoMLJobV2</a> and <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJobV2.html">DescribeAutoMLJobV2</a>, which offer backward compatibility.</p>
  *             <p>
  *                <code>CreateAutoMLJobV2</code> can manage tabular problem types identical to those of
- *             its previous version <code>CreateAutoMLJob</code>, as well as time-series forecasting,
- *             and non-tabular problem types such as image or text classification.</p>
+ *             its previous version <code>CreateAutoMLJob</code>, as well as non-tabular problem types
+ *             such as image or text classification.</p>
  *             <p>Find guidelines about how to migrate a <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>

diff --git a/clients/client-sagemaker/src/commands/CreateAutoMLJobV2Command.ts b/clients/client-sagemaker/src/commands/CreateAutoMLJobV2Command.ts
@@ -43,8 +43,8 @@ export interface CreateAutoMLJobV2CommandOutput extends CreateAutoMLJobV2Respons
  *             and <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJob.html">DescribeAutoMLJob</a> which offer backward compatibility.</p>
  *             <p>
  *                <code>CreateAutoMLJobV2</code> can manage tabular problem types identical to those of
- *             its previous version <code>CreateAutoMLJob</code>, as well as time-series forecasting,
- *             and non-tabular problem types such as image or text classification.</p>
+ *             its previous version <code>CreateAutoMLJob</code>, as well as non-tabular problem types
+ *             such as image or text classification.</p>
  *             <p>Find guidelines about how to migrate a <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>

diff --git a/clients/client-sagemaker/src/commands/CreateDataQualityJobDefinitionCommand.ts b/clients/client-sagemaker/src/commands/CreateDataQualityJobDefinitionCommand.ts
@@ -42,8 +42,7 @@ export interface CreateDataQualityJobDefinitionCommandOutput
 /**
  * @public
  * <p>Creates a definition for a job that monitors data quality and drift. For information
- *          about model monitor, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html">Amazon SageMaker Model
- *          Monitor</a>.</p>
+ *          about model monitor, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html">Amazon SageMaker Model Monitor</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -87,6 +86,7 @@ export interface CreateDataQualityJobDefinitionCommandOutput
  *       ProbabilityThresholdAttribute: Number("double"),
  *       StartTimeOffset: "STRING_VALUE",
  *       EndTimeOffset: "STRING_VALUE",
+ *       ExcludeFeaturesAttribute: "STRING_VALUE",
  *     },
  *     BatchTransformInput: { // BatchTransformInput
  *       DataCapturedDestinationS3Uri: "STRING_VALUE", // required
@@ -108,6 +108,7 @@ export interface CreateDataQualityJobDefinitionCommandOutput
  *       ProbabilityThresholdAttribute: Number("double"),
  *       StartTimeOffset: "STRING_VALUE",
  *       EndTimeOffset: "STRING_VALUE",
+ *       ExcludeFeaturesAttribute: "STRING_VALUE",
  *     },
  *   },
  *   DataQualityJobOutputConfig: { // MonitoringOutputConfig

diff --git a/clients/client-sagemaker/src/commands/CreateModelBiasJobDefinitionCommand.ts b/clients/client-sagemaker/src/commands/CreateModelBiasJobDefinitionCommand.ts
@@ -75,6 +75,7 @@ export interface CreateModelBiasJobDefinitionCommandOutput
  *       ProbabilityThresholdAttribute: Number("double"),
  *       StartTimeOffset: "STRING_VALUE",
  *       EndTimeOffset: "STRING_VALUE",
+ *       ExcludeFeaturesAttribute: "STRING_VALUE",
  *     },
  *     BatchTransformInput: { // BatchTransformInput
  *       DataCapturedDestinationS3Uri: "STRING_VALUE", // required
@@ -96,6 +97,7 @@ export interface CreateModelBiasJobDefinitionCommandOutput
  *       ProbabilityThresholdAttribute: Number("double"),
  *       StartTimeOffset: "STRING_VALUE",
  *       EndTimeOffset: "STRING_VALUE",
+ *       ExcludeFeaturesAttribute: "STRING_VALUE",
  *     },
  *     GroundTruthS3Input: { // MonitoringGroundTruthS3Input
  *       S3Uri: "STRING_VALUE",

diff --git a/clients/client-sagemaker/src/commands/CreateModelExplainabilityJobDefinitionCommand.ts b/clients/client-sagemaker/src/commands/CreateModelExplainabilityJobDefinitionCommand.ts
@@ -79,6 +79,7 @@ export interface CreateModelExplainabilityJobDefinitionCommandOutput
  *       ProbabilityThresholdAttribute: Number("double"),
  *       StartTimeOffset: "STRING_VALUE",
  *       EndTimeOffset: "STRING_VALUE",
+ *       ExcludeFeaturesAttribute: "STRING_VALUE",
  *     },
  *     BatchTransformInput: { // BatchTransformInput
  *       DataCapturedDestinationS3Uri: "STRING_VALUE", // required
@@ -100,6 +101,7 @@ export interface CreateModelExplainabilityJobDefinitionCommandOutput
  *       ProbabilityThresholdAttribute: Number("double"),
  *       StartTimeOffset: "STRING_VALUE",
  *       EndTimeOffset: "STRING_VALUE",
+ *       ExcludeFeaturesAttribute: "STRING_VALUE",
  *     },
  *   },
  *   ModelExplainabilityJobOutputConfig: { // MonitoringOutputConfig

diff --git a/clients/client-sagemaker/src/commands/CreateModelQualityJobDefinitionCommand.ts b/clients/client-sagemaker/src/commands/CreateModelQualityJobDefinitionCommand.ts
@@ -42,8 +42,7 @@ export interface CreateModelQualityJobDefinitionCommandOutput
 /**
  * @public
  * <p>Creates a definition for a job that monitors model quality and drift. For information
- *          about model monitor, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html">Amazon SageMaker Model
- *          Monitor</a>.</p>
+ *          about model monitor, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html">Amazon SageMaker Model Monitor</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -85,6 +84,7 @@ export interface CreateModelQualityJobDefinitionCommandOutput
  *       ProbabilityThresholdAttribute: Number("double"),
  *       StartTimeOffset: "STRING_VALUE",
  *       EndTimeOffset: "STRING_VALUE",
+ *       ExcludeFeaturesAttribute: "STRING_VALUE",
  *     },
  *     BatchTransformInput: { // BatchTransformInput
  *       DataCapturedDestinationS3Uri: "STRING_VALUE", // required
@@ -106,6 +106,7 @@ export interface CreateModelQualityJobDefinitionCommandOutput
  *       ProbabilityThresholdAttribute: Number("double"),
  *       StartTimeOffset: "STRING_VALUE",
  *       EndTimeOffset: "STRING_VALUE",
+ *       ExcludeFeaturesAttribute: "STRING_VALUE",
  *     },
  *     GroundTruthS3Input: { // MonitoringGroundTruthS3Input
  *       S3Uri: "STRING_VALUE",

diff --git a/clients/client-sagemaker/src/commands/CreateMonitoringScheduleCommand.ts b/clients/client-sagemaker/src/commands/CreateMonitoringScheduleCommand.ts
@@ -36,8 +36,8 @@ export interface CreateMonitoringScheduleCommandOutput extends CreateMonitoringS
 
 /**
  * @public
- * <p>Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to
- *          monitor the data captured for an Amazon SageMaker Endpoint.</p>
+ * <p>Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the data
+ *          captured for an Amazon SageMaker Endpoint.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -49,6 +49,8 @@ export interface CreateMonitoringScheduleCommandOutput extends CreateMonitoringS
  *   MonitoringScheduleConfig: { // MonitoringScheduleConfig
  *     ScheduleConfig: { // ScheduleConfig
  *       ScheduleExpression: "STRING_VALUE", // required
+ *       DataAnalysisStartTime: "STRING_VALUE",
+ *       DataAnalysisEndTime: "STRING_VALUE",
  *     },
  *     MonitoringJobDefinition: { // MonitoringJobDefinition
  *       BaselineConfig: { // MonitoringBaselineConfig
@@ -73,6 +75,7 @@ export interface CreateMonitoringScheduleCommandOutput extends CreateMonitoringS
  *             ProbabilityThresholdAttribute: Number("double"),
  *             StartTimeOffset: "STRING_VALUE",
  *             EndTimeOffset: "STRING_VALUE",
+ *             ExcludeFeaturesAttribute: "STRING_VALUE",
  *           },
  *           BatchTransformInput: { // BatchTransformInput
  *             DataCapturedDestinationS3Uri: "STRING_VALUE", // required
@@ -94,6 +97,7 @@ export interface CreateMonitoringScheduleCommandOutput extends CreateMonitoringS
  *             ProbabilityThresholdAttribute: Number("double"),
  *             StartTimeOffset: "STRING_VALUE",
  *             EndTimeOffset: "STRING_VALUE",
+ *             ExcludeFeaturesAttribute: "STRING_VALUE",
  *           },
  *         },
  *       ],

diff --git a/clients/client-sagemaker/src/commands/DescribeDataQualityJobDefinitionCommand.ts b/clients/client-sagemaker/src/commands/DescribeDataQualityJobDefinitionCommand.ts
@@ -92,6 +92,7 @@ export interface DescribeDataQualityJobDefinitionCommandOutput
  * //       ProbabilityThresholdAttribute: Number("double"),
  * //       StartTimeOffset: "STRING_VALUE",
  * //       EndTimeOffset: "STRING_VALUE",
+ * //       ExcludeFeaturesAttribute: "STRING_VALUE",
  * //     },
  * //     BatchTransformInput: { // BatchTransformInput
  * //       DataCapturedDestinationS3Uri: "STRING_VALUE", // required
@@ -113,6 +114,7 @@ export interface DescribeDataQualityJobDefinitionCommandOutput
  * //       ProbabilityThresholdAttribute: Number("double"),
  * //       StartTimeOffset: "STRING_VALUE",
  * //       EndTimeOffset: "STRING_VALUE",
+ * //       ExcludeFeaturesAttribute: "STRING_VALUE",
  * //     },
  * //   },
  * //   DataQualityJobOutputConfig: { // MonitoringOutputConfig

diff --git a/clients/client-sagemaker/src/commands/DescribeModelBiasJobDefinitionCommand.ts b/clients/client-sagemaker/src/commands/DescribeModelBiasJobDefinitionCommand.ts
@@ -82,6 +82,7 @@ export interface DescribeModelBiasJobDefinitionCommandOutput
  * //       ProbabilityThresholdAttribute: Number("double"),
  * //       StartTimeOffset: "STRING_VALUE",
  * //       EndTimeOffset: "STRING_VALUE",
+ * //       ExcludeFeaturesAttribute: "STRING_VALUE",
  * //     },
  * //     BatchTransformInput: { // BatchTransformInput
  * //       DataCapturedDestinationS3Uri: "STRING_VALUE", // required
@@ -103,6 +104,7 @@ export interface DescribeModelBiasJobDefinitionCommandOutput
  * //       ProbabilityThresholdAttribute: Number("double"),
  * //       StartTimeOffset: "STRING_VALUE",
  * //       EndTimeOffset: "STRING_VALUE",
+ * //       ExcludeFeaturesAttribute: "STRING_VALUE",
  * //     },
  * //     GroundTruthS3Input: { // MonitoringGroundTruthS3Input
  * //       S3Uri: "STRING_VALUE",

diff --git a/clients/client-sagemaker/src/commands/DescribeModelExplainabilityJobDefinitionCommand.ts b/clients/client-sagemaker/src/commands/DescribeModelExplainabilityJobDefinitionCommand.ts
@@ -86,6 +86,7 @@ export interface DescribeModelExplainabilityJobDefinitionCommandOutput
  * //       ProbabilityThresholdAttribute: Number("double"),
  * //       StartTimeOffset: "STRING_VALUE",
  * //       EndTimeOffset: "STRING_VALUE",
+ * //       ExcludeFeaturesAttribute: "STRING_VALUE",
  * //     },
  * //     BatchTransformInput: { // BatchTransformInput
  * //       DataCapturedDestinationS3Uri: "STRING_VALUE", // required
@@ -107,6 +108,7 @@ export interface DescribeModelExplainabilityJobDefinitionCommandOutput
  * //       ProbabilityThresholdAttribute: Number("double"),
  * //       StartTimeOffset: "STRING_VALUE",
  * //       EndTimeOffset: "STRING_VALUE",
+ * //       ExcludeFeaturesAttribute: "STRING_VALUE",
  * //     },
  * //   },
  * //   ModelExplainabilityJobOutputConfig: { // MonitoringOutputConfig

diff --git a/clients/client-sagemaker/src/commands/DescribeModelQualityJobDefinitionCommand.ts b/clients/client-sagemaker/src/commands/DescribeModelQualityJobDefinitionCommand.ts
@@ -93,6 +93,7 @@ export interface DescribeModelQualityJobDefinitionCommandOutput
  * //       ProbabilityThresholdAttribute: Number("double"),
  * //       StartTimeOffset: "STRING_VALUE",
  * //       EndTimeOffset: "STRING_VALUE",
+ * //       ExcludeFeaturesAttribute: "STRING_VALUE",
  * //     },
  * //     BatchTransformInput: { // BatchTransformInput
  * //       DataCapturedDestinationS3Uri: "STRING_VALUE", // required
@@ -114,6 +115,7 @@ export interface DescribeModelQualityJobDefinitionCommandOutput
  * //       ProbabilityThresholdAttribute: Number("double"),
  * //       StartTimeOffset: "STRING_VALUE",
  * //       EndTimeOffset: "STRING_VALUE",
+ * //       ExcludeFeaturesAttribute: "STRING_VALUE",
  * //     },
  * //     GroundTruthS3Input: { // MonitoringGroundTruthS3Input
  * //       S3Uri: "STRING_VALUE",

diff --git a/clients/client-sagemaker/src/commands/DescribeMonitoringScheduleCommand.ts b/clients/client-sagemaker/src/commands/DescribeMonitoringScheduleCommand.ts
@@ -59,6 +59,8 @@ export interface DescribeMonitoringScheduleCommandOutput extends DescribeMonitor
  * //   MonitoringScheduleConfig: { // MonitoringScheduleConfig
  * //     ScheduleConfig: { // ScheduleConfig
  * //       ScheduleExpression: "STRING_VALUE", // required
+ * //       DataAnalysisStartTime: "STRING_VALUE",
+ * //       DataAnalysisEndTime: "STRING_VALUE",
  * //     },
  * //     MonitoringJobDefinition: { // MonitoringJobDefinition
  * //       BaselineConfig: { // MonitoringBaselineConfig
@@ -83,6 +85,7 @@ export interface DescribeMonitoringScheduleCommandOutput extends DescribeMonitor
  * //             ProbabilityThresholdAttribute: Number("double"),
  * //             StartTimeOffset: "STRING_VALUE",
  * //             EndTimeOffset: "STRING_VALUE",
+ * //             ExcludeFeaturesAttribute: "STRING_VALUE",
  * //           },
  * //           BatchTransformInput: { // BatchTransformInput
  * //             DataCapturedDestinationS3Uri: "STRING_VALUE", // required
@@ -104,6 +107,7 @@ export interface DescribeMonitoringScheduleCommandOutput extends DescribeMonitor
  * //             ProbabilityThresholdAttribute: Number("double"),
  * //             StartTimeOffset: "STRING_VALUE",
  * //             EndTimeOffset: "STRING_VALUE",
+ * //             ExcludeFeaturesAttribute: "STRING_VALUE",
  * //           },
  * //         },
  * //       ],

diff --git a/clients/client-sagemaker/src/commands/SearchCommand.ts b/clients/client-sagemaker/src/commands/SearchCommand.ts
@@ -908,6 +908,8 @@ export interface SearchCommandOutput extends SearchResponse, __MetadataBearer {}
  * //             MonitoringScheduleConfig: { // MonitoringScheduleConfig
  * //               ScheduleConfig: { // ScheduleConfig
  * //                 ScheduleExpression: "STRING_VALUE", // required
+ * //                 DataAnalysisStartTime: "STRING_VALUE",
+ * //                 DataAnalysisEndTime: "STRING_VALUE",
  * //               },
  * //               MonitoringJobDefinition: { // MonitoringJobDefinition
  * //                 BaselineConfig: { // MonitoringBaselineConfig
@@ -932,6 +934,7 @@ export interface SearchCommandOutput extends SearchResponse, __MetadataBearer {}
  * //                       ProbabilityThresholdAttribute: Number("double"),
  * //                       StartTimeOffset: "STRING_VALUE",
  * //                       EndTimeOffset: "STRING_VALUE",
+ * //                       ExcludeFeaturesAttribute: "STRING_VALUE",
  * //                     },
  * //                     BatchTransformInput: { // BatchTransformInput
  * //                       DataCapturedDestinationS3Uri: "STRING_VALUE", // required
@@ -953,6 +956,7 @@ export interface SearchCommandOutput extends SearchResponse, __MetadataBearer {}
  * //                       ProbabilityThresholdAttribute: Number("double"),
  * //                       StartTimeOffset: "STRING_VALUE",
  * //                       EndTimeOffset: "STRING_VALUE",
+ * //                       ExcludeFeaturesAttribute: "STRING_VALUE",
  * //                     },
  * //                   },
  * //                 ],
@@ -1845,6 +1849,8 @@ export interface SearchCommandOutput extends SearchResponse, __MetadataBearer {}
  * //             MonitoringScheduleConfig: {
  * //               ScheduleConfig: {
  * //                 ScheduleExpression: "STRING_VALUE", // required
+ * //                 DataAnalysisStartTime: "STRING_VALUE",
+ * //                 DataAnalysisEndTime: "STRING_VALUE",
  * //               },
  * //               MonitoringJobDefinition: {
  * //                 BaselineConfig: {
@@ -1869,6 +1875,7 @@ export interface SearchCommandOutput extends SearchResponse, __MetadataBearer {}
  * //                       ProbabilityThresholdAttribute: Number("double"),
  * //                       StartTimeOffset: "STRING_VALUE",
  * //                       EndTimeOffset: "STRING_VALUE",
+ * //                       ExcludeFeaturesAttribute: "STRING_VALUE",
  * //                     },
  * //                     BatchTransformInput: {
  * //                       DataCapturedDestinationS3Uri: "STRING_VALUE", // required
@@ -1890,6 +1897,7 @@ export interface SearchCommandOutput extends SearchResponse, __MetadataBearer {}
  * //                       ProbabilityThresholdAttribute: Number("double"),
  * //                       StartTimeOffset: "STRING_VALUE",
  * //                       EndTimeOffset: "STRING_VALUE",
+ * //                       ExcludeFeaturesAttribute: "STRING_VALUE",
  * //                     },
  * //                   },
  * //                 ],

diff --git a/clients/client-sagemaker/src/commands/UpdateMonitoringScheduleCommand.ts b/clients/client-sagemaker/src/commands/UpdateMonitoringScheduleCommand.ts
@@ -48,6 +48,8 @@ export interface UpdateMonitoringScheduleCommandOutput extends UpdateMonitoringS
  *   MonitoringScheduleConfig: { // MonitoringScheduleConfig
  *     ScheduleConfig: { // ScheduleConfig
  *       ScheduleExpression: "STRING_VALUE", // required
+ *       DataAnalysisStartTime: "STRING_VALUE",
+ *       DataAnalysisEndTime: "STRING_VALUE",
  *     },
  *     MonitoringJobDefinition: { // MonitoringJobDefinition
  *       BaselineConfig: { // MonitoringBaselineConfig
@@ -72,6 +74,7 @@ export interface UpdateMonitoringScheduleCommandOutput extends UpdateMonitoringS
  *             ProbabilityThresholdAttribute: Number("double"),
  *             StartTimeOffset: "STRING_VALUE",
  *             EndTimeOffset: "STRING_VALUE",
+ *             ExcludeFeaturesAttribute: "STRING_VALUE",
  *           },
  *           BatchTransformInput: { // BatchTransformInput
  *             DataCapturedDestinationS3Uri: "STRING_VALUE", // required
@@ -93,6 +96,7 @@ export interface UpdateMonitoringScheduleCommandOutput extends UpdateMonitoringS
  *             ProbabilityThresholdAttribute: Number("double"),
  *             StartTimeOffset: "STRING_VALUE",
  *             EndTimeOffset: "STRING_VALUE",
+ *             ExcludeFeaturesAttribute: "STRING_VALUE",
  *           },
  *         },
  *       ],