feat(client-lookoutequipment): This release adds visualizations to the scheduled inference results. Users will be able to see interference results, including diagnostic results from their running inference schedulers.

Author: awstools

clients/client-lookoutequipment/README.md

@@ -9,8 +9,9 @@
 
 AWS SDK for JavaScript LookoutEquipment Client for Node.js, Browser and React Native.
 
-<p>Amazon Lookout for Equipment is a machine learning service that uses advanced analytics to identify
-anomalies in machines from sensor data for use in predictive maintenance. </p>
+<p>Amazon Lookout for Equipment is a machine learning service that uses advanced analytics
+to identify anomalies in machines from sensor data for use in predictive maintenance.
+</p>
 
 ## Installing
 

clients/client-lookoutequipment/src/LookoutEquipment.ts

@@ -53,6 +53,11 @@ import {
   ListDatasetsCommandInput,
   ListDatasetsCommandOutput,
 } from "./commands/ListDatasetsCommand";
+import {
+  ListInferenceEventsCommand,
+  ListInferenceEventsCommandInput,
+  ListInferenceEventsCommandOutput,
+} from "./commands/ListInferenceEventsCommand";
 import {
   ListInferenceExecutionsCommand,
   ListInferenceExecutionsCommandInput,
@@ -103,8 +108,9 @@ import {
 import { LookoutEquipmentClient } from "./LookoutEquipmentClient";
 
 /**
- * <p>Amazon Lookout for Equipment is a machine learning service that uses advanced analytics to identify
- *          anomalies in machines from sensor data for use in predictive maintenance. </p>
+ * <p>Amazon Lookout for Equipment is a machine learning service that uses advanced analytics
+ *          to identify anomalies in machines from sensor data for use in predictive maintenance.
+ *       </p>
  */
 export class LookoutEquipment extends LookoutEquipmentClient {
   /**
@@ -181,10 +187,10 @@ export class LookoutEquipment extends LookoutEquipmentClient {
   /**
    * <p>Creates an ML model for data inference. </p>
    *          <p>A machine-learning (ML) model is a mathematical model that finds patterns in your data.
-   *          In Amazon Lookout for Equipment, the model learns the patterns of normal behavior and detects abnormal
-   *          behavior that could be potential equipment failure (or maintenance events). The models are
-   *          made by analyzing normal data and abnormalities in machine behavior that have already
-   *          occurred.</p>
+   *          In Amazon Lookout for Equipment, the model learns the patterns of normal behavior and
+   *          detects abnormal behavior that could be potential equipment failure (or maintenance
+   *          events). The models are made by analyzing normal data and abnormalities in machine behavior
+   *          that have already occurred.</p>
    *          <p>Your model is trained using a portion of the data from your dataset and uses that data
    *          to learn patterns of normal behavior and abnormal patterns that lead to equipment failure.
    *          Another portion of the data is used to evaluate the model's accuracy. </p>
@@ -282,8 +288,9 @@ export class LookoutEquipment extends LookoutEquipmentClient {
   }
 
   /**
-   * <p>Deletes an ML model currently available for Amazon Lookout for Equipment. This will prevent it from
-   *          being used with an inference scheduler, even one that is already set up. </p>
+   * <p>Deletes an ML model currently available for Amazon Lookout for Equipment. This will
+   *          prevent it from being used with an inference scheduler, even one that is already set up.
+   *       </p>
    */
   public deleteModel(args: DeleteModelCommandInput, options?: __HttpHandlerOptions): Promise<DeleteModelCommandOutput>;
   public deleteModel(args: DeleteModelCommandInput, cb: (err: any, data?: DeleteModelCommandOutput) => void): void;
@@ -342,7 +349,8 @@ export class LookoutEquipment extends LookoutEquipmentClient {
   }
 
   /**
-   * <p>Provides a JSON description of the data in each time series dataset, including names, column names, and data types.</p>
+   * <p>Provides a JSON description of the data in each time series dataset, including names,
+   *          column names, and data types.</p>
    */
   public describeDataset(
     args: DescribeDatasetCommandInput,
@@ -407,8 +415,9 @@ export class LookoutEquipment extends LookoutEquipmentClient {
   }
 
   /**
-   * <p>Provides a JSON containing the overall information about a specific ML model, including model name and ARN,
-   *          dataset, training and evaluation information, status, and so on. </p>
+   * <p>Provides a JSON containing the overall information about a specific ML model, including
+   *          model name and ARN, dataset, training and evaluation information, status, and so on.
+   *       </p>
    */
   public describeModel(
     args: DescribeModelCommandInput,
@@ -502,6 +511,39 @@ export class LookoutEquipment extends LookoutEquipmentClient {
     }
   }
 
+  /**
+   * <p> Lists all inference events that have been found for the specified inference
+   *          scheduler. </p>
+   */
+  public listInferenceEvents(
+    args: ListInferenceEventsCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<ListInferenceEventsCommandOutput>;
+  public listInferenceEvents(
+    args: ListInferenceEventsCommandInput,
+    cb: (err: any, data?: ListInferenceEventsCommandOutput) => void
+  ): void;
+  public listInferenceEvents(
+    args: ListInferenceEventsCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: ListInferenceEventsCommandOutput) => void
+  ): void;
+  public listInferenceEvents(
+    args: ListInferenceEventsCommandInput,
+    optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInferenceEventsCommandOutput) => void),
+    cb?: (err: any, data?: ListInferenceEventsCommandOutput) => void
+  ): Promise<ListInferenceEventsCommandOutput> | void {
+    const command = new ListInferenceEventsCommand(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> Lists all inference executions that have been performed by the specified inference
    *          scheduler. </p>
@@ -596,9 +638,9 @@ export class LookoutEquipment extends LookoutEquipmentClient {
   }
 
   /**
-   * <p>
-   * Lists statistics about the data collected for each of the sensors that have been successfully ingested in the particular dataset. Can also be used to retreive Sensor Statistics for a previous ingestion job.
-   * </p>
+   * <p> Lists statistics about the data collected for each of the sensors that have been
+   *          successfully ingested in the particular dataset. Can also be used to retreive Sensor
+   *          Statistics for a previous ingestion job. </p>
    */
   public listSensorStatistics(
     args: ListSensorStatisticsCommandInput,
@@ -662,7 +704,8 @@ export class LookoutEquipment extends LookoutEquipmentClient {
   }
 
   /**
-   * <p>Starts a data ingestion job. Amazon Lookout for Equipment returns the job status. </p>
+   * <p>Starts a data ingestion job. Amazon Lookout for Equipment returns the job status.
+   *       </p>
    */
   public startDataIngestionJob(
     args: StartDataIngestionJobCommandInput,
@@ -759,10 +802,10 @@ export class LookoutEquipment extends LookoutEquipmentClient {
 
   /**
    * <p>Associates a given tag to a resource in your account. A tag is a key-value pair which
-   *          can be added to an Amazon Lookout for Equipment resource as metadata. Tags can be used for organizing your
-   *          resources as well as helping you to search and filter by tag. Multiple tags can be added to
-   *          a resource, either when you create it, or later. Up to 50 tags can be associated with each
-   *          resource. </p>
+   *          can be added to an Amazon Lookout for Equipment resource as metadata. Tags can be used for
+   *          organizing your resources as well as helping you to search and filter by tag. Multiple tags
+   *          can be added to a resource, either when you create it, or later. Up to 50 tags can be
+   *          associated with each resource. </p>
    */
   public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
   public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;

clients/client-lookoutequipment/src/LookoutEquipmentClient.ts

@@ -80,6 +80,10 @@ import {
   ListDataIngestionJobsCommandOutput,
 } from "./commands/ListDataIngestionJobsCommand";
 import { ListDatasetsCommandInput, ListDatasetsCommandOutput } from "./commands/ListDatasetsCommand";
+import {
+  ListInferenceEventsCommandInput,
+  ListInferenceEventsCommandOutput,
+} from "./commands/ListInferenceEventsCommand";
 import {
   ListInferenceExecutionsCommandInput,
   ListInferenceExecutionsCommandOutput,
@@ -130,6 +134,7 @@ export type ServiceInputTypes =
   | DescribeModelCommandInput
   | ListDataIngestionJobsCommandInput
   | ListDatasetsCommandInput
+  | ListInferenceEventsCommandInput
   | ListInferenceExecutionsCommandInput
   | ListInferenceSchedulersCommandInput
   | ListModelsCommandInput
@@ -155,6 +160,7 @@ export type ServiceOutputTypes =
   | DescribeModelCommandOutput
   | ListDataIngestionJobsCommandOutput
   | ListDatasetsCommandOutput
+  | ListInferenceEventsCommandOutput
   | ListInferenceExecutionsCommandOutput
   | ListInferenceSchedulersCommandOutput
   | ListModelsCommandOutput
@@ -321,8 +327,9 @@ type LookoutEquipmentClientResolvedConfigType = __SmithyResolvedConfiguration<__
 export interface LookoutEquipmentClientResolvedConfig extends LookoutEquipmentClientResolvedConfigType {}
 
 /**
- * <p>Amazon Lookout for Equipment is a machine learning service that uses advanced analytics to identify
- *          anomalies in machines from sensor data for use in predictive maintenance. </p>
+ * <p>Amazon Lookout for Equipment is a machine learning service that uses advanced analytics
+ *          to identify anomalies in machines from sensor data for use in predictive maintenance.
+ *       </p>
  */
 export class LookoutEquipmentClient extends __Client<
   __HttpHandlerOptions,

clients/client-lookoutequipment/src/commands/CreateModelCommand.ts

@@ -25,10 +25,10 @@ export interface CreateModelCommandOutput extends CreateModelResponse, __Metadat
 /**
  * <p>Creates an ML model for data inference. </p>
  *          <p>A machine-learning (ML) model is a mathematical model that finds patterns in your data.
- *          In Amazon Lookout for Equipment, the model learns the patterns of normal behavior and detects abnormal
- *          behavior that could be potential equipment failure (or maintenance events). The models are
- *          made by analyzing normal data and abnormalities in machine behavior that have already
- *          occurred.</p>
+ *          In Amazon Lookout for Equipment, the model learns the patterns of normal behavior and
+ *          detects abnormal behavior that could be potential equipment failure (or maintenance
+ *          events). The models are made by analyzing normal data and abnormalities in machine behavior
+ *          that have already occurred.</p>
  *          <p>Your model is trained using a portion of the data from your dataset and uses that data
  *          to learn patterns of normal behavior and abnormal patterns that lead to equipment failure.
  *          Another portion of the data is used to evaluate the model's accuracy. </p>

clients/client-lookoutequipment/src/commands/DeleteModelCommand.ts

@@ -23,8 +23,9 @@ export interface DeleteModelCommandInput extends DeleteModelRequest {}
 export interface DeleteModelCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Deletes an ML model currently available for Amazon Lookout for Equipment. This will prevent it from
- *          being used with an inference scheduler, even one that is already set up. </p>
+ * <p>Deletes an ML model currently available for Amazon Lookout for Equipment. This will
+ *          prevent it from being used with an inference scheduler, even one that is already set up.
+ *       </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-lookoutequipment/src/commands/DescribeDatasetCommand.ts

@@ -23,7 +23,8 @@ export interface DescribeDatasetCommandInput extends DescribeDatasetRequest {}
 export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, __MetadataBearer {}
 
 /**
- * <p>Provides a JSON description of the data in each time series dataset, including names, column names, and data types.</p>
+ * <p>Provides a JSON description of the data in each time series dataset, including names,
+ *          column names, and data types.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-lookoutequipment/src/commands/DescribeModelCommand.ts

@@ -23,8 +23,9 @@ export interface DescribeModelCommandInput extends DescribeModelRequest {}
 export interface DescribeModelCommandOutput extends DescribeModelResponse, __MetadataBearer {}
 
 /**
- * <p>Provides a JSON containing the overall information about a specific ML model, including model name and ARN,
- *          dataset, training and evaluation information, status, and so on. </p>
+ * <p>Provides a JSON containing the overall information about a specific ML model, including
+ *          model name and ARN, dataset, training and evaluation information, status, and so on.
+ *       </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-lookoutequipment/src/commands/ListInferenceEventsCommand.ts

@@ -0,0 +1,97 @@
+// smithy-typescript generated code
+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 { LookoutEquipmentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LookoutEquipmentClient";
+import { ListInferenceEventsRequest, ListInferenceEventsResponse } from "../models/models_0";
+import {
+  deserializeAws_json1_0ListInferenceEventsCommand,
+  serializeAws_json1_0ListInferenceEventsCommand,
+} from "../protocols/Aws_json1_0";
+
+export interface ListInferenceEventsCommandInput extends ListInferenceEventsRequest {}
+export interface ListInferenceEventsCommandOutput extends ListInferenceEventsResponse, __MetadataBearer {}
+
+/**
+ * <p> Lists all inference events that have been found for the specified inference
+ *          scheduler. </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { LookoutEquipmentClient, ListInferenceEventsCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import
+ * // const { LookoutEquipmentClient, ListInferenceEventsCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import
+ * const client = new LookoutEquipmentClient(config);
+ * const command = new ListInferenceEventsCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link ListInferenceEventsCommandInput} for command's `input` shape.
+ * @see {@link ListInferenceEventsCommandOutput} for command's `response` shape.
+ * @see {@link LookoutEquipmentClientResolvedConfig | config} for LookoutEquipmentClient's `config` shape.
+ *
+ */
+export class ListInferenceEventsCommand extends $Command<
+  ListInferenceEventsCommandInput,
+  ListInferenceEventsCommandOutput,
+  LookoutEquipmentClientResolvedConfig
+> {
+  // Start section: command_properties
+  // End section: command_properties
+
+  constructor(readonly input: ListInferenceEventsCommandInput) {
+    // Start section: command_constructor
+    super();
+    // End section: command_constructor
+  }
+
+  /**
+   * @internal
+   */
+  resolveMiddleware(
+    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
+    configuration: LookoutEquipmentClientResolvedConfig,
+    options?: __HttpHandlerOptions
+  ): Handler<ListInferenceEventsCommandInput, ListInferenceEventsCommandOutput> {
+    this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
+
+    const stack = clientStack.concat(this.middlewareStack);
+
+    const { logger } = configuration;
+    const clientName = "LookoutEquipmentClient";
+    const commandName = "ListInferenceEventsCommand";
+    const handlerExecutionContext: HandlerExecutionContext = {
+      logger,
+      clientName,
+      commandName,
+      inputFilterSensitiveLog: ListInferenceEventsRequest.filterSensitiveLog,
+      outputFilterSensitiveLog: ListInferenceEventsResponse.filterSensitiveLog,
+    };
+    const { requestHandler } = configuration;
+    return stack.resolve(
+      (request: FinalizeHandlerArguments<any>) =>
+        requestHandler.handle(request.request as __HttpRequest, options || {}),
+      handlerExecutionContext
+    );
+  }
+
+  private serialize(input: ListInferenceEventsCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
+    return serializeAws_json1_0ListInferenceEventsCommand(input, context);
+  }
+
+  private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<ListInferenceEventsCommandOutput> {
+    return deserializeAws_json1_0ListInferenceEventsCommand(output, context);
+  }
+
+  // Start section: command_body_extra
+  // End section: command_body_extra
+}

clients/client-lookoutequipment/src/commands/ListSensorStatisticsCommand.ts

@@ -23,9 +23,9 @@ export interface ListSensorStatisticsCommandInput extends ListSensorStatisticsRe
 export interface ListSensorStatisticsCommandOutput extends ListSensorStatisticsResponse, __MetadataBearer {}
 
 /**
- * <p>
- * Lists statistics about the data collected for each of the sensors that have been successfully ingested in the particular dataset. Can also be used to retreive Sensor Statistics for a previous ingestion job.
- * </p>
+ * <p> Lists statistics about the data collected for each of the sensors that have been
+ *          successfully ingested in the particular dataset. Can also be used to retreive Sensor
+ *          Statistics for a previous ingestion job. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-lookoutequipment/src/commands/StartDataIngestionJobCommand.ts

@@ -23,7 +23,8 @@ export interface StartDataIngestionJobCommandInput extends StartDataIngestionJob
 export interface StartDataIngestionJobCommandOutput extends StartDataIngestionJobResponse, __MetadataBearer {}
 
 /**
- * <p>Starts a data ingestion job. Amazon Lookout for Equipment returns the job status. </p>
+ * <p>Starts a data ingestion job. Amazon Lookout for Equipment returns the job status.
+ *       </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-lookoutequipment/src/commands/TagResourceCommand.ts

@@ -24,10 +24,10 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
 
 /**
  * <p>Associates a given tag to a resource in your account. A tag is a key-value pair which
- *          can be added to an Amazon Lookout for Equipment resource as metadata. Tags can be used for organizing your
- *          resources as well as helping you to search and filter by tag. Multiple tags can be added to
- *          a resource, either when you create it, or later. Up to 50 tags can be associated with each
- *          resource. </p>
+ *          can be added to an Amazon Lookout for Equipment resource as metadata. Tags can be used for
+ *          organizing your resources as well as helping you to search and filter by tag. Multiple tags
+ *          can be added to a resource, either when you create it, or later. Up to 50 tags can be
+ *          associated with each resource. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -11,6 +11,7 @@ export * from "./DescribeInferenceSchedulerCommand";
 export * from "./DescribeModelCommand";
 export * from "./ListDataIngestionJobsCommand";
 export * from "./ListDatasetsCommand";
+export * from "./ListInferenceEventsCommand";
 export * from "./ListInferenceExecutionsCommand";
 export * from "./ListInferenceSchedulersCommand";
 export * from "./ListModelsCommand";