@aws-sdk/client-lookoutequipment 3.513.0 → 3.514.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist-cjs/index.js CHANGED
@@ -1563,6 +1563,7 @@ var se_CreateModelRequest = /* @__PURE__ */ __name((input, context) => {
1563
1563
  EvaluationDataEndTime: (_) => Math.round(_.getTime() / 1e3),
1564
1564
  EvaluationDataStartTime: (_) => Math.round(_.getTime() / 1e3),
1565
1565
  LabelsInputConfiguration: import_smithy_client._json,
1566
+ ModelDiagnosticsOutputConfiguration: import_smithy_client._json,
1566
1567
  ModelName: [],
1567
1568
  OffCondition: [],
1568
1569
  RoleArn: [],
@@ -1797,6 +1798,7 @@ var de_DescribeModelResponse = /* @__PURE__ */ __name((output, context) => {
1797
1798
  LatestScheduledRetrainingStartTime: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))),
1798
1799
  LatestScheduledRetrainingStatus: import_smithy_client.expectString,
1799
1800
  ModelArn: import_smithy_client.expectString,
1801
+ ModelDiagnosticsOutputConfiguration: import_smithy_client._json,
1800
1802
  ModelMetrics: (_) => new import_smithy_client.LazyJsonString(_),
1801
1803
  ModelName: import_smithy_client.expectString,
1802
1804
  ModelVersionActivatedAt: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))),
@@ -1835,6 +1837,8 @@ var de_DescribeModelVersionResponse = /* @__PURE__ */ __name((output, context) =
1835
1837
  LabelsInputConfiguration: import_smithy_client._json,
1836
1838
  LastUpdatedTime: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))),
1837
1839
  ModelArn: import_smithy_client.expectString,
1840
+ ModelDiagnosticsOutputConfiguration: import_smithy_client._json,
1841
+ ModelDiagnosticsResultsObject: import_smithy_client._json,
1838
1842
  ModelMetrics: import_smithy_client.expectString,
1839
1843
  ModelName: import_smithy_client.expectString,
1840
1844
  ModelVersion: import_smithy_client.expectLong,
@@ -2019,6 +2023,7 @@ var de_ModelSummary = /* @__PURE__ */ __name((output, context) => {
2019
2023
  LatestScheduledRetrainingStartTime: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))),
2020
2024
  LatestScheduledRetrainingStatus: import_smithy_client.expectString,
2021
2025
  ModelArn: import_smithy_client.expectString,
2026
+ ModelDiagnosticsOutputConfiguration: import_smithy_client._json,
2022
2027
  ModelName: import_smithy_client.expectString,
2023
2028
  NextScheduledRetrainingStartDate: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))),
2024
2029
  RetrainingSchedulerStatus: import_smithy_client.expectString,
@@ -1053,6 +1053,7 @@ const se_CreateModelRequest = (input, context) => {
1053
1053
  EvaluationDataEndTime: (_) => Math.round(_.getTime() / 1000),
1054
1054
  EvaluationDataStartTime: (_) => Math.round(_.getTime() / 1000),
1055
1055
  LabelsInputConfiguration: _json,
1056
+ ModelDiagnosticsOutputConfiguration: _json,
1056
1057
  ModelName: [],
1057
1058
  OffCondition: [],
1058
1059
  RoleArn: [],
@@ -1289,6 +1290,7 @@ const de_DescribeModelResponse = (output, context) => {
1289
1290
  LatestScheduledRetrainingStartTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
1290
1291
  LatestScheduledRetrainingStatus: __expectString,
1291
1292
  ModelArn: __expectString,
1293
+ ModelDiagnosticsOutputConfiguration: _json,
1292
1294
  ModelMetrics: (_) => new __LazyJsonString(_),
1293
1295
  ModelName: __expectString,
1294
1296
  ModelVersionActivatedAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
@@ -1327,6 +1329,8 @@ const de_DescribeModelVersionResponse = (output, context) => {
1327
1329
  LabelsInputConfiguration: _json,
1328
1330
  LastUpdatedTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
1329
1331
  ModelArn: __expectString,
1332
+ ModelDiagnosticsOutputConfiguration: _json,
1333
+ ModelDiagnosticsResultsObject: _json,
1330
1334
  ModelMetrics: __expectString,
1331
1335
  ModelName: __expectString,
1332
1336
  ModelVersion: __expectLong,
@@ -1521,6 +1525,7 @@ const de_ModelSummary = (output, context) => {
1521
1525
  LatestScheduledRetrainingStartTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
1522
1526
  LatestScheduledRetrainingStatus: __expectString,
1523
1527
  ModelArn: __expectString,
1528
+ ModelDiagnosticsOutputConfiguration: _json,
1524
1529
  ModelName: __expectString,
1525
1530
  NextScheduledRetrainingStartDate: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
1526
1531
  RetrainingSchedulerStatus: __expectString,
@@ -71,6 +71,13 @@ declare const CreateModelCommand_base: {
71
71
  * },
72
72
  * ],
73
73
  * OffCondition: "STRING_VALUE",
74
+ * ModelDiagnosticsOutputConfiguration: { // ModelDiagnosticsOutputConfiguration
75
+ * S3OutputConfiguration: { // ModelDiagnosticsS3OutputConfiguration
76
+ * Bucket: "STRING_VALUE", // required
77
+ * Prefix: "STRING_VALUE",
78
+ * },
79
+ * KmsKeyId: "STRING_VALUE",
80
+ * },
74
81
  * };
75
82
  * const command = new CreateModelCommand(input);
76
83
  * const response = await client.send(command);
@@ -89,6 +89,13 @@ declare const DescribeModelCommand_base: {
89
89
  * // AccumulatedInferenceDataStartTime: new Date("TIMESTAMP"),
90
90
  * // AccumulatedInferenceDataEndTime: new Date("TIMESTAMP"),
91
91
  * // RetrainingSchedulerStatus: "PENDING" || "RUNNING" || "STOPPING" || "STOPPED",
92
+ * // ModelDiagnosticsOutputConfiguration: { // ModelDiagnosticsOutputConfiguration
93
+ * // S3OutputConfiguration: { // ModelDiagnosticsS3OutputConfiguration
94
+ * // Bucket: "STRING_VALUE", // required
95
+ * // Prefix: "STRING_VALUE",
96
+ * // },
97
+ * // KmsKeyId: "STRING_VALUE",
98
+ * // },
92
99
  * // };
93
100
  *
94
101
  * ```
@@ -80,6 +80,17 @@ declare const DescribeModelVersionCommand_base: {
80
80
  * // RetrainingAvailableDataInDays: Number("int"),
81
81
  * // AutoPromotionResult: "MODEL_PROMOTED" || "MODEL_NOT_PROMOTED" || "RETRAINING_INTERNAL_ERROR" || "RETRAINING_CUSTOMER_ERROR" || "RETRAINING_CANCELLED",
82
82
  * // AutoPromotionResultReason: "STRING_VALUE",
83
+ * // ModelDiagnosticsOutputConfiguration: { // ModelDiagnosticsOutputConfiguration
84
+ * // S3OutputConfiguration: { // ModelDiagnosticsS3OutputConfiguration
85
+ * // Bucket: "STRING_VALUE", // required
86
+ * // Prefix: "STRING_VALUE",
87
+ * // },
88
+ * // KmsKeyId: "STRING_VALUE",
89
+ * // },
90
+ * // ModelDiagnosticsResultsObject: { // S3Object
91
+ * // Bucket: "STRING_VALUE", // required
92
+ * // Key: "STRING_VALUE", // required
93
+ * // },
83
94
  * // };
84
95
  *
85
96
  * ```
@@ -60,6 +60,13 @@ declare const ListModelsCommand_base: {
60
60
  * // LatestScheduledRetrainingStartTime: new Date("TIMESTAMP"),
61
61
  * // NextScheduledRetrainingStartDate: new Date("TIMESTAMP"),
62
62
  * // RetrainingSchedulerStatus: "PENDING" || "RUNNING" || "STOPPING" || "STOPPED",
63
+ * // ModelDiagnosticsOutputConfiguration: { // ModelDiagnosticsOutputConfiguration
64
+ * // S3OutputConfiguration: { // ModelDiagnosticsS3OutputConfiguration
65
+ * // Bucket: "STRING_VALUE", // required
66
+ * // Prefix: "STRING_VALUE",
67
+ * // },
68
+ * // KmsKeyId: "STRING_VALUE",
69
+ * // },
63
70
  * // },
64
71
  * // ],
65
72
  * // };
@@ -43,6 +43,13 @@ declare const UpdateModelCommand_base: {
43
43
  * LabelGroupName: "STRING_VALUE",
44
44
  * },
45
45
  * RoleArn: "STRING_VALUE",
46
+ * ModelDiagnosticsOutputConfiguration: { // ModelDiagnosticsOutputConfiguration
47
+ * S3OutputConfiguration: { // ModelDiagnosticsS3OutputConfiguration
48
+ * Bucket: "STRING_VALUE", // required
49
+ * Prefix: "STRING_VALUE",
50
+ * },
51
+ * KmsKeyId: "STRING_VALUE",
52
+ * },
46
53
  * };
47
54
  * const command = new UpdateModelCommand(input);
48
55
  * const response = await client.send(command);
@@ -632,6 +632,45 @@ export interface LabelsInputConfiguration {
632
632
  */
633
633
  LabelGroupName?: string;
634
634
  }
635
+ /**
636
+ * @public
637
+ * <p>The Amazon S3 location for the pointwise model diagnostics for an Amazon Lookout for Equipment model. </p>
638
+ */
639
+ export interface ModelDiagnosticsS3OutputConfiguration {
640
+ /**
641
+ * @public
642
+ * <p>The name of the Amazon S3 bucket where the pointwise model diagnostics are located. You must be the owner of the Amazon S3 bucket. </p>
643
+ */
644
+ Bucket: string | undefined;
645
+ /**
646
+ * @public
647
+ * <p>The Amazon S3 prefix for the location of the pointwise model diagnostics. The
648
+ * prefix specifies the folder and evaluation result file name.
649
+ * (<code>bucket</code>).</p>
650
+ * <p>When you call <code>CreateModel</code> or <code>UpdateModel</code>, specify the path
651
+ * within the bucket that you want Lookout for Equipment to save the model to. During training, Lookout for Equipment creates the model evaluation model
652
+ * as a compressed JSON file with the name <code>model_diagnostics_results.json.gz</code>.</p>
653
+ * <p>When you call <code>DescribeModel</code> or <code>DescribeModelVersion</code>, <code>prefix</code> contains
654
+ * the file path and filename of the model evaluation file. </p>
655
+ */
656
+ Prefix?: string;
657
+ }
658
+ /**
659
+ * @public
660
+ * <p>Output configuration information for the pointwise model diagnostics for an Amazon Lookout for Equipment model.</p>
661
+ */
662
+ export interface ModelDiagnosticsOutputConfiguration {
663
+ /**
664
+ * @public
665
+ * <p>The Amazon S3 location for the pointwise model diagnostics. </p>
666
+ */
667
+ S3OutputConfiguration: ModelDiagnosticsS3OutputConfiguration | undefined;
668
+ /**
669
+ * @public
670
+ * <p>The Amazon Web Services Key Management Service (KMS) key identifier to encrypt the pointwise model diagnostics files.</p>
671
+ */
672
+ KmsKeyId?: string;
673
+ }
635
674
  /**
636
675
  * @public
637
676
  */
@@ -724,6 +763,14 @@ export interface CreateModelRequest {
724
763
  * evaluation, or inference.</p>
725
764
  */
726
765
  OffCondition?: string;
766
+ /**
767
+ * @public
768
+ * <p>The Amazon S3 location where you want Amazon Lookout for Equipment to save the pointwise model diagnostics.
769
+ *
770
+ *
771
+ * You must also specify the <code>RoleArn</code> request parameter.</p>
772
+ */
773
+ ModelDiagnosticsOutputConfiguration?: ModelDiagnosticsOutputConfiguration;
727
774
  }
728
775
  /**
729
776
  * @public
@@ -973,7 +1020,7 @@ export interface MissingCompleteSensorData {
973
1020
  export interface SensorsWithShortDateRange {
974
1021
  /**
975
1022
  * @public
976
- * <p> Indicates the number of sensors that have less than 90 days of data. </p>
1023
+ * <p> Indicates the number of sensors that have less than 14 days of data. </p>
977
1024
  */
978
1025
  AffectedSensorCount: number | undefined;
979
1026
  }
@@ -992,7 +1039,7 @@ export interface InsufficientSensorData {
992
1039
  /**
993
1040
  * @public
994
1041
  * <p> Parameter that describes the total number of sensors that have a short date range of
995
- * less than 90 days of data overall. </p>
1042
+ * less than 14 days of data overall. </p>
996
1043
  */
997
1044
  SensorsWithShortDateRange: SensorsWithShortDateRange | undefined;
998
1045
  }
@@ -1327,7 +1374,7 @@ export interface DescribeDatasetResponse {
1327
1374
  DataQualitySummary?: DataQualitySummary;
1328
1375
  /**
1329
1376
  * @public
1330
- * <p> IngestedFilesSummary associated with the given dataset for the latest successful
1377
+ * <p>IngestedFilesSummary associated with the given dataset for the latest successful
1331
1378
  * associated ingestion job id. </p>
1332
1379
  */
1333
1380
  IngestedFilesSummary?: IngestedFilesSummary;
@@ -1851,6 +1898,11 @@ export interface DescribeModelResponse {
1851
1898
  * <p>Indicates the status of the retraining scheduler. </p>
1852
1899
  */
1853
1900
  RetrainingSchedulerStatus?: RetrainingSchedulerStatus;
1901
+ /**
1902
+ * @public
1903
+ * <p>Configuration information for the model's pointwise model diagnostics.</p>
1904
+ */
1905
+ ModelDiagnosticsOutputConfiguration?: ModelDiagnosticsOutputConfiguration;
1854
1906
  }
1855
1907
  /**
1856
1908
  * @public
@@ -2079,6 +2131,16 @@ export interface DescribeModelVersionResponse {
2079
2131
  * better than the previous model. </p>
2080
2132
  */
2081
2133
  AutoPromotionResultReason?: string;
2134
+ /**
2135
+ * @public
2136
+ * <p>The Amazon S3 location where Amazon Lookout for Equipment saves the pointwise model diagnostics for the model version.</p>
2137
+ */
2138
+ ModelDiagnosticsOutputConfiguration?: ModelDiagnosticsOutputConfiguration;
2139
+ /**
2140
+ * @public
2141
+ * <p>The Amazon S3 output prefix for where Lookout for Equipment saves the pointwise model diagnostics for the model version.</p>
2142
+ */
2143
+ ModelDiagnosticsResultsObject?: S3Object;
2082
2144
  }
2083
2145
  /**
2084
2146
  * @public
@@ -2735,7 +2797,13 @@ export interface ListInferenceExecutionsResponse {
2735
2797
  * @public
2736
2798
  * <p>Provides an array of information about the individual inference executions returned from
2737
2799
  * the <code>ListInferenceExecutions</code> operation, including model used, inference
2738
- * scheduler, data configuration, and so on. </p>
2800
+ * scheduler, data configuration, and so on. </p>
2801
+ * <note>
2802
+ * <p>If you don't supply the <code>InferenceSchedulerName</code> request parameter, or
2803
+ * if you supply the name of an inference scheduler that doesn't exist,
2804
+ * <code>ListInferenceExecutions</code> returns an empty array in
2805
+ * <code>InferenceExecutionSummaries</code>.</p>
2806
+ * </note>
2739
2807
  */
2740
2808
  InferenceExecutionSummaries?: InferenceExecutionSummary[];
2741
2809
  }
@@ -2916,7 +2984,7 @@ export interface ListLabelGroupsResponse {
2916
2984
  export interface ListLabelsRequest {
2917
2985
  /**
2918
2986
  * @public
2919
- * <p> Retruns the name of the label group. </p>
2987
+ * <p> Returns the name of the label group. </p>
2920
2988
  */
2921
2989
  LabelGroupName: string | undefined;
2922
2990
  /**
@@ -3018,6 +3086,11 @@ export interface ListLabelsResponse {
3018
3086
  /**
3019
3087
  * @public
3020
3088
  * <p> A summary of the items in the label group. </p>
3089
+ * <note>
3090
+ * <p>If you don't supply the <code>LabelGroupName</code> request parameter, or if you supply
3091
+ * the name of a label group that doesn't exist, <code>ListLabels</code> returns an empty array in
3092
+ * <code>LabelSummaries</code>.</p>
3093
+ * </note>
3021
3094
  */
3022
3095
  LabelSummaries?: LabelSummary[];
3023
3096
  }
@@ -3128,6 +3201,11 @@ export interface ModelSummary {
3128
3201
  * <p>Indicates the status of the retraining scheduler. </p>
3129
3202
  */
3130
3203
  RetrainingSchedulerStatus?: RetrainingSchedulerStatus;
3204
+ /**
3205
+ * @public
3206
+ * <p>Output configuration information for the pointwise model diagnostics for an Amazon Lookout for Equipment model.</p>
3207
+ */
3208
+ ModelDiagnosticsOutputConfiguration?: ModelDiagnosticsOutputConfiguration;
3131
3209
  }
3132
3210
  /**
3133
3211
  * @public
@@ -3258,6 +3336,11 @@ export interface ListModelVersionsResponse {
3258
3336
  * @public
3259
3337
  * <p>Provides information on the specified model version, including the created time, model
3260
3338
  * and dataset ARNs, and status.</p>
3339
+ * <note>
3340
+ * <p>If you don't supply the <code>ModelName</code> request parameter, or if you supply the name
3341
+ * of a model that doesn't exist, <code>ListModelVersions</code> returns an empty array in
3342
+ * <code>ModelVersionSummaries</code>. </p>
3343
+ * </note>
3261
3344
  */
3262
3345
  ModelVersionSummaries?: ModelVersionSummary[];
3263
3346
  }
@@ -4020,6 +4103,12 @@ export interface UpdateModelRequest {
4020
4103
  * <p>The ARN of the model to update.</p>
4021
4104
  */
4022
4105
  RoleArn?: string;
4106
+ /**
4107
+ * @public
4108
+ * <p>The Amazon S3 location where you want Amazon Lookout for Equipment to save the pointwise model diagnostics for the model.
4109
+ * You must also specify the <code>RoleArn</code> request parameter.</p>
4110
+ */
4111
+ ModelDiagnosticsOutputConfiguration?: ModelDiagnosticsOutputConfiguration;
4023
4112
  }
4024
4113
  /**
4025
4114
  * @public
@@ -202,6 +202,14 @@ export interface LabelsInputConfiguration {
202
202
  S3InputConfiguration?: LabelsS3InputConfiguration;
203
203
  LabelGroupName?: string;
204
204
  }
205
+ export interface ModelDiagnosticsS3OutputConfiguration {
206
+ Bucket: string | undefined;
207
+ Prefix?: string;
208
+ }
209
+ export interface ModelDiagnosticsOutputConfiguration {
210
+ S3OutputConfiguration: ModelDiagnosticsS3OutputConfiguration | undefined;
211
+ KmsKeyId?: string;
212
+ }
205
213
  export interface CreateModelRequest {
206
214
  ModelName: string | undefined;
207
215
  DatasetName: string | undefined;
@@ -217,6 +225,7 @@ export interface CreateModelRequest {
217
225
  ServerSideKmsKeyId?: string;
218
226
  Tags?: Tag[];
219
227
  OffCondition?: string;
228
+ ModelDiagnosticsOutputConfiguration?: ModelDiagnosticsOutputConfiguration;
220
229
  }
221
230
  export declare const ModelStatus: {
222
231
  readonly FAILED: "FAILED";
@@ -476,6 +485,7 @@ export interface DescribeModelResponse {
476
485
  AccumulatedInferenceDataStartTime?: Date;
477
486
  AccumulatedInferenceDataEndTime?: Date;
478
487
  RetrainingSchedulerStatus?: RetrainingSchedulerStatus;
488
+ ModelDiagnosticsOutputConfiguration?: ModelDiagnosticsOutputConfiguration;
479
489
  }
480
490
  export interface DescribeModelVersionRequest {
481
491
  ModelName: string | undefined;
@@ -521,6 +531,8 @@ export interface DescribeModelVersionResponse {
521
531
  RetrainingAvailableDataInDays?: number;
522
532
  AutoPromotionResult?: AutoPromotionResult;
523
533
  AutoPromotionResultReason?: string;
534
+ ModelDiagnosticsOutputConfiguration?: ModelDiagnosticsOutputConfiguration;
535
+ ModelDiagnosticsResultsObject?: S3Object;
524
536
  }
525
537
  export interface DescribeResourcePolicyRequest {
526
538
  ResourceArn: string | undefined;
@@ -750,6 +762,7 @@ export interface ModelSummary {
750
762
  LatestScheduledRetrainingStartTime?: Date;
751
763
  NextScheduledRetrainingStartDate?: Date;
752
764
  RetrainingSchedulerStatus?: RetrainingSchedulerStatus;
765
+ ModelDiagnosticsOutputConfiguration?: ModelDiagnosticsOutputConfiguration;
753
766
  }
754
767
  export interface ListModelsResponse {
755
768
  NextToken?: string;
@@ -954,6 +967,7 @@ export interface UpdateModelRequest {
954
967
  ModelName: string | undefined;
955
968
  LabelsInputConfiguration?: LabelsInputConfiguration;
956
969
  RoleArn?: string;
970
+ ModelDiagnosticsOutputConfiguration?: ModelDiagnosticsOutputConfiguration;
957
971
  }
958
972
  export interface UpdateRetrainingSchedulerRequest {
959
973
  ModelName: string | undefined;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-lookoutequipment",
3
3
  "description": "AWS SDK for JavaScript Lookoutequipment Client for Node.js, Browser and React Native",
4
- "version": "3.513.0",
4
+ "version": "3.514.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-lookoutequipment",
@@ -22,7 +22,7 @@
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
23
  "@aws-sdk/client-sts": "3.513.0",
24
24
  "@aws-sdk/core": "3.513.0",
25
- "@aws-sdk/credential-provider-node": "3.513.0",
25
+ "@aws-sdk/credential-provider-node": "3.514.0",
26
26
  "@aws-sdk/middleware-host-header": "3.511.0",
27
27
  "@aws-sdk/middleware-logger": "3.511.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.511.0",