feat(client-lookoutmetrics): Added DetectMetricSetConfig API for detecting configuration required for creating metric set from provided S3 data source.

Author: awstools

clients/client-lookoutmetrics/src/LookoutMetrics.ts

@@ -52,6 +52,11 @@ import {
   DescribeMetricSetCommandInput,
   DescribeMetricSetCommandOutput,
 } from "./commands/DescribeMetricSetCommand";
+import {
+  DetectMetricSetConfigCommand,
+  DetectMetricSetConfigCommandInput,
+  DetectMetricSetConfigCommandOutput,
+} from "./commands/DetectMetricSetConfigCommand";
 import {
   GetAnomalyGroupCommand,
   GetAnomalyGroupCommandInput,
@@ -498,6 +503,38 @@ export class LookoutMetrics extends LookoutMetricsClient {
     }
   }
 
+  /**
+   * <p>Detects an Amazon S3 dataset's file format, interval, and offset.</p>
+   */
+  public detectMetricSetConfig(
+    args: DetectMetricSetConfigCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<DetectMetricSetConfigCommandOutput>;
+  public detectMetricSetConfig(
+    args: DetectMetricSetConfigCommandInput,
+    cb: (err: any, data?: DetectMetricSetConfigCommandOutput) => void
+  ): void;
+  public detectMetricSetConfig(
+    args: DetectMetricSetConfigCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: DetectMetricSetConfigCommandOutput) => void
+  ): void;
+  public detectMetricSetConfig(
+    args: DetectMetricSetConfigCommandInput,
+    optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetectMetricSetConfigCommandOutput) => void),
+    cb?: (err: any, data?: DetectMetricSetConfigCommandOutput) => void
+  ): Promise<DetectMetricSetConfigCommandOutput> | void {
+    const command = new DetectMetricSetConfigCommand(args);
+    if (typeof optionsOrCb === "function") {
+      this.send(command, optionsOrCb);
+    } else if (typeof cb === "function") {
+      if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
+      this.send(command, optionsOrCb || {}, cb);
+    } else {
+      return this.send(command, optionsOrCb);
+    }
+  }
+
   /**
    * <p>Returns details about a group of anomalous metrics.</p>
    */

clients/client-lookoutmetrics/src/LookoutMetricsClient.ts

@@ -84,6 +84,10 @@ import {
   DescribeAnomalyDetectorCommandOutput,
 } from "./commands/DescribeAnomalyDetectorCommand";
 import { DescribeMetricSetCommandInput, DescribeMetricSetCommandOutput } from "./commands/DescribeMetricSetCommand";
+import {
+  DetectMetricSetConfigCommandInput,
+  DetectMetricSetConfigCommandOutput,
+} from "./commands/DetectMetricSetConfigCommand";
 import { GetAnomalyGroupCommandInput, GetAnomalyGroupCommandOutput } from "./commands/GetAnomalyGroupCommand";
 import { GetFeedbackCommandInput, GetFeedbackCommandOutput } from "./commands/GetFeedbackCommand";
 import { GetSampleDataCommandInput, GetSampleDataCommandOutput } from "./commands/GetSampleDataCommand";
@@ -132,6 +136,7 @@ export type ServiceInputTypes =
   | DescribeAnomalyDetectionExecutionsCommandInput
   | DescribeAnomalyDetectorCommandInput
   | DescribeMetricSetCommandInput
+  | DetectMetricSetConfigCommandInput
   | GetAnomalyGroupCommandInput
   | GetFeedbackCommandInput
   | GetSampleDataCommandInput
@@ -161,6 +166,7 @@ export type ServiceOutputTypes =
   | DescribeAnomalyDetectionExecutionsCommandOutput
   | DescribeAnomalyDetectorCommandOutput
   | DescribeMetricSetCommandOutput
+  | DetectMetricSetConfigCommandOutput
   | GetAnomalyGroupCommandOutput
   | GetFeedbackCommandOutput
   | GetSampleDataCommandOutput

clients/client-lookoutmetrics/src/commands/DetectMetricSetConfigCommand.ts

@@ -0,0 +1,95 @@
+import { getSerdePlugin } from "@aws-sdk/middleware-serde";
+import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import {
+  FinalizeHandlerArguments,
+  Handler,
+  HandlerExecutionContext,
+  HttpHandlerOptions as __HttpHandlerOptions,
+  MetadataBearer as __MetadataBearer,
+  MiddlewareStack,
+  SerdeContext as __SerdeContext,
+} from "@aws-sdk/types";
+
+import { LookoutMetricsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LookoutMetricsClient";
+import { DetectMetricSetConfigRequest, DetectMetricSetConfigResponse } from "../models/models_0";
+import {
+  deserializeAws_restJson1DetectMetricSetConfigCommand,
+  serializeAws_restJson1DetectMetricSetConfigCommand,
+} from "../protocols/Aws_restJson1";
+
+export interface DetectMetricSetConfigCommandInput extends DetectMetricSetConfigRequest {}
+export interface DetectMetricSetConfigCommandOutput extends DetectMetricSetConfigResponse, __MetadataBearer {}
+
+/**
+ * <p>Detects an Amazon S3 dataset's file format, interval, and offset.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { LookoutMetricsClient, DetectMetricSetConfigCommand } from "@aws-sdk/client-lookoutmetrics"; // ES Modules import
+ * // const { LookoutMetricsClient, DetectMetricSetConfigCommand } = require("@aws-sdk/client-lookoutmetrics"); // CommonJS import
+ * const client = new LookoutMetricsClient(config);
+ * const command = new DetectMetricSetConfigCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link DetectMetricSetConfigCommandInput} for command's `input` shape.
+ * @see {@link DetectMetricSetConfigCommandOutput} for command's `response` shape.
+ * @see {@link LookoutMetricsClientResolvedConfig | config} for LookoutMetricsClient's `config` shape.
+ *
+ */
+export class DetectMetricSetConfigCommand extends $Command<
+  DetectMetricSetConfigCommandInput,
+  DetectMetricSetConfigCommandOutput,
+  LookoutMetricsClientResolvedConfig
+> {
+  // Start section: command_properties
+  // End section: command_properties
+
+  constructor(readonly input: DetectMetricSetConfigCommandInput) {
+    // Start section: command_constructor
+    super();
+    // End section: command_constructor
+  }
+
+  /**
+   * @internal
+   */
+  resolveMiddleware(
+    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
+    configuration: LookoutMetricsClientResolvedConfig,
+    options?: __HttpHandlerOptions
+  ): Handler<DetectMetricSetConfigCommandInput, DetectMetricSetConfigCommandOutput> {
+    this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
+
+    const stack = clientStack.concat(this.middlewareStack);
+
+    const { logger } = configuration;
+    const clientName = "LookoutMetricsClient";
+    const commandName = "DetectMetricSetConfigCommand";
+    const handlerExecutionContext: HandlerExecutionContext = {
+      logger,
+      clientName,
+      commandName,
+      inputFilterSensitiveLog: DetectMetricSetConfigRequest.filterSensitiveLog,
+      outputFilterSensitiveLog: DetectMetricSetConfigResponse.filterSensitiveLog,
+    };
+    const { requestHandler } = configuration;
+    return stack.resolve(
+      (request: FinalizeHandlerArguments<any>) =>
+        requestHandler.handle(request.request as __HttpRequest, options || {}),
+      handlerExecutionContext
+    );
+  }
+
+  private serialize(input: DetectMetricSetConfigCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
+    return serializeAws_restJson1DetectMetricSetConfigCommand(input, context);
+  }
+
+  private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<DetectMetricSetConfigCommandOutput> {
+    return deserializeAws_restJson1DetectMetricSetConfigCommand(output, context);
+  }
+
+  // Start section: command_body_extra
+  // End section: command_body_extra
+}

clients/client-lookoutmetrics/src/commands/index.ts

@@ -10,6 +10,7 @@ export * from "./DescribeAlertCommand";
 export * from "./DescribeAnomalyDetectionExecutionsCommand";
 export * from "./DescribeAnomalyDetectorCommand";
 export * from "./DescribeMetricSetCommand";
+export * from "./DetectMetricSetConfigCommand";
 export * from "./GetAnomalyGroupCommand";
 export * from "./GetFeedbackCommand";
 export * from "./GetSampleDataCommand";