@aws-sdk/client-lookoutequipment 3.515.0 → 3.519.0

package/dist-cjs/index.js

@@ -73,6 +73,7 @@ __export(src_exports, {
   LookoutEquipmentClient: () => LookoutEquipmentClient,
   LookoutEquipmentServiceException: () => LookoutEquipmentServiceException,
   ModelPromoteMode: () => ModelPromoteMode,
+  ModelQuality: () => ModelQuality,
   ModelStatus: () => ModelStatus,
   ModelVersionSourceType: () => ModelVersionSourceType,
   ModelVersionStatus: () => ModelVersionStatus,
@@ -412,6 +413,11 @@ var DataUploadFrequency = {
   PT30M: "PT30M",
   PT5M: "PT5M"
 };
+var ModelQuality = {
+  CANNOT_DETERMINE_QUALITY: "CANNOT_DETERMINE_QUALITY",
+  POOR_QUALITY_DETECTED: "POOR_QUALITY_DETECTED",
+  QUALITY_THRESHOLD_MET: "QUALITY_THRESHOLD_MET"
+};
 var InferenceSchedulerStatus = {
   PENDING: "PENDING",
   RUNNING: "RUNNING",
@@ -1801,6 +1807,7 @@ var de_DescribeModelResponse = /* @__PURE__ */ __name((output, context) => {
     ModelDiagnosticsOutputConfiguration: import_smithy_client._json,
     ModelMetrics: (_) => new import_smithy_client.LazyJsonString(_),
     ModelName: import_smithy_client.expectString,
+    ModelQuality: import_smithy_client.expectString,
     ModelVersionActivatedAt: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))),
     NextScheduledRetrainingStartDate: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))),
     OffCondition: import_smithy_client.expectString,
@@ -1841,6 +1848,7 @@ var de_DescribeModelVersionResponse = /* @__PURE__ */ __name((output, context) =
     ModelDiagnosticsResultsObject: import_smithy_client._json,
     ModelMetrics: import_smithy_client.expectString,
     ModelName: import_smithy_client.expectString,
+    ModelQuality: import_smithy_client.expectString,
     ModelVersion: import_smithy_client.expectLong,
     ModelVersionArn: import_smithy_client.expectString,
     OffCondition: import_smithy_client.expectString,
@@ -2025,6 +2033,7 @@ var de_ModelSummary = /* @__PURE__ */ __name((output, context) => {
     ModelArn: import_smithy_client.expectString,
     ModelDiagnosticsOutputConfiguration: import_smithy_client._json,
     ModelName: import_smithy_client.expectString,
+    ModelQuality: import_smithy_client.expectString,
     NextScheduledRetrainingStartDate: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))),
     RetrainingSchedulerStatus: import_smithy_client.expectString,
     Status: import_smithy_client.expectString
@@ -2041,6 +2050,7 @@ var de_ModelVersionSummary = /* @__PURE__ */ __name((output, context) => {
     CreatedAt: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))),
     ModelArn: import_smithy_client.expectString,
     ModelName: import_smithy_client.expectString,
+    ModelQuality: import_smithy_client.expectString,
     ModelVersion: import_smithy_client.expectLong,
     ModelVersionArn: import_smithy_client.expectString,
     SourceType: import_smithy_client.expectString,
@@ -3170,6 +3180,7 @@ var import_util_endpoints = require("@aws-sdk/util-endpoints");
   ThrottlingException,
   ValidationException,
   DataUploadFrequency,
+  ModelQuality,
   InferenceSchedulerStatus,
   ResourceNotFoundException,
   LabelRating,

package/dist-es/models/models_0.js

@@ -97,6 +97,11 @@ export const DataUploadFrequency = {
     PT30M: "PT30M",
     PT5M: "PT5M",
 };
+export const ModelQuality = {
+    CANNOT_DETERMINE_QUALITY: "CANNOT_DETERMINE_QUALITY",
+    POOR_QUALITY_DETECTED: "POOR_QUALITY_DETECTED",
+    QUALITY_THRESHOLD_MET: "QUALITY_THRESHOLD_MET",
+};
 export const InferenceSchedulerStatus = {
     PENDING: "PENDING",
     RUNNING: "RUNNING",

package/dist-es/protocols/Aws_json1_0.js

@@ -1293,6 +1293,7 @@ const de_DescribeModelResponse = (output, context) => {
         ModelDiagnosticsOutputConfiguration: _json,
         ModelMetrics: (_) => new __LazyJsonString(_),
         ModelName: __expectString,
+        ModelQuality: __expectString,
         ModelVersionActivatedAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
         NextScheduledRetrainingStartDate: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
         OffCondition: __expectString,
@@ -1333,6 +1334,7 @@ const de_DescribeModelVersionResponse = (output, context) => {
         ModelDiagnosticsResultsObject: _json,
         ModelMetrics: __expectString,
         ModelName: __expectString,
+        ModelQuality: __expectString,
         ModelVersion: __expectLong,
         ModelVersionArn: __expectString,
         OffCondition: __expectString,
@@ -1527,6 +1529,7 @@ const de_ModelSummary = (output, context) => {
         ModelArn: __expectString,
         ModelDiagnosticsOutputConfiguration: _json,
         ModelName: __expectString,
+        ModelQuality: __expectString,
         NextScheduledRetrainingStartDate: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
         RetrainingSchedulerStatus: __expectString,
         Status: __expectString,
@@ -1545,6 +1548,7 @@ const de_ModelVersionSummary = (output, context) => {
         CreatedAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
         ModelArn: __expectString,
         ModelName: __expectString,
+        ModelQuality: __expectString,
         ModelVersion: __expectLong,
         ModelVersionArn: __expectString,
         SourceType: __expectString,

package/dist-types/commands/CreateInferenceSchedulerCommand.d.ts

@@ -76,6 +76,7 @@ declare const CreateInferenceSchedulerCommand_base: {
  * //   InferenceSchedulerArn: "STRING_VALUE",
  * //   InferenceSchedulerName: "STRING_VALUE",
  * //   Status: "PENDING" || "RUNNING" || "STOPPING" || "STOPPED",
+ * //   ModelQuality: "QUALITY_THRESHOLD_MET" || "CANNOT_DETERMINE_QUALITY" || "POOR_QUALITY_DETECTED",
  * // };
  *
  * ```

package/dist-types/commands/DescribeModelCommand.d.ts

@@ -96,6 +96,7 @@ declare const DescribeModelCommand_base: {
  * //     },
  * //     KmsKeyId: "STRING_VALUE",
  * //   },
+ * //   ModelQuality: "QUALITY_THRESHOLD_MET" || "CANNOT_DETERMINE_QUALITY" || "POOR_QUALITY_DETECTED",
  * // };
  *
  * ```

package/dist-types/commands/DescribeModelVersionCommand.d.ts

@@ -91,6 +91,7 @@ declare const DescribeModelVersionCommand_base: {
  * //     Bucket: "STRING_VALUE", // required
  * //     Key: "STRING_VALUE", // required
  * //   },
+ * //   ModelQuality: "QUALITY_THRESHOLD_MET" || "CANNOT_DETERMINE_QUALITY" || "POOR_QUALITY_DETECTED",
  * // };
  *
  * ```

package/dist-types/commands/ListModelVersionsCommand.d.ts

@@ -59,6 +59,7 @@ declare const ListModelVersionsCommand_base: {
  * //       CreatedAt: new Date("TIMESTAMP"),
  * //       Status: "IN_PROGRESS" || "SUCCESS" || "FAILED" || "IMPORT_IN_PROGRESS" || "CANCELED",
  * //       SourceType: "TRAINING" || "RETRAINING" || "IMPORT",
+ * //       ModelQuality: "QUALITY_THRESHOLD_MET" || "CANNOT_DETERMINE_QUALITY" || "POOR_QUALITY_DETECTED",
  * //     },
  * //   ],
  * // };

package/dist-types/commands/ListModelsCommand.d.ts

@@ -67,6 +67,7 @@ declare const ListModelsCommand_base: {
  * //         },
  * //         KmsKeyId: "STRING_VALUE",
  * //       },
+ * //       ModelQuality: "QUALITY_THRESHOLD_MET" || "CANNOT_DETERMINE_QUALITY" || "POOR_QUALITY_DETECTED",
  * //     },
  * //   ],
  * // };

package/dist-types/models/models_0.d.ts

@@ -375,6 +375,19 @@ export interface CreateInferenceSchedulerRequest {
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const ModelQuality: {
+    readonly CANNOT_DETERMINE_QUALITY: "CANNOT_DETERMINE_QUALITY";
+    readonly POOR_QUALITY_DETECTED: "POOR_QUALITY_DETECTED";
+    readonly QUALITY_THRESHOLD_MET: "QUALITY_THRESHOLD_MET";
+};
+/**
+ * @public
+ */
+export type ModelQuality = (typeof ModelQuality)[keyof typeof ModelQuality];
 /**
  * @public
  * @enum
@@ -408,6 +421,22 @@ export interface CreateInferenceSchedulerResponse {
      * <p>Indicates the status of the <code>CreateInferenceScheduler</code> operation. </p>
      */
     Status?: InferenceSchedulerStatus;
+    /**
+     * @public
+     * <p>Provides a quality assessment for a model that uses labels.
+     *          If Lookout for Equipment determines that the
+     *          model quality is poor based on training metrics, the value is
+     *          <code>POOR_QUALITY_DETECTED</code>. Otherwise, the value is
+     *          <code>QUALITY_THRESHOLD_MET</code>. </p>
+     *          <p>If the model is unlabeled, the model quality can't
+     *          be assessed and the value of <code>ModelQuality</code> is
+     *          <code>CANNOT_DETERMINE_QUALITY</code>. In this situation, you can get a model quality
+     *          assessment by adding labels to the input dataset and retraining the model.</p>
+     *          <p>For information about using labels with your models, see <a href="https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-labeling.html">Understanding labeling</a>.</p>
+     *          <p>For information about improving the quality of a model, see <a href="https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/best-practices.html">Best practices with
+     *          Amazon Lookout for Equipment</a>.</p>
+     */
+    ModelQuality?: ModelQuality;
 }
 /**
  * @public
@@ -1903,6 +1932,21 @@ export interface DescribeModelResponse {
      * <p>Configuration information for the model's pointwise model diagnostics.</p>
      */
     ModelDiagnosticsOutputConfiguration?: ModelDiagnosticsOutputConfiguration;
+    /**
+     * @public
+     * <p>Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the
+     *          model quality is poor based on training metrics, the value is
+     *          <code>POOR_QUALITY_DETECTED</code>. Otherwise, the value is
+     *          <code>QUALITY_THRESHOLD_MET</code>.</p>
+     *          <p>If the model is unlabeled, the model quality can't
+     *          be assessed and the value of <code>ModelQuality</code> is
+     *          <code>CANNOT_DETERMINE_QUALITY</code>. In this situation, you can get a model quality
+     *          assessment by adding labels to the input dataset and retraining the model.</p>
+     *          <p>For information about using labels with your models, see <a href="https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-labeling.html">Understanding labeling</a>.</p>
+     *          <p>For information about improving the quality of a model, see <a href="https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/best-practices.html">Best practices with
+     *          Amazon Lookout for Equipment</a>.</p>
+     */
+    ModelQuality?: ModelQuality;
 }
 /**
  * @public
@@ -2141,6 +2185,21 @@ export interface DescribeModelVersionResponse {
      * <p>The Amazon S3 output prefix for where Lookout for Equipment saves the pointwise model diagnostics for the model version.</p>
      */
     ModelDiagnosticsResultsObject?: S3Object;
+    /**
+     * @public
+     * <p>Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the
+     *          model quality is poor based on training metrics, the value is
+     *          <code>POOR_QUALITY_DETECTED</code>. Otherwise, the value is
+     *          <code>QUALITY_THRESHOLD_MET</code>.</p>
+     *          <p>If the model is unlabeled, the model quality can't
+     *          be assessed and the value of <code>ModelQuality</code> is
+     *          <code>CANNOT_DETERMINE_QUALITY</code>. In this situation, you can get a model quality
+     *          assessment by adding labels to the input dataset and retraining the model.</p>
+     *          <p>For information about using labels with your models, see <a href="https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-labeling.html">Understanding labeling</a>.</p>
+     *          <p>For information about improving the quality of a model, see <a href="https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/best-practices.html">Best practices with
+     *          Amazon Lookout for Equipment</a>.</p>
+     */
+    ModelQuality?: ModelQuality;
 }
 /**
  * @public
@@ -3206,6 +3265,21 @@ export interface ModelSummary {
      * <p>Output configuration information for the pointwise model diagnostics for an Amazon Lookout for Equipment model.</p>
      */
     ModelDiagnosticsOutputConfiguration?: ModelDiagnosticsOutputConfiguration;
+    /**
+     * @public
+     * <p>Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the
+     *          model quality is poor based on training metrics, the value is
+     *          <code>POOR_QUALITY_DETECTED</code>. Otherwise, the value is
+     *          <code>QUALITY_THRESHOLD_MET</code>.</p>
+     *          <p>If the model is unlabeled, the model quality can't
+     *          be assessed and the value of <code>ModelQuality</code> is
+     *          <code>CANNOT_DETERMINE_QUALITY</code>. In this situation, you can get a model quality
+     *          assessment by adding labels to the input dataset and retraining the model.</p>
+     *          <p>For information about using labels with your models, see <a href="https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-labeling.html">Understanding labeling</a>.</p>
+     *          <p>For information about improving the quality of a model, see <a href="https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/best-practices.html">Best practices with
+     *          Amazon Lookout for Equipment</a>.</p>
+     */
+    ModelQuality?: ModelQuality;
 }
 /**
  * @public
@@ -3319,6 +3393,20 @@ export interface ModelVersionSummary {
      * <p>Indicates how this model version was generated.</p>
      */
     SourceType?: ModelVersionSourceType;
+    /**
+     * @public
+     * <p>Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the
+     *          model quality is poor based on training metrics, the value is
+     *          <code>POOR_QUALITY_DETECTED</code>. Otherwise, the value is
+     *          <code>QUALITY_THRESHOLD_MET</code>. </p>
+     *          <p>If the model is unlabeled, the model quality can't
+     *          be assessed and the value of <code>ModelQuality</code> is
+     *          <code>CANNOT_DETERMINE_QUALITY</code>. In this situation, you can get a model quality
+     *          assessment by adding labels to the input dataset and retraining the model.</p>
+     *          <p>For information about improving the quality of a model, see <a href="https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/best-practices.html">Best practices with
+     *          Amazon Lookout for Equipment</a>.</p>
+     */
+    ModelQuality?: ModelQuality;
 }
 /**
  * @public

package/dist-types/ts3.4/models/models_0.d.ts

@@ -126,6 +126,12 @@ export interface CreateInferenceSchedulerRequest {
   ClientToken?: string;
   Tags?: Tag[];
 }
+export declare const ModelQuality: {
+  readonly CANNOT_DETERMINE_QUALITY: "CANNOT_DETERMINE_QUALITY";
+  readonly POOR_QUALITY_DETECTED: "POOR_QUALITY_DETECTED";
+  readonly QUALITY_THRESHOLD_MET: "QUALITY_THRESHOLD_MET";
+};
+export type ModelQuality = (typeof ModelQuality)[keyof typeof ModelQuality];
 export declare const InferenceSchedulerStatus: {
   readonly PENDING: "PENDING";
   readonly RUNNING: "RUNNING";
@@ -138,6 +144,7 @@ export interface CreateInferenceSchedulerResponse {
   InferenceSchedulerArn?: string;
   InferenceSchedulerName?: string;
   Status?: InferenceSchedulerStatus;
+  ModelQuality?: ModelQuality;
 }
 export declare class ResourceNotFoundException extends __BaseException {
   readonly name: "ResourceNotFoundException";
@@ -486,6 +493,7 @@ export interface DescribeModelResponse {
   AccumulatedInferenceDataEndTime?: Date;
   RetrainingSchedulerStatus?: RetrainingSchedulerStatus;
   ModelDiagnosticsOutputConfiguration?: ModelDiagnosticsOutputConfiguration;
+  ModelQuality?: ModelQuality;
 }
 export interface DescribeModelVersionRequest {
   ModelName: string | undefined;
@@ -533,6 +541,7 @@ export interface DescribeModelVersionResponse {
   AutoPromotionResultReason?: string;
   ModelDiagnosticsOutputConfiguration?: ModelDiagnosticsOutputConfiguration;
   ModelDiagnosticsResultsObject?: S3Object;
+  ModelQuality?: ModelQuality;
 }
 export interface DescribeResourcePolicyRequest {
   ResourceArn: string | undefined;
@@ -763,6 +772,7 @@ export interface ModelSummary {
   NextScheduledRetrainingStartDate?: Date;
   RetrainingSchedulerStatus?: RetrainingSchedulerStatus;
   ModelDiagnosticsOutputConfiguration?: ModelDiagnosticsOutputConfiguration;
+  ModelQuality?: ModelQuality;
 }
 export interface ListModelsResponse {
   NextToken?: string;
@@ -787,6 +797,7 @@ export interface ModelVersionSummary {
   CreatedAt?: Date;
   Status?: ModelVersionStatus;
   SourceType?: ModelVersionSourceType;
+  ModelQuality?: ModelQuality;
 }
 export interface ListModelVersionsResponse {
   NextToken?: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-lookoutequipment",
   "description": "AWS SDK for JavaScript Lookoutequipment Client for Node.js, Browser and React Native",
-  "version": "3.515.0",
+  "version": "3.519.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-lookoutequipment",