@aws-sdk/client-lookoutequipment 3.379.1 → 3.382.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.
Files changed (97) hide show
  1. package/README.md +64 -0
  2. package/dist-cjs/LookoutEquipment.js +16 -0
  3. package/dist-cjs/commands/DeleteResourcePolicyCommand.js +46 -0
  4. package/dist-cjs/commands/DescribeModelVersionCommand.js +46 -0
  5. package/dist-cjs/commands/DescribeResourcePolicyCommand.js +46 -0
  6. package/dist-cjs/commands/ImportDatasetCommand.js +46 -0
  7. package/dist-cjs/commands/ImportModelVersionCommand.js +46 -0
  8. package/dist-cjs/commands/ListModelVersionsCommand.js +46 -0
  9. package/dist-cjs/commands/PutResourcePolicyCommand.js +46 -0
  10. package/dist-cjs/commands/UpdateActiveModelVersionCommand.js +46 -0
  11. package/dist-cjs/commands/index.js +8 -0
  12. package/dist-cjs/endpoint/ruleset.js +3 -3
  13. package/dist-cjs/models/models_0.js +16 -1
  14. package/dist-cjs/pagination/ListModelVersionsPaginator.js +29 -0
  15. package/dist-cjs/pagination/index.js +1 -0
  16. package/dist-cjs/protocols/Aws_json1_0.js +559 -2
  17. package/dist-es/LookoutEquipment.js +16 -0
  18. package/dist-es/commands/DeleteResourcePolicyCommand.js +42 -0
  19. package/dist-es/commands/DescribeModelVersionCommand.js +42 -0
  20. package/dist-es/commands/DescribeResourcePolicyCommand.js +42 -0
  21. package/dist-es/commands/ImportDatasetCommand.js +42 -0
  22. package/dist-es/commands/ImportModelVersionCommand.js +42 -0
  23. package/dist-es/commands/ListModelVersionsCommand.js +42 -0
  24. package/dist-es/commands/PutResourcePolicyCommand.js +42 -0
  25. package/dist-es/commands/UpdateActiveModelVersionCommand.js +42 -0
  26. package/dist-es/commands/index.js +8 -0
  27. package/dist-es/endpoint/ruleset.js +3 -3
  28. package/dist-es/models/models_0.js +15 -0
  29. package/dist-es/pagination/ListModelVersionsPaginator.js +25 -0
  30. package/dist-es/pagination/index.js +1 -0
  31. package/dist-es/protocols/Aws_json1_0.js +541 -0
  32. package/dist-types/LookoutEquipment.d.ts +56 -0
  33. package/dist-types/LookoutEquipmentClient.d.ts +10 -2
  34. package/dist-types/commands/CreateDatasetCommand.d.ts +3 -3
  35. package/dist-types/commands/CreateInferenceSchedulerCommand.d.ts +1 -1
  36. package/dist-types/commands/CreateLabelCommand.d.ts +3 -3
  37. package/dist-types/commands/CreateLabelGroupCommand.d.ts +3 -3
  38. package/dist-types/commands/CreateModelCommand.d.ts +2 -2
  39. package/dist-types/commands/DeleteDatasetCommand.d.ts +1 -1
  40. package/dist-types/commands/DeleteInferenceSchedulerCommand.d.ts +1 -1
  41. package/dist-types/commands/DeleteLabelCommand.d.ts +3 -3
  42. package/dist-types/commands/DeleteLabelGroupCommand.d.ts +3 -3
  43. package/dist-types/commands/DeleteModelCommand.d.ts +1 -1
  44. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +94 -0
  45. package/dist-types/commands/DescribeDataIngestionJobCommand.d.ts +3 -2
  46. package/dist-types/commands/DescribeDatasetCommand.d.ts +3 -2
  47. package/dist-types/commands/DescribeInferenceSchedulerCommand.d.ts +1 -1
  48. package/dist-types/commands/DescribeLabelCommand.d.ts +3 -3
  49. package/dist-types/commands/DescribeLabelGroupCommand.d.ts +3 -3
  50. package/dist-types/commands/DescribeModelCommand.d.ts +11 -2
  51. package/dist-types/commands/DescribeModelVersionCommand.d.ts +128 -0
  52. package/dist-types/commands/DescribeResourcePolicyCommand.d.ts +95 -0
  53. package/dist-types/commands/ImportDatasetCommand.d.ts +111 -0
  54. package/dist-types/commands/ImportModelVersionCommand.d.ts +121 -0
  55. package/dist-types/commands/ListDataIngestionJobsCommand.d.ts +3 -3
  56. package/dist-types/commands/ListDatasetsCommand.d.ts +2 -2
  57. package/dist-types/commands/ListInferenceEventsCommand.d.ts +1 -1
  58. package/dist-types/commands/ListInferenceExecutionsCommand.d.ts +1 -1
  59. package/dist-types/commands/ListInferenceSchedulersCommand.d.ts +1 -1
  60. package/dist-types/commands/ListLabelGroupsCommand.d.ts +3 -3
  61. package/dist-types/commands/ListLabelsCommand.d.ts +3 -3
  62. package/dist-types/commands/ListModelVersionsCommand.d.ts +113 -0
  63. package/dist-types/commands/ListModelsCommand.d.ts +5 -3
  64. package/dist-types/commands/ListSensorStatisticsCommand.d.ts +1 -1
  65. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  66. package/dist-types/commands/PutResourcePolicyCommand.d.ts +103 -0
  67. package/dist-types/commands/StartDataIngestionJobCommand.d.ts +2 -2
  68. package/dist-types/commands/StartInferenceSchedulerCommand.d.ts +1 -1
  69. package/dist-types/commands/StopInferenceSchedulerCommand.d.ts +1 -1
  70. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  71. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  72. package/dist-types/commands/UpdateActiveModelVersionCommand.d.ts +102 -0
  73. package/dist-types/commands/UpdateInferenceSchedulerCommand.d.ts +1 -1
  74. package/dist-types/commands/UpdateLabelGroupCommand.d.ts +3 -3
  75. package/dist-types/commands/index.d.ts +8 -0
  76. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  77. package/dist-types/models/models_0.d.ts +1188 -141
  78. package/dist-types/pagination/ListModelVersionsPaginator.d.ts +7 -0
  79. package/dist-types/pagination/index.d.ts +1 -0
  80. package/dist-types/protocols/Aws_json1_0.d.ts +72 -0
  81. package/dist-types/ts3.4/LookoutEquipment.d.ts +136 -0
  82. package/dist-types/ts3.4/LookoutEquipmentClient.d.ts +48 -0
  83. package/dist-types/ts3.4/commands/DeleteResourcePolicyCommand.d.ts +37 -0
  84. package/dist-types/ts3.4/commands/DescribeModelVersionCommand.d.ts +42 -0
  85. package/dist-types/ts3.4/commands/DescribeResourcePolicyCommand.d.ts +42 -0
  86. package/dist-types/ts3.4/commands/ImportDatasetCommand.d.ts +38 -0
  87. package/dist-types/ts3.4/commands/ImportModelVersionCommand.d.ts +39 -0
  88. package/dist-types/ts3.4/commands/ListModelVersionsCommand.d.ts +39 -0
  89. package/dist-types/ts3.4/commands/PutResourcePolicyCommand.d.ts +39 -0
  90. package/dist-types/ts3.4/commands/UpdateActiveModelVersionCommand.d.ts +42 -0
  91. package/dist-types/ts3.4/commands/index.d.ts +8 -0
  92. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  93. package/dist-types/ts3.4/models/models_0.d.ts +154 -0
  94. package/dist-types/ts3.4/pagination/ListModelVersionsPaginator.d.ts +11 -0
  95. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  96. package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +96 -0
  97. package/package.json +5 -5
@@ -34,6 +34,7 @@ export declare class ConflictException extends __BaseException {
34
34
  */
35
35
  export interface DatasetSchema {
36
36
  /**
37
+ * @public
37
38
  * <p>
38
39
  * </p>
39
40
  */
@@ -45,10 +46,12 @@ export interface DatasetSchema {
45
46
  */
46
47
  export interface Tag {
47
48
  /**
49
+ * @public
48
50
  * <p>The key for the specified tag. </p>
49
51
  */
50
52
  Key: string | undefined;
51
53
  /**
54
+ * @public
52
55
  * <p>The value for the specified tag. </p>
53
56
  */
54
57
  Value: string | undefined;
@@ -58,25 +61,30 @@ export interface Tag {
58
61
  */
59
62
  export interface CreateDatasetRequest {
60
63
  /**
64
+ * @public
61
65
  * <p>The name of the dataset being created. </p>
62
66
  */
63
67
  DatasetName: string | undefined;
64
68
  /**
69
+ * @public
65
70
  * <p>A JSON description of the data that is in each time series dataset, including names,
66
71
  * column names, and data types. </p>
67
72
  */
68
73
  DatasetSchema?: DatasetSchema;
69
74
  /**
75
+ * @public
70
76
  * <p>Provides the identifier of the KMS key used to encrypt dataset data by Amazon Lookout
71
77
  * for Equipment. </p>
72
78
  */
73
79
  ServerSideKmsKeyId?: string;
74
80
  /**
81
+ * @public
75
82
  * <p> A unique identifier for the request. If you do not set the client request token, Amazon
76
83
  * Lookout for Equipment generates one. </p>
77
84
  */
78
85
  ClientToken?: string;
79
86
  /**
87
+ * @public
80
88
  * <p>Any tags associated with the ingested data described in the dataset. </p>
81
89
  */
82
90
  Tags?: Tag[];
@@ -88,6 +96,7 @@ export interface CreateDatasetRequest {
88
96
  export declare const DatasetStatus: {
89
97
  readonly ACTIVE: "ACTIVE";
90
98
  readonly CREATED: "CREATED";
99
+ readonly IMPORT_IN_PROGRESS: "IMPORT_IN_PROGRESS";
91
100
  readonly INGESTION_IN_PROGRESS: "INGESTION_IN_PROGRESS";
92
101
  };
93
102
  /**
@@ -99,14 +108,17 @@ export type DatasetStatus = (typeof DatasetStatus)[keyof typeof DatasetStatus];
99
108
  */
100
109
  export interface CreateDatasetResponse {
101
110
  /**
111
+ * @public
102
112
  * <p>The name of the dataset being created. </p>
103
113
  */
104
114
  DatasetName?: string;
105
115
  /**
116
+ * @public
106
117
  * <p> The Amazon Resource Name (ARN) of the dataset being created. </p>
107
118
  */
108
119
  DatasetArn?: string;
109
120
  /**
121
+ * @public
110
122
  * <p>Indicates the status of the <code>CreateDataset</code> operation. </p>
111
123
  */
112
124
  Status?: DatasetStatus | string;
@@ -154,7 +166,7 @@ export declare class ThrottlingException extends __BaseException {
154
166
  /**
155
167
  * @public
156
168
  * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a
157
- * related AWS service that's being utilized. </p>
169
+ * related Amazon Web Services service that's being utilized. </p>
158
170
  */
159
171
  export declare class ValidationException extends __BaseException {
160
172
  readonly name: "ValidationException";
@@ -172,11 +184,13 @@ export declare class ValidationException extends __BaseException {
172
184
  */
173
185
  export interface InferenceInputNameConfiguration {
174
186
  /**
187
+ * @public
175
188
  * <p>The format of the timestamp, whether Epoch time, or standard, with or without hyphens
176
189
  * (-). </p>
177
190
  */
178
191
  TimestampFormat?: string;
179
192
  /**
193
+ * @public
180
194
  * <p>Indicates the delimiter character used between items in the data. </p>
181
195
  */
182
196
  ComponentTimestampDelimiter?: string;
@@ -188,10 +202,12 @@ export interface InferenceInputNameConfiguration {
188
202
  */
189
203
  export interface InferenceS3InputConfiguration {
190
204
  /**
205
+ * @public
191
206
  * <p>The bucket containing the input dataset for the inference. </p>
192
207
  */
193
208
  Bucket: string | undefined;
194
209
  /**
210
+ * @public
195
211
  * <p>The prefix for the S3 bucket used for the input data for the inference. </p>
196
212
  */
197
213
  Prefix?: string;
@@ -203,16 +219,19 @@ export interface InferenceS3InputConfiguration {
203
219
  */
204
220
  export interface InferenceInputConfiguration {
205
221
  /**
222
+ * @public
206
223
  * <p> Specifies configuration information for the input data for the inference, including
207
224
  * Amazon S3 location of input data.</p>
208
225
  */
209
226
  S3InputConfiguration?: InferenceS3InputConfiguration;
210
227
  /**
228
+ * @public
211
229
  * <p>Indicates the difference between your time zone and Coordinated Universal Time
212
230
  * (UTC).</p>
213
231
  */
214
232
  InputTimeZoneOffset?: string;
215
233
  /**
234
+ * @public
216
235
  * <p>Specifies configuration information for the input data for the inference, including
217
236
  * timestamp format and delimiter. </p>
218
237
  */
@@ -225,10 +244,12 @@ export interface InferenceInputConfiguration {
225
244
  */
226
245
  export interface InferenceS3OutputConfiguration {
227
246
  /**
247
+ * @public
228
248
  * <p> The bucket containing the output results from the inference </p>
229
249
  */
230
250
  Bucket: string | undefined;
231
251
  /**
252
+ * @public
232
253
  * <p> The prefix for the S3 bucket used for the output results from the inference. </p>
233
254
  */
234
255
  Prefix?: string;
@@ -240,12 +261,14 @@ export interface InferenceS3OutputConfiguration {
240
261
  */
241
262
  export interface InferenceOutputConfiguration {
242
263
  /**
264
+ * @public
243
265
  * <p> Specifies configuration information for the output results from for the inference,
244
266
  * output S3 location. </p>
245
267
  */
246
268
  S3OutputConfiguration: InferenceS3OutputConfiguration | undefined;
247
269
  /**
248
- * <p>The ID number for the AWS KMS key used to encrypt the inference output. </p>
270
+ * @public
271
+ * <p>The ID number for the KMS key key used to encrypt the inference output. </p>
249
272
  */
250
273
  KmsKeyId?: string;
251
274
  }
@@ -269,15 +292,18 @@ export type DataUploadFrequency = (typeof DataUploadFrequency)[keyof typeof Data
269
292
  */
270
293
  export interface CreateInferenceSchedulerRequest {
271
294
  /**
295
+ * @public
272
296
  * <p>The name of the previously trained ML model being used to create the inference
273
297
  * scheduler. </p>
274
298
  */
275
299
  ModelName: string | undefined;
276
300
  /**
301
+ * @public
277
302
  * <p>The name of the inference scheduler being created. </p>
278
303
  */
279
304
  InferenceSchedulerName: string | undefined;
280
305
  /**
306
+ * @public
281
307
  * <p>The interval (in minutes) of planned delay at the start of each inference segment. For
282
308
  * example, if inference is set to run every ten minutes, the delay is set to five minutes and the time is 09:08. The inference scheduler will wake up at the
283
309
  * configured interval (which, without a delay configured, would be 09:10) plus the additional five minute delay time (so 09:15) to check your Amazon S3
@@ -287,6 +313,7 @@ export interface CreateInferenceSchedulerRequest {
287
313
  */
288
314
  DataDelayOffsetInMinutes?: number;
289
315
  /**
316
+ * @public
290
317
  * <p> How often data is uploaded to the source Amazon S3 bucket for the input data. The value chosen
291
318
  * is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5
292
319
  * minutes. This frequency also determines how often Amazon Lookout for Equipment runs inference on your data.</p>
@@ -294,31 +321,37 @@ export interface CreateInferenceSchedulerRequest {
294
321
  */
295
322
  DataUploadFrequency: DataUploadFrequency | string | undefined;
296
323
  /**
324
+ * @public
297
325
  * <p>Specifies configuration information for the input data for the inference scheduler,
298
326
  * including delimiter, format, and dataset location. </p>
299
327
  */
300
328
  DataInputConfiguration: InferenceInputConfiguration | undefined;
301
329
  /**
330
+ * @public
302
331
  * <p>Specifies configuration information for the output results for the inference scheduler,
303
332
  * including the S3 location for the output. </p>
304
333
  */
305
334
  DataOutputConfiguration: InferenceOutputConfiguration | undefined;
306
335
  /**
336
+ * @public
307
337
  * <p>The Amazon Resource Name (ARN) of a role with permission to access the data source being
308
338
  * used for the inference. </p>
309
339
  */
310
340
  RoleArn: string | undefined;
311
341
  /**
342
+ * @public
312
343
  * <p>Provides the identifier of the KMS key used to encrypt inference scheduler data by
313
344
  * Amazon Lookout for Equipment. </p>
314
345
  */
315
346
  ServerSideKmsKeyId?: string;
316
347
  /**
348
+ * @public
317
349
  * <p> A unique identifier for the request. If you do not set the client request token, Amazon
318
350
  * Lookout for Equipment generates one. </p>
319
351
  */
320
352
  ClientToken?: string;
321
353
  /**
354
+ * @public
322
355
  * <p>Any tags associated with the inference scheduler. </p>
323
356
  */
324
357
  Tags?: Tag[];
@@ -342,14 +375,17 @@ export type InferenceSchedulerStatus = (typeof InferenceSchedulerStatus)[keyof t
342
375
  */
343
376
  export interface CreateInferenceSchedulerResponse {
344
377
  /**
378
+ * @public
345
379
  * <p>The Amazon Resource Name (ARN) of the inference scheduler being created. </p>
346
380
  */
347
381
  InferenceSchedulerArn?: string;
348
382
  /**
383
+ * @public
349
384
  * <p>The name of inference scheduler being created. </p>
350
385
  */
351
386
  InferenceSchedulerName?: string;
352
387
  /**
388
+ * @public
353
389
  * <p>Indicates the status of the <code>CreateInferenceScheduler</code> operation. </p>
354
390
  */
355
391
  Status?: InferenceSchedulerStatus | string;
@@ -386,55 +422,63 @@ export type LabelRating = (typeof LabelRating)[keyof typeof LabelRating];
386
422
  */
387
423
  export interface CreateLabelRequest {
388
424
  /**
425
+ * @public
389
426
  * <p>
390
- * The name of a group of labels. </p>
427
+ * The name of a group of labels. </p>
391
428
  * <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.
392
- * </p>
429
+ * </p>
393
430
  */
394
431
  LabelGroupName: string | undefined;
395
432
  /**
433
+ * @public
396
434
  * <p>
397
- * The start time of the labeled event.
398
- * </p>
435
+ * The start time of the labeled event.
436
+ * </p>
399
437
  */
400
438
  StartTime: Date | undefined;
401
439
  /**
440
+ * @public
402
441
  * <p>
403
- * The end time of the labeled event.
404
- * </p>
442
+ * The end time of the labeled event.
443
+ * </p>
405
444
  */
406
445
  EndTime: Date | undefined;
407
446
  /**
447
+ * @public
408
448
  * <p>
409
- * Indicates whether a labeled event represents an anomaly.
410
- * </p>
449
+ * Indicates whether a labeled event represents an anomaly.
450
+ * </p>
411
451
  */
412
452
  Rating: LabelRating | string | undefined;
413
453
  /**
454
+ * @public
414
455
  * <p>
415
- * Provides additional information about the label. The fault code must be defined in the FaultCodes attribute of the label group.</p>
456
+ * Provides additional information about the label. The fault code must be defined in the FaultCodes attribute of the label group.</p>
416
457
  * <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.
417
- * </p>
458
+ * </p>
418
459
  */
419
460
  FaultCode?: string;
420
461
  /**
462
+ * @public
421
463
  * <p>
422
- * Metadata providing additional information about the label.
423
- * </p>
464
+ * Metadata providing additional information about the label.
465
+ * </p>
424
466
  * <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.</p>
425
467
  */
426
468
  Notes?: string;
427
469
  /**
470
+ * @public
428
471
  * <p>
429
- * Indicates that a label pertains to a particular piece of equipment.
430
- * </p>
472
+ * Indicates that a label pertains to a particular piece of equipment.
473
+ * </p>
431
474
  * <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.</p>
432
475
  */
433
476
  Equipment?: string;
434
477
  /**
478
+ * @public
435
479
  * <p>
436
- * A unique identifier for the request to create a label. If you do not set the client request token, Lookout for Equipment generates one.
437
- * </p>
480
+ * A unique identifier for the request to create a label. If you do not set the client request token, Lookout for Equipment generates one.
481
+ * </p>
438
482
  */
439
483
  ClientToken?: string;
440
484
  }
@@ -443,9 +487,10 @@ export interface CreateLabelRequest {
443
487
  */
444
488
  export interface CreateLabelResponse {
445
489
  /**
490
+ * @public
446
491
  * <p>
447
- * The ID of the label that you have created.
448
- * </p>
492
+ * The ID of the label that you have created.
493
+ * </p>
449
494
  */
450
495
  LabelId?: string;
451
496
  }
@@ -454,28 +499,32 @@ export interface CreateLabelResponse {
454
499
  */
455
500
  export interface CreateLabelGroupRequest {
456
501
  /**
502
+ * @public
457
503
  * <p>
458
- * Names a group of labels.</p>
504
+ * Names a group of labels.</p>
459
505
  * <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.
460
- * </p>
506
+ * </p>
461
507
  */
462
508
  LabelGroupName: string | undefined;
463
509
  /**
510
+ * @public
464
511
  * <p>
465
- * The acceptable fault codes (indicating the type of anomaly associated with the label) that can be used with this label group.</p>
512
+ * The acceptable fault codes (indicating the type of anomaly associated with the label) that can be used with this label group.</p>
466
513
  * <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.</p>
467
514
  */
468
515
  FaultCodes?: string[];
469
516
  /**
517
+ * @public
470
518
  * <p>
471
- * A unique identifier for the request to create a label group. If you do not set the client request token, Lookout for Equipment generates one.
472
- * </p>
519
+ * A unique identifier for the request to create a label group. If you do not set the client request token, Lookout for Equipment generates one.
520
+ * </p>
473
521
  */
474
522
  ClientToken?: string;
475
523
  /**
524
+ * @public
476
525
  * <p>
477
- * Tags that provide metadata about the label group you are creating.
478
- * </p>
526
+ * Tags that provide metadata about the label group you are creating.
527
+ * </p>
479
528
  * <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.</p>
480
529
  */
481
530
  Tags?: Tag[];
@@ -485,15 +534,17 @@ export interface CreateLabelGroupRequest {
485
534
  */
486
535
  export interface CreateLabelGroupResponse {
487
536
  /**
537
+ * @public
488
538
  * <p>
489
- * The name of the label group that you have created. Data in this field will be retained for service usage. Follow best practices for the security of your data.
490
- * </p>
539
+ * The name of the label group that you have created. Data in this field will be retained for service usage. Follow best practices for the security of your data.
540
+ * </p>
491
541
  */
492
542
  LabelGroupName?: string;
493
543
  /**
544
+ * @public
494
545
  * <p>
495
- * The ARN of the label group that you have created.
496
- * </p>
546
+ * The Amazon Resource Name (ARN) of the label group that you have created.
547
+ * </p>
497
548
  */
498
549
  LabelGroupArn?: string;
499
550
  }
@@ -533,6 +584,7 @@ export type TargetSamplingRate = (typeof TargetSamplingRate)[keyof typeof Target
533
584
  */
534
585
  export interface DataPreProcessingConfiguration {
535
586
  /**
587
+ * @public
536
588
  * <p>The sampling rate of the data after post processing by Amazon Lookout for Equipment. For
537
589
  * example, if you provide data that has been collected at a 1 second level and you want the
538
590
  * system to resample the data at a 1 minute rate before training, the
@@ -552,10 +604,12 @@ export interface DataPreProcessingConfiguration {
552
604
  */
553
605
  export interface LabelsS3InputConfiguration {
554
606
  /**
607
+ * @public
555
608
  * <p>The name of the S3 bucket holding the label data. </p>
556
609
  */
557
610
  Bucket: string | undefined;
558
611
  /**
612
+ * @public
559
613
  * <p> The prefix for the S3 bucket used for the label data. </p>
560
614
  */
561
615
  Prefix?: string;
@@ -567,13 +621,15 @@ export interface LabelsS3InputConfiguration {
567
621
  */
568
622
  export interface LabelsInputConfiguration {
569
623
  /**
624
+ * @public
570
625
  * <p>Contains location information for the S3 location being used for label data. </p>
571
626
  */
572
627
  S3InputConfiguration?: LabelsS3InputConfiguration;
573
628
  /**
629
+ * @public
574
630
  * <p>
575
- * The name of the label group to be used for label data.
576
- * </p>
631
+ * The name of the label group to be used for label data.
632
+ * </p>
577
633
  */
578
634
  LabelGroupName?: string;
579
635
  }
@@ -582,53 +638,64 @@ export interface LabelsInputConfiguration {
582
638
  */
583
639
  export interface CreateModelRequest {
584
640
  /**
641
+ * @public
585
642
  * <p>The name for the ML model to be created.</p>
586
643
  */
587
644
  ModelName: string | undefined;
588
645
  /**
646
+ * @public
589
647
  * <p>The name of the dataset for the ML model being created. </p>
590
648
  */
591
649
  DatasetName: string | undefined;
592
650
  /**
651
+ * @public
593
652
  * <p>The data schema for the ML model being created. </p>
594
653
  */
595
654
  DatasetSchema?: DatasetSchema;
596
655
  /**
656
+ * @public
597
657
  * <p>The input configuration for the labels being used for the ML model that's being created.
598
658
  * </p>
599
659
  */
600
660
  LabelsInputConfiguration?: LabelsInputConfiguration;
601
661
  /**
662
+ * @public
602
663
  * <p>A unique identifier for the request. If you do not set the client request token, Amazon
603
664
  * Lookout for Equipment generates one. </p>
604
665
  */
605
666
  ClientToken?: string;
606
667
  /**
668
+ * @public
607
669
  * <p>Indicates the time reference in the dataset that should be used to begin the subset of
608
670
  * training data for the ML model. </p>
609
671
  */
610
672
  TrainingDataStartTime?: Date;
611
673
  /**
674
+ * @public
612
675
  * <p>Indicates the time reference in the dataset that should be used to end the subset of
613
676
  * training data for the ML model. </p>
614
677
  */
615
678
  TrainingDataEndTime?: Date;
616
679
  /**
680
+ * @public
617
681
  * <p>Indicates the time reference in the dataset that should be used to begin the subset of
618
682
  * evaluation data for the ML model. </p>
619
683
  */
620
684
  EvaluationDataStartTime?: Date;
621
685
  /**
686
+ * @public
622
687
  * <p> Indicates the time reference in the dataset that should be used to end the subset of
623
688
  * evaluation data for the ML model. </p>
624
689
  */
625
690
  EvaluationDataEndTime?: Date;
626
691
  /**
692
+ * @public
627
693
  * <p> The Amazon Resource Name (ARN) of a role with permission to access the data source
628
694
  * being used to create the ML model. </p>
629
695
  */
630
696
  RoleArn?: string;
631
697
  /**
698
+ * @public
632
699
  * <p>The configuration is the <code>TargetSamplingRate</code>, which is the sampling rate of
633
700
  * the data after post processing by Amazon Lookout for Equipment. For example, if you provide
634
701
  * data that has been collected at a 1 second level and you want the system to resample the
@@ -642,15 +709,18 @@ export interface CreateModelRequest {
642
709
  */
643
710
  DataPreProcessingConfiguration?: DataPreProcessingConfiguration;
644
711
  /**
712
+ * @public
645
713
  * <p>Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout
646
714
  * for Equipment. </p>
647
715
  */
648
716
  ServerSideKmsKeyId?: string;
649
717
  /**
718
+ * @public
650
719
  * <p> Any tags associated with the ML model being created. </p>
651
720
  */
652
721
  Tags?: Tag[];
653
722
  /**
723
+ * @public
654
724
  * <p>Indicates that the asset associated with this sensor has been shut off. As long as this
655
725
  * condition is met, Lookout for Equipment will not use data from this asset for training,
656
726
  * evaluation, or inference.</p>
@@ -663,6 +733,7 @@ export interface CreateModelRequest {
663
733
  */
664
734
  export declare const ModelStatus: {
665
735
  readonly FAILED: "FAILED";
736
+ readonly IMPORT_IN_PROGRESS: "IMPORT_IN_PROGRESS";
666
737
  readonly IN_PROGRESS: "IN_PROGRESS";
667
738
  readonly SUCCESS: "SUCCESS";
668
739
  };
@@ -675,10 +746,12 @@ export type ModelStatus = (typeof ModelStatus)[keyof typeof ModelStatus];
675
746
  */
676
747
  export interface CreateModelResponse {
677
748
  /**
749
+ * @public
678
750
  * <p>The Amazon Resource Name (ARN) of the model being created. </p>
679
751
  */
680
752
  ModelArn?: string;
681
753
  /**
754
+ * @public
682
755
  * <p>Indicates the status of the <code>CreateModel</code> operation. </p>
683
756
  */
684
757
  Status?: ModelStatus | string;
@@ -688,6 +761,7 @@ export interface CreateModelResponse {
688
761
  */
689
762
  export interface DeleteDatasetRequest {
690
763
  /**
764
+ * @public
691
765
  * <p>The name of the dataset to be deleted. </p>
692
766
  */
693
767
  DatasetName: string | undefined;
@@ -697,6 +771,7 @@ export interface DeleteDatasetRequest {
697
771
  */
698
772
  export interface DeleteInferenceSchedulerRequest {
699
773
  /**
774
+ * @public
700
775
  * <p>The name of the inference scheduler to be deleted. </p>
701
776
  */
702
777
  InferenceSchedulerName: string | undefined;
@@ -706,15 +781,17 @@ export interface DeleteInferenceSchedulerRequest {
706
781
  */
707
782
  export interface DeleteLabelRequest {
708
783
  /**
784
+ * @public
709
785
  * <p>
710
- * The name of the label group that contains the label that you want to delete. Data in this field will be retained for service usage. Follow best practices for the security of your data.
711
- * </p>
786
+ * The name of the label group that contains the label that you want to delete. Data in this field will be retained for service usage. Follow best practices for the security of your data.
787
+ * </p>
712
788
  */
713
789
  LabelGroupName: string | undefined;
714
790
  /**
791
+ * @public
715
792
  * <p>
716
- * The ID of the label that you want to delete.
717
- * </p>
793
+ * The ID of the label that you want to delete.
794
+ * </p>
718
795
  */
719
796
  LabelId: string | undefined;
720
797
  }
@@ -723,9 +800,10 @@ export interface DeleteLabelRequest {
723
800
  */
724
801
  export interface DeleteLabelGroupRequest {
725
802
  /**
803
+ * @public
726
804
  * <p>
727
- * The name of the label group that you want to delete. Data in this field will be retained for service usage. Follow best practices for the security of your data.
728
- * </p>
805
+ * The name of the label group that you want to delete. Data in this field will be retained for service usage. Follow best practices for the security of your data.
806
+ * </p>
729
807
  */
730
808
  LabelGroupName: string | undefined;
731
809
  }
@@ -734,15 +812,27 @@ export interface DeleteLabelGroupRequest {
734
812
  */
735
813
  export interface DeleteModelRequest {
736
814
  /**
815
+ * @public
737
816
  * <p>The name of the ML model to be deleted. </p>
738
817
  */
739
818
  ModelName: string | undefined;
740
819
  }
820
+ /**
821
+ * @public
822
+ */
823
+ export interface DeleteResourcePolicyRequest {
824
+ /**
825
+ * @public
826
+ * <p>The Amazon Resource Name (ARN) of the resource for which the resource policy should be deleted.</p>
827
+ */
828
+ ResourceArn: string | undefined;
829
+ }
741
830
  /**
742
831
  * @public
743
832
  */
744
833
  export interface DescribeDataIngestionJobRequest {
745
834
  /**
835
+ * @public
746
836
  * <p>The job ID of the data ingestion job. </p>
747
837
  */
748
838
  JobId: string | undefined;
@@ -753,6 +843,7 @@ export interface DescribeDataIngestionJobRequest {
753
843
  */
754
844
  export interface DuplicateTimestamps {
755
845
  /**
846
+ * @public
756
847
  * <p> Indicates the total number of duplicate timestamps. </p>
757
848
  */
758
849
  TotalNumberOfDuplicateTimestamps: number | undefined;
@@ -764,6 +855,7 @@ export interface DuplicateTimestamps {
764
855
  */
765
856
  export interface MissingCompleteSensorData {
766
857
  /**
858
+ * @public
767
859
  * <p> Indicates the number of sensors that have data missing completely. </p>
768
860
  */
769
861
  AffectedSensorCount: number | undefined;
@@ -774,6 +866,7 @@ export interface MissingCompleteSensorData {
774
866
  */
775
867
  export interface SensorsWithShortDateRange {
776
868
  /**
869
+ * @public
777
870
  * <p> Indicates the number of sensors that have less than 90 days of data. </p>
778
871
  */
779
872
  AffectedSensorCount: number | undefined;
@@ -785,11 +878,13 @@ export interface SensorsWithShortDateRange {
785
878
  */
786
879
  export interface InsufficientSensorData {
787
880
  /**
881
+ * @public
788
882
  * <p> Parameter that describes the total number of sensors that have data completely missing
789
883
  * for it. </p>
790
884
  */
791
885
  MissingCompleteSensorData: MissingCompleteSensorData | undefined;
792
886
  /**
887
+ * @public
793
888
  * <p> Parameter that describes the total number of sensors that have a short date range of
794
889
  * less than 90 days of data overall. </p>
795
890
  */
@@ -802,10 +897,12 @@ export interface InsufficientSensorData {
802
897
  */
803
898
  export interface InvalidSensorData {
804
899
  /**
900
+ * @public
805
901
  * <p> Indicates the number of sensors that have at least some invalid values. </p>
806
902
  */
807
903
  AffectedSensorCount: number | undefined;
808
904
  /**
905
+ * @public
809
906
  * <p> Indicates the total number of invalid values across all the sensors. </p>
810
907
  */
811
908
  TotalNumberOfInvalidValues: number | undefined;
@@ -816,10 +913,12 @@ export interface InvalidSensorData {
816
913
  */
817
914
  export interface MissingSensorData {
818
915
  /**
916
+ * @public
819
917
  * <p> Indicates the number of sensors that have atleast some data missing. </p>
820
918
  */
821
919
  AffectedSensorCount: number | undefined;
822
920
  /**
921
+ * @public
823
922
  * <p> Indicates the total number of missing values across all the sensors. </p>
824
923
  */
825
924
  TotalNumberOfMissingValues: number | undefined;
@@ -830,6 +929,7 @@ export interface MissingSensorData {
830
929
  */
831
930
  export interface UnsupportedTimestamps {
832
931
  /**
932
+ * @public
833
933
  * <p> Indicates the total number of unsupported timestamps across the ingested data. </p>
834
934
  */
835
935
  TotalNumberOfUnsupportedTimestamps: number | undefined;
@@ -843,27 +943,32 @@ export interface UnsupportedTimestamps {
843
943
  */
844
944
  export interface DataQualitySummary {
845
945
  /**
946
+ * @public
846
947
  * <p> Parameter that gives information about insufficient data for sensors in the dataset.
847
948
  * This includes information about those sensors that have complete data missing and those
848
949
  * with a short date range. </p>
849
950
  */
850
951
  InsufficientSensorData: InsufficientSensorData | undefined;
851
952
  /**
953
+ * @public
852
954
  * <p> Parameter that gives information about data that is missing over all the sensors in the
853
955
  * input data. </p>
854
956
  */
855
957
  MissingSensorData: MissingSensorData | undefined;
856
958
  /**
959
+ * @public
857
960
  * <p> Parameter that gives information about data that is invalid over all the sensors in the
858
961
  * input data. </p>
859
962
  */
860
963
  InvalidSensorData: InvalidSensorData | undefined;
861
964
  /**
965
+ * @public
862
966
  * <p> Parameter that gives information about unsupported timestamps in the input data.
863
967
  * </p>
864
968
  */
865
969
  UnsupportedTimestamps: UnsupportedTimestamps | undefined;
866
970
  /**
971
+ * @public
867
972
  * <p> Parameter that gives information about duplicate timestamps in the input data. </p>
868
973
  */
869
974
  DuplicateTimestamps: DuplicateTimestamps | undefined;
@@ -874,11 +979,13 @@ export interface DataQualitySummary {
874
979
  */
875
980
  export interface S3Object {
876
981
  /**
982
+ * @public
877
983
  * <p>The name of the specific S3 bucket. </p>
878
984
  */
879
985
  Bucket: string | undefined;
880
986
  /**
881
- * <p>The AWS Key Management Service (AWS KMS) key being used to encrypt the S3 object.
987
+ * @public
988
+ * <p>The Amazon Web Services Key Management Service (KMS key) key being used to encrypt the S3 object.
882
989
  * Without this key, data in the bucket is not accessible. </p>
883
990
  */
884
991
  Key: string | undefined;
@@ -890,14 +997,17 @@ export interface S3Object {
890
997
  */
891
998
  export interface IngestedFilesSummary {
892
999
  /**
1000
+ * @public
893
1001
  * <p>Indicates the total number of files that were submitted for ingestion.</p>
894
1002
  */
895
1003
  TotalNumberOfFiles: number | undefined;
896
1004
  /**
1005
+ * @public
897
1006
  * <p>Indicates the number of files that were successfully ingested.</p>
898
1007
  */
899
1008
  IngestedNumberOfFiles: number | undefined;
900
1009
  /**
1010
+ * @public
901
1011
  * <p>Indicates the number of files that were discarded. A file could be discarded because its
902
1012
  * format is invalid (for example, a jpg or pdf) or not readable.</p>
903
1013
  */
@@ -910,18 +1020,21 @@ export interface IngestedFilesSummary {
910
1020
  */
911
1021
  export interface IngestionS3InputConfiguration {
912
1022
  /**
1023
+ * @public
913
1024
  * <p>The name of the S3 bucket used for the input data for the data ingestion. </p>
914
1025
  */
915
1026
  Bucket: string | undefined;
916
1027
  /**
1028
+ * @public
917
1029
  * <p>The prefix for the S3 location being used for the input data for the data ingestion.
918
1030
  * </p>
919
1031
  */
920
1032
  Prefix?: string;
921
1033
  /**
922
- * <p> Pattern for matching the Amazon S3 files which will be used for ingestion. If
923
- * no KeyPattern is provided, we will use the default hierarchy file structure, which is same
924
- * as KeyPattern \{prefix\}/\{component_name\}/* </p>
1034
+ * @public
1035
+ * <p>
1036
+ * The pattern for matching the Amazon S3 files that will be used for ingestion. If the schema was created previously without any KeyPattern, then the default KeyPattern \{prefix\}/\{component_name\}/* is used to download files from Amazon S3 according to the schema. This field is required when ingestion is being done for the first time.</p>
1037
+ * <p>Valid Values: \{prefix\}/\{component_name\}_* | \{prefix\}/\{component_name\}/* | \{prefix\}/\{component_name\}[DELIMITER]* (Allowed delimiters : space, dot, underscore, hyphen)</p>
925
1038
  */
926
1039
  KeyPattern?: string;
927
1040
  }
@@ -932,6 +1045,7 @@ export interface IngestionS3InputConfiguration {
932
1045
  */
933
1046
  export interface IngestionInputConfiguration {
934
1047
  /**
1048
+ * @public
935
1049
  * <p>The location information for the S3 bucket used for input data for the data ingestion.
936
1050
  * </p>
937
1051
  */
@@ -943,6 +1057,7 @@ export interface IngestionInputConfiguration {
943
1057
  */
944
1058
  export declare const IngestionJobStatus: {
945
1059
  readonly FAILED: "FAILED";
1060
+ readonly IMPORT_IN_PROGRESS: "IMPORT_IN_PROGRESS";
946
1061
  readonly IN_PROGRESS: "IN_PROGRESS";
947
1062
  readonly SUCCESS: "SUCCESS";
948
1063
  };
@@ -955,72 +1070,92 @@ export type IngestionJobStatus = (typeof IngestionJobStatus)[keyof typeof Ingest
955
1070
  */
956
1071
  export interface DescribeDataIngestionJobResponse {
957
1072
  /**
1073
+ * @public
958
1074
  * <p>Indicates the job ID of the data ingestion job. </p>
959
1075
  */
960
1076
  JobId?: string;
961
1077
  /**
1078
+ * @public
962
1079
  * <p>The Amazon Resource Name (ARN) of the dataset being used in the data ingestion job.
963
1080
  * </p>
964
1081
  */
965
1082
  DatasetArn?: string;
966
1083
  /**
1084
+ * @public
967
1085
  * <p>Specifies the S3 location configuration for the data input for the data ingestion job.
968
1086
  * </p>
969
1087
  */
970
1088
  IngestionInputConfiguration?: IngestionInputConfiguration;
971
1089
  /**
1090
+ * @public
972
1091
  * <p>The Amazon Resource Name (ARN) of an IAM role with permission to access the data source
973
1092
  * being ingested. </p>
974
1093
  */
975
1094
  RoleArn?: string;
976
1095
  /**
1096
+ * @public
977
1097
  * <p>The time at which the data ingestion job was created. </p>
978
1098
  */
979
1099
  CreatedAt?: Date;
980
1100
  /**
1101
+ * @public
981
1102
  * <p>Indicates the status of the <code>DataIngestionJob</code> operation. </p>
982
1103
  */
983
1104
  Status?: IngestionJobStatus | string;
984
1105
  /**
1106
+ * @public
985
1107
  * <p>Specifies the reason for failure when a data ingestion job has failed. </p>
986
1108
  */
987
1109
  FailedReason?: string;
988
1110
  /**
1111
+ * @public
989
1112
  * <p> Gives statistics about a completed ingestion job. These statistics primarily relate to
990
1113
  * quantifying incorrect data such as MissingCompleteSensorData, MissingSensorData,
991
1114
  * UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps. </p>
992
1115
  */
993
1116
  DataQualitySummary?: DataQualitySummary;
994
1117
  /**
1118
+ * @public
995
1119
  * <p>Gives statistics about how many files have been ingested, and which files have not been
996
1120
  * ingested, for a particular ingestion job.</p>
997
1121
  */
998
1122
  IngestedFilesSummary?: IngestedFilesSummary;
999
1123
  /**
1124
+ * @public
1000
1125
  * <p> Provides details about status of the ingestion job that is currently in progress.
1001
1126
  * </p>
1002
1127
  */
1003
1128
  StatusDetail?: string;
1004
1129
  /**
1130
+ * @public
1005
1131
  * <p> Indicates the size of the ingested dataset. </p>
1006
1132
  */
1007
1133
  IngestedDataSize?: number;
1008
1134
  /**
1135
+ * @public
1009
1136
  * <p> Indicates the earliest timestamp corresponding to data that was successfully ingested
1010
1137
  * during this specific ingestion job. </p>
1011
1138
  */
1012
1139
  DataStartTime?: Date;
1013
1140
  /**
1141
+ * @public
1014
1142
  * <p> Indicates the latest timestamp corresponding to data that was successfully ingested
1015
1143
  * during this specific ingestion job. </p>
1016
1144
  */
1017
1145
  DataEndTime?: Date;
1146
+ /**
1147
+ * @public
1148
+ * <p>The Amazon Resource Name (ARN) of the source dataset from which the data
1149
+ * used for the data ingestion job was imported from.</p>
1150
+ */
1151
+ SourceDatasetArn?: string;
1018
1152
  }
1019
1153
  /**
1020
1154
  * @public
1021
1155
  */
1022
1156
  export interface DescribeDatasetRequest {
1023
1157
  /**
1158
+ * @public
1024
1159
  * <p>The name of the dataset to be described. </p>
1025
1160
  */
1026
1161
  DatasetName: string | undefined;
@@ -1030,41 +1165,50 @@ export interface DescribeDatasetRequest {
1030
1165
  */
1031
1166
  export interface DescribeDatasetResponse {
1032
1167
  /**
1168
+ * @public
1033
1169
  * <p>The name of the dataset being described. </p>
1034
1170
  */
1035
1171
  DatasetName?: string;
1036
1172
  /**
1173
+ * @public
1037
1174
  * <p>The Amazon Resource Name (ARN) of the dataset being described. </p>
1038
1175
  */
1039
1176
  DatasetArn?: string;
1040
1177
  /**
1178
+ * @public
1041
1179
  * <p>Specifies the time the dataset was created in Lookout for Equipment. </p>
1042
1180
  */
1043
1181
  CreatedAt?: Date;
1044
1182
  /**
1183
+ * @public
1045
1184
  * <p>Specifies the time the dataset was last updated, if it was. </p>
1046
1185
  */
1047
1186
  LastUpdatedAt?: Date;
1048
1187
  /**
1188
+ * @public
1049
1189
  * <p>Indicates the status of the dataset. </p>
1050
1190
  */
1051
1191
  Status?: DatasetStatus | string;
1052
1192
  /**
1193
+ * @public
1053
1194
  * <p>A JSON description of the data that is in each time series dataset, including names,
1054
1195
  * column names, and data types. </p>
1055
1196
  */
1056
1197
  Schema?: __LazyJsonString | string;
1057
1198
  /**
1199
+ * @public
1058
1200
  * <p>Provides the identifier of the KMS key used to encrypt dataset data by Amazon Lookout
1059
1201
  * for Equipment. </p>
1060
1202
  */
1061
1203
  ServerSideKmsKeyId?: string;
1062
1204
  /**
1205
+ * @public
1063
1206
  * <p>Specifies the S3 location configuration for the data input for the data ingestion job.
1064
1207
  * </p>
1065
1208
  */
1066
1209
  IngestionInputConfiguration?: IngestionInputConfiguration;
1067
1210
  /**
1211
+ * @public
1068
1212
  * <p> Gives statistics associated with the given dataset for the latest successful associated
1069
1213
  * ingestion job id. These statistics primarily relate to quantifying incorrect data such as
1070
1214
  * MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats,
@@ -1072,31 +1216,42 @@ export interface DescribeDatasetResponse {
1072
1216
  */
1073
1217
  DataQualitySummary?: DataQualitySummary;
1074
1218
  /**
1219
+ * @public
1075
1220
  * <p> IngestedFilesSummary associated with the given dataset for the latest successful
1076
1221
  * associated ingestion job id. </p>
1077
1222
  */
1078
1223
  IngestedFilesSummary?: IngestedFilesSummary;
1079
1224
  /**
1225
+ * @public
1080
1226
  * <p> The Amazon Resource Name (ARN) of the IAM role that you are using for this the data
1081
1227
  * ingestion job. </p>
1082
1228
  */
1083
1229
  RoleArn?: string;
1084
1230
  /**
1231
+ * @public
1085
1232
  * <p> Indicates the earliest timestamp corresponding to data that was successfully ingested
1086
1233
  * during the most recent ingestion of this particular dataset. </p>
1087
1234
  */
1088
1235
  DataStartTime?: Date;
1089
1236
  /**
1237
+ * @public
1090
1238
  * <p> Indicates the latest timestamp corresponding to data that was successfully ingested
1091
1239
  * during the most recent ingestion of this particular dataset. </p>
1092
1240
  */
1093
1241
  DataEndTime?: Date;
1242
+ /**
1243
+ * @public
1244
+ * <p>The Amazon Resource Name (ARN) of the source dataset from which the
1245
+ * current data being described was imported from.</p>
1246
+ */
1247
+ SourceDatasetArn?: string;
1094
1248
  }
1095
1249
  /**
1096
1250
  * @public
1097
1251
  */
1098
1252
  export interface DescribeInferenceSchedulerRequest {
1099
1253
  /**
1254
+ * @public
1100
1255
  * <p>The name of the inference scheduler being described. </p>
1101
1256
  */
1102
1257
  InferenceSchedulerName: string | undefined;
@@ -1118,27 +1273,33 @@ export type LatestInferenceResult = (typeof LatestInferenceResult)[keyof typeof
1118
1273
  */
1119
1274
  export interface DescribeInferenceSchedulerResponse {
1120
1275
  /**
1276
+ * @public
1121
1277
  * <p>The Amazon Resource Name (ARN) of the ML model of the inference scheduler being
1122
1278
  * described. </p>
1123
1279
  */
1124
1280
  ModelArn?: string;
1125
1281
  /**
1282
+ * @public
1126
1283
  * <p>The name of the ML model of the inference scheduler being described. </p>
1127
1284
  */
1128
1285
  ModelName?: string;
1129
1286
  /**
1287
+ * @public
1130
1288
  * <p>The name of the inference scheduler being described. </p>
1131
1289
  */
1132
1290
  InferenceSchedulerName?: string;
1133
1291
  /**
1292
+ * @public
1134
1293
  * <p>The Amazon Resource Name (ARN) of the inference scheduler being described. </p>
1135
1294
  */
1136
1295
  InferenceSchedulerArn?: string;
1137
1296
  /**
1297
+ * @public
1138
1298
  * <p>Indicates the status of the inference scheduler. </p>
1139
1299
  */
1140
1300
  Status?: InferenceSchedulerStatus | string;
1141
1301
  /**
1302
+ * @public
1142
1303
  * <p> A period of time (in minutes) by which inference on the data is delayed after the data
1143
1304
  * starts. For instance, if you select an offset delay time of five minutes, inference will
1144
1305
  * not begin on the data until the first data measurement after the five minute mark. For
@@ -1149,6 +1310,7 @@ export interface DescribeInferenceSchedulerResponse {
1149
1310
  */
1150
1311
  DataDelayOffsetInMinutes?: number;
1151
1312
  /**
1313
+ * @public
1152
1314
  * <p>Specifies how often data is uploaded to the source S3 bucket for the input data. This
1153
1315
  * value is the length of time between data uploads. For instance, if you select 5 minutes,
1154
1316
  * Amazon Lookout for Equipment will upload the real-time data to the source bucket once every
@@ -1157,34 +1319,41 @@ export interface DescribeInferenceSchedulerResponse {
1157
1319
  */
1158
1320
  DataUploadFrequency?: DataUploadFrequency | string;
1159
1321
  /**
1322
+ * @public
1160
1323
  * <p>Specifies the time at which the inference scheduler was created. </p>
1161
1324
  */
1162
1325
  CreatedAt?: Date;
1163
1326
  /**
1327
+ * @public
1164
1328
  * <p>Specifies the time at which the inference scheduler was last updated, if it was. </p>
1165
1329
  */
1166
1330
  UpdatedAt?: Date;
1167
1331
  /**
1332
+ * @public
1168
1333
  * <p> Specifies configuration information for the input data for the inference scheduler,
1169
1334
  * including delimiter, format, and dataset location. </p>
1170
1335
  */
1171
1336
  DataInputConfiguration?: InferenceInputConfiguration;
1172
1337
  /**
1338
+ * @public
1173
1339
  * <p> Specifies information for the output results for the inference scheduler, including
1174
1340
  * the output S3 location. </p>
1175
1341
  */
1176
1342
  DataOutputConfiguration?: InferenceOutputConfiguration;
1177
1343
  /**
1344
+ * @public
1178
1345
  * <p> The Amazon Resource Name (ARN) of a role with permission to access the data source for
1179
1346
  * the inference scheduler being described. </p>
1180
1347
  */
1181
1348
  RoleArn?: string;
1182
1349
  /**
1350
+ * @public
1183
1351
  * <p>Provides the identifier of the KMS key used to encrypt inference scheduler data by
1184
1352
  * Amazon Lookout for Equipment. </p>
1185
1353
  */
1186
1354
  ServerSideKmsKeyId?: string;
1187
1355
  /**
1356
+ * @public
1188
1357
  * <p>Indicates whether the latest execution for the inference scheduler was Anomalous
1189
1358
  * (anomalous events found) or Normal (no anomalous events found).</p>
1190
1359
  */
@@ -1195,15 +1364,17 @@ export interface DescribeInferenceSchedulerResponse {
1195
1364
  */
1196
1365
  export interface DescribeLabelRequest {
1197
1366
  /**
1367
+ * @public
1198
1368
  * <p>
1199
- * Returns the name of the group containing the label.
1200
- * </p>
1369
+ * Returns the name of the group containing the label.
1370
+ * </p>
1201
1371
  */
1202
1372
  LabelGroupName: string | undefined;
1203
1373
  /**
1374
+ * @public
1204
1375
  * <p>
1205
- * Returns the ID of the label.
1206
- * </p>
1376
+ * Returns the ID of the label.
1377
+ * </p>
1207
1378
  */
1208
1379
  LabelId: string | undefined;
1209
1380
  }
@@ -1212,63 +1383,73 @@ export interface DescribeLabelRequest {
1212
1383
  */
1213
1384
  export interface DescribeLabelResponse {
1214
1385
  /**
1386
+ * @public
1215
1387
  * <p>
1216
- * The name of the requested label group.
1217
- * </p>
1388
+ * The name of the requested label group.
1389
+ * </p>
1218
1390
  */
1219
1391
  LabelGroupName?: string;
1220
1392
  /**
1393
+ * @public
1221
1394
  * <p>
1222
- * The ARN of the requested label group.
1223
- * </p>
1395
+ * The Amazon Resource Name (ARN) of the requested label group.
1396
+ * </p>
1224
1397
  */
1225
1398
  LabelGroupArn?: string;
1226
1399
  /**
1400
+ * @public
1227
1401
  * <p>
1228
- * The ID of the requested label.
1229
- * </p>
1402
+ * The ID of the requested label.
1403
+ * </p>
1230
1404
  */
1231
1405
  LabelId?: string;
1232
1406
  /**
1407
+ * @public
1233
1408
  * <p>
1234
- * The start time of the requested label.
1235
- * </p>
1409
+ * The start time of the requested label.
1410
+ * </p>
1236
1411
  */
1237
1412
  StartTime?: Date;
1238
1413
  /**
1414
+ * @public
1239
1415
  * <p>
1240
- * The end time of the requested label.
1241
- * </p>
1416
+ * The end time of the requested label.
1417
+ * </p>
1242
1418
  */
1243
1419
  EndTime?: Date;
1244
1420
  /**
1421
+ * @public
1245
1422
  * <p>
1246
- * Indicates whether a labeled event represents an anomaly.
1247
- * </p>
1423
+ * Indicates whether a labeled event represents an anomaly.
1424
+ * </p>
1248
1425
  */
1249
1426
  Rating?: LabelRating | string;
1250
1427
  /**
1428
+ * @public
1251
1429
  * <p>
1252
- * Indicates the type of anomaly associated with the label.
1253
- * </p>
1430
+ * Indicates the type of anomaly associated with the label.
1431
+ * </p>
1254
1432
  * <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.</p>
1255
1433
  */
1256
1434
  FaultCode?: string;
1257
1435
  /**
1436
+ * @public
1258
1437
  * <p>Metadata providing additional information about the label.</p>
1259
1438
  * <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.</p>
1260
1439
  */
1261
1440
  Notes?: string;
1262
1441
  /**
1442
+ * @public
1263
1443
  * <p>
1264
- * Indicates that a label pertains to a particular piece of equipment.
1265
- * </p>
1444
+ * Indicates that a label pertains to a particular piece of equipment.
1445
+ * </p>
1266
1446
  */
1267
1447
  Equipment?: string;
1268
1448
  /**
1449
+ * @public
1269
1450
  * <p>
1270
- * The time at which the label was created.
1271
- * </p>
1451
+ * The time at which the label was created.
1452
+ * </p>
1272
1453
  */
1273
1454
  CreatedAt?: Date;
1274
1455
  }
@@ -1277,9 +1458,10 @@ export interface DescribeLabelResponse {
1277
1458
  */
1278
1459
  export interface DescribeLabelGroupRequest {
1279
1460
  /**
1461
+ * @public
1280
1462
  * <p>
1281
- * Returns the name of the label group.
1282
- * </p>
1463
+ * Returns the name of the label group.
1464
+ * </p>
1283
1465
  */
1284
1466
  LabelGroupName: string | undefined;
1285
1467
  }
@@ -1288,33 +1470,38 @@ export interface DescribeLabelGroupRequest {
1288
1470
  */
1289
1471
  export interface DescribeLabelGroupResponse {
1290
1472
  /**
1473
+ * @public
1291
1474
  * <p>
1292
- * The name of the label group.
1293
- * </p>
1475
+ * The name of the label group.
1476
+ * </p>
1294
1477
  */
1295
1478
  LabelGroupName?: string;
1296
1479
  /**
1480
+ * @public
1297
1481
  * <p>
1298
- * The ARN of the label group.
1299
- * </p>
1482
+ * The Amazon Resource Name (ARN) of the label group.
1483
+ * </p>
1300
1484
  */
1301
1485
  LabelGroupArn?: string;
1302
1486
  /**
1487
+ * @public
1303
1488
  * <p>
1304
- * Codes indicating the type of anomaly associated with the labels in the lagbel group.
1305
- * </p>
1489
+ * Codes indicating the type of anomaly associated with the labels in the lagbel group.
1490
+ * </p>
1306
1491
  */
1307
1492
  FaultCodes?: string[];
1308
1493
  /**
1494
+ * @public
1309
1495
  * <p>
1310
- * The time at which the label group was created.
1311
- * </p>
1496
+ * The time at which the label group was created.
1497
+ * </p>
1312
1498
  */
1313
1499
  CreatedAt?: Date;
1314
1500
  /**
1501
+ * @public
1315
1502
  * <p>
1316
- * The time at which the label group was updated.
1317
- * </p>
1503
+ * The time at which the label group was updated.
1504
+ * </p>
1318
1505
  */
1319
1506
  UpdatedAt?: Date;
1320
1507
  }
@@ -1323,6 +1510,7 @@ export interface DescribeLabelGroupResponse {
1323
1510
  */
1324
1511
  export interface DescribeModelRequest {
1325
1512
  /**
1513
+ * @public
1326
1514
  * <p>The name of the ML model to be described. </p>
1327
1515
  */
1328
1516
  ModelName: string | undefined;
@@ -1332,58 +1520,70 @@ export interface DescribeModelRequest {
1332
1520
  */
1333
1521
  export interface DescribeModelResponse {
1334
1522
  /**
1523
+ * @public
1335
1524
  * <p>The name of the ML model being described. </p>
1336
1525
  */
1337
1526
  ModelName?: string;
1338
1527
  /**
1528
+ * @public
1339
1529
  * <p>The Amazon Resource Name (ARN) of the ML model being described. </p>
1340
1530
  */
1341
1531
  ModelArn?: string;
1342
1532
  /**
1533
+ * @public
1343
1534
  * <p>The name of the dataset being used by the ML being described. </p>
1344
1535
  */
1345
1536
  DatasetName?: string;
1346
1537
  /**
1538
+ * @public
1347
1539
  * <p>The Amazon Resouce Name (ARN) of the dataset used to create the ML model being
1348
1540
  * described. </p>
1349
1541
  */
1350
1542
  DatasetArn?: string;
1351
1543
  /**
1544
+ * @public
1352
1545
  * <p>A JSON description of the data that is in each time series dataset, including names,
1353
1546
  * column names, and data types. </p>
1354
1547
  */
1355
1548
  Schema?: __LazyJsonString | string;
1356
1549
  /**
1550
+ * @public
1357
1551
  * <p>Specifies configuration information about the labels input, including its S3 location.
1358
1552
  * </p>
1359
1553
  */
1360
1554
  LabelsInputConfiguration?: LabelsInputConfiguration;
1361
1555
  /**
1556
+ * @public
1362
1557
  * <p> Indicates the time reference in the dataset that was used to begin the subset of
1363
1558
  * training data for the ML model. </p>
1364
1559
  */
1365
1560
  TrainingDataStartTime?: Date;
1366
1561
  /**
1562
+ * @public
1367
1563
  * <p> Indicates the time reference in the dataset that was used to end the subset of training
1368
1564
  * data for the ML model. </p>
1369
1565
  */
1370
1566
  TrainingDataEndTime?: Date;
1371
1567
  /**
1568
+ * @public
1372
1569
  * <p> Indicates the time reference in the dataset that was used to begin the subset of
1373
1570
  * evaluation data for the ML model. </p>
1374
1571
  */
1375
1572
  EvaluationDataStartTime?: Date;
1376
1573
  /**
1574
+ * @public
1377
1575
  * <p> Indicates the time reference in the dataset that was used to end the subset of
1378
1576
  * evaluation data for the ML model. </p>
1379
1577
  */
1380
1578
  EvaluationDataEndTime?: Date;
1381
1579
  /**
1580
+ * @public
1382
1581
  * <p> The Amazon Resource Name (ARN) of a role with permission to access the data source for
1383
1582
  * the ML model being described. </p>
1384
1583
  */
1385
1584
  RoleArn?: string;
1386
1585
  /**
1586
+ * @public
1387
1587
  * <p>The configuration is the <code>TargetSamplingRate</code>, which is the sampling rate of
1388
1588
  * the data after post processing by Amazon Lookout for Equipment. For example, if you provide
1389
1589
  * data that has been collected at a 1 second level and you want the system to resample the
@@ -1397,68 +1597,522 @@ export interface DescribeModelResponse {
1397
1597
  */
1398
1598
  DataPreProcessingConfiguration?: DataPreProcessingConfiguration;
1399
1599
  /**
1600
+ * @public
1400
1601
  * <p>Specifies the current status of the model being described. Status describes the status
1401
1602
  * of the most recent action of the model. </p>
1402
1603
  */
1403
1604
  Status?: ModelStatus | string;
1404
1605
  /**
1606
+ * @public
1405
1607
  * <p>Indicates the time at which the training of the ML model began. </p>
1406
1608
  */
1407
1609
  TrainingExecutionStartTime?: Date;
1408
1610
  /**
1611
+ * @public
1409
1612
  * <p>Indicates the time at which the training of the ML model was completed. </p>
1410
1613
  */
1411
1614
  TrainingExecutionEndTime?: Date;
1412
1615
  /**
1616
+ * @public
1413
1617
  * <p>If the training of the ML model failed, this indicates the reason for that failure.
1414
1618
  * </p>
1415
1619
  */
1416
1620
  FailedReason?: string;
1417
1621
  /**
1622
+ * @public
1418
1623
  * <p>The Model Metrics show an aggregated summary of the model's performance within the
1419
1624
  * evaluation time range. This is the JSON content of the metrics created when evaluating the
1420
1625
  * model. </p>
1421
1626
  */
1422
1627
  ModelMetrics?: __LazyJsonString | string;
1423
1628
  /**
1629
+ * @public
1424
1630
  * <p>Indicates the last time the ML model was updated. The type of update is not specified.
1425
1631
  * </p>
1426
1632
  */
1427
1633
  LastUpdatedTime?: Date;
1428
1634
  /**
1635
+ * @public
1429
1636
  * <p>Indicates the time and date at which the ML model was created. </p>
1430
1637
  */
1431
1638
  CreatedAt?: Date;
1432
1639
  /**
1640
+ * @public
1433
1641
  * <p>Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout
1434
1642
  * for Equipment. </p>
1435
1643
  */
1436
1644
  ServerSideKmsKeyId?: string;
1437
1645
  /**
1646
+ * @public
1438
1647
  * <p>Indicates that the asset associated with this sensor has been shut off. As long as this
1439
1648
  * condition is met, Lookout for Equipment will not use data from this asset for training,
1440
1649
  * evaluation, or inference.</p>
1441
1650
  */
1442
1651
  OffCondition?: string;
1652
+ /**
1653
+ * @public
1654
+ * <p>The Amazon Resource Name (ARN) of the source model version. This field appears if the active model version
1655
+ * was imported.</p>
1656
+ */
1657
+ SourceModelVersionArn?: string;
1658
+ /**
1659
+ * @public
1660
+ * <p>The date and time when the import job was started.
1661
+ * This field appears if the active model version was imported.</p>
1662
+ */
1663
+ ImportJobStartTime?: Date;
1664
+ /**
1665
+ * @public
1666
+ * <p>The date and time when the import job was completed.
1667
+ * This field appears if the active model version was imported.</p>
1668
+ */
1669
+ ImportJobEndTime?: Date;
1670
+ /**
1671
+ * @public
1672
+ * <p>The name of the model version used by the inference schedular when running a
1673
+ * scheduled inference execution.</p>
1674
+ */
1675
+ ActiveModelVersion?: number;
1676
+ /**
1677
+ * @public
1678
+ * <p>The Amazon Resource Name (ARN) of the model version used by the
1679
+ * inference scheduler when running a scheduled inference execution.</p>
1680
+ */
1681
+ ActiveModelVersionArn?: string;
1682
+ /**
1683
+ * @public
1684
+ * <p>The date the active model version was activated.</p>
1685
+ */
1686
+ ModelVersionActivatedAt?: Date;
1687
+ /**
1688
+ * @public
1689
+ * <p>The model version that was set as the active model version prior to the
1690
+ * current active model version.</p>
1691
+ */
1692
+ PreviousActiveModelVersion?: number;
1693
+ /**
1694
+ * @public
1695
+ * <p>The ARN of the model version that was set as the active model version prior to the
1696
+ * current active model version.</p>
1697
+ */
1698
+ PreviousActiveModelVersionArn?: string;
1699
+ /**
1700
+ * @public
1701
+ * <p>The date and time when the previous active model version was activated.</p>
1702
+ */
1703
+ PreviousModelVersionActivatedAt?: Date;
1704
+ }
1705
+ /**
1706
+ * @public
1707
+ */
1708
+ export interface DescribeModelVersionRequest {
1709
+ /**
1710
+ * @public
1711
+ * <p>The name of the machine learning model that this version belongs to.</p>
1712
+ */
1713
+ ModelName: string | undefined;
1714
+ /**
1715
+ * @public
1716
+ * <p>The version of the machine learning model.</p>
1717
+ */
1718
+ ModelVersion: number | undefined;
1719
+ }
1720
+ /**
1721
+ * @public
1722
+ * @enum
1723
+ */
1724
+ export declare const ModelVersionSourceType: {
1725
+ readonly IMPORT: "IMPORT";
1726
+ readonly RETRAINING: "RETRAINING";
1727
+ readonly TRAINING: "TRAINING";
1728
+ };
1729
+ /**
1730
+ * @public
1731
+ */
1732
+ export type ModelVersionSourceType = (typeof ModelVersionSourceType)[keyof typeof ModelVersionSourceType];
1733
+ /**
1734
+ * @public
1735
+ * @enum
1736
+ */
1737
+ export declare const ModelVersionStatus: {
1738
+ readonly CANCELED: "CANCELED";
1739
+ readonly FAILED: "FAILED";
1740
+ readonly IMPORT_IN_PROGRESS: "IMPORT_IN_PROGRESS";
1741
+ readonly IN_PROGRESS: "IN_PROGRESS";
1742
+ readonly SUCCESS: "SUCCESS";
1743
+ };
1744
+ /**
1745
+ * @public
1746
+ */
1747
+ export type ModelVersionStatus = (typeof ModelVersionStatus)[keyof typeof ModelVersionStatus];
1748
+ /**
1749
+ * @public
1750
+ */
1751
+ export interface DescribeModelVersionResponse {
1752
+ /**
1753
+ * @public
1754
+ * <p>The name of the machine learning model that this version belongs to.</p>
1755
+ */
1756
+ ModelName?: string;
1757
+ /**
1758
+ * @public
1759
+ * <p>The Amazon Resource Name (ARN) of the parent machine learning model that this version belong to.</p>
1760
+ */
1761
+ ModelArn?: string;
1762
+ /**
1763
+ * @public
1764
+ * <p>The version of the machine learning model.</p>
1765
+ */
1766
+ ModelVersion?: number;
1767
+ /**
1768
+ * @public
1769
+ * <p>The Amazon Resource Name (ARN) of the model version.</p>
1770
+ */
1771
+ ModelVersionArn?: string;
1772
+ /**
1773
+ * @public
1774
+ * <p>The current status of the model version.</p>
1775
+ */
1776
+ Status?: ModelVersionStatus | string;
1777
+ /**
1778
+ * @public
1779
+ * <p>Indicates whether this model version was created by training or by importing.</p>
1780
+ */
1781
+ SourceType?: ModelVersionSourceType | string;
1782
+ /**
1783
+ * @public
1784
+ * <p>The name of the dataset used to train the model version.</p>
1785
+ */
1786
+ DatasetName?: string;
1787
+ /**
1788
+ * @public
1789
+ * <p>The Amazon Resource Name (ARN) of the dataset used to train the model version.</p>
1790
+ */
1791
+ DatasetArn?: string;
1792
+ /**
1793
+ * @public
1794
+ * <p>The schema of the data used to train the model version.</p>
1795
+ */
1796
+ Schema?: string;
1797
+ /**
1798
+ * @public
1799
+ * <p>Contains the configuration information for the S3 location being used to hold label
1800
+ * data. </p>
1801
+ */
1802
+ LabelsInputConfiguration?: LabelsInputConfiguration;
1803
+ /**
1804
+ * @public
1805
+ * <p>The date on which the training data began being gathered. If you imported
1806
+ * the version, this is the date that the training data in the source
1807
+ * version began being gathered.</p>
1808
+ */
1809
+ TrainingDataStartTime?: Date;
1810
+ /**
1811
+ * @public
1812
+ * <p>The date on which the training data finished being gathered.
1813
+ * If you imported the version, this is the date that the training data in the
1814
+ * source version finished being gathered.</p>
1815
+ */
1816
+ TrainingDataEndTime?: Date;
1817
+ /**
1818
+ * @public
1819
+ * <p>The date on which the data in the evaluation set began being gathered.
1820
+ * If you imported the version, this is the date that the evaluation set data in
1821
+ * the source version began being gathered.</p>
1822
+ */
1823
+ EvaluationDataStartTime?: Date;
1824
+ /**
1825
+ * @public
1826
+ * <p>The date on which the data in the evaluation set began being gathered.
1827
+ * If you imported the version, this is the date that the evaluation set data in the
1828
+ * source version finished being gathered.</p>
1829
+ */
1830
+ EvaluationDataEndTime?: Date;
1831
+ /**
1832
+ * @public
1833
+ * <p>The Amazon Resource Name (ARN) of the role that was used to train the model version.</p>
1834
+ */
1835
+ RoleArn?: string;
1836
+ /**
1837
+ * @public
1838
+ * <p>The configuration is the <code>TargetSamplingRate</code>, which is the sampling rate of
1839
+ * the data after post processing by Amazon Lookout for Equipment. For example, if you provide
1840
+ * data that has been collected at a 1 second level and you want the system to resample the
1841
+ * data at a 1 minute rate before training, the <code>TargetSamplingRate</code> is 1
1842
+ * minute.</p>
1843
+ * <p>When providing a value for the <code>TargetSamplingRate</code>, you must attach the
1844
+ * prefix "PT" to the rate you want. The value for a 1 second rate is therefore
1845
+ * <i>PT1S</i>, the value for a 15 minute rate is <i>PT15M</i>,
1846
+ * and the value for a 1 hour rate is <i>PT1H</i>
1847
+ * </p>
1848
+ */
1849
+ DataPreProcessingConfiguration?: DataPreProcessingConfiguration;
1850
+ /**
1851
+ * @public
1852
+ * <p>The time when the training of the version began.</p>
1853
+ */
1854
+ TrainingExecutionStartTime?: Date;
1855
+ /**
1856
+ * @public
1857
+ * <p>The time when the training of the version completed.</p>
1858
+ */
1859
+ TrainingExecutionEndTime?: Date;
1860
+ /**
1861
+ * @public
1862
+ * <p>The failure message if the training of the model version failed.</p>
1863
+ */
1864
+ FailedReason?: string;
1865
+ /**
1866
+ * @public
1867
+ * <p>Shows an aggregated summary, in JSON format, of the model's
1868
+ * performance within the evaluation time range. These metrics
1869
+ * are created when evaluating the model.</p>
1870
+ */
1871
+ ModelMetrics?: string;
1872
+ /**
1873
+ * @public
1874
+ * <p>Indicates the last time the machine learning model version was updated.</p>
1875
+ */
1876
+ LastUpdatedTime?: Date;
1877
+ /**
1878
+ * @public
1879
+ * <p>Indicates the time and date at which the machine learning model version was created.</p>
1880
+ */
1881
+ CreatedAt?: Date;
1882
+ /**
1883
+ * @public
1884
+ * <p>The identifier of the KMS key key used to encrypt model version data by
1885
+ * Amazon Lookout for Equipment.</p>
1886
+ */
1887
+ ServerSideKmsKeyId?: string;
1888
+ /**
1889
+ * @public
1890
+ * <p>Indicates that the asset associated with this sensor has been
1891
+ * shut off. As long as this condition is met, Lookout for Equipment
1892
+ * will not use data from this asset for training, evaluation, or inference.</p>
1893
+ */
1894
+ OffCondition?: string;
1895
+ /**
1896
+ * @public
1897
+ * <p>If model version was imported, then this field is the arn
1898
+ * of the source model version.</p>
1899
+ */
1900
+ SourceModelVersionArn?: string;
1901
+ /**
1902
+ * @public
1903
+ * <p>The date and time when the import job began.
1904
+ * This field appears if the model version was imported.</p>
1905
+ */
1906
+ ImportJobStartTime?: Date;
1907
+ /**
1908
+ * @public
1909
+ * <p>The date and time when the import job completed.
1910
+ * This field appears if the model version was imported.</p>
1911
+ */
1912
+ ImportJobEndTime?: Date;
1913
+ /**
1914
+ * @public
1915
+ * <p>The size in bytes of the imported data.
1916
+ * This field appears if the model version was imported.</p>
1917
+ */
1918
+ ImportedDataSizeInBytes?: number;
1919
+ }
1920
+ /**
1921
+ * @public
1922
+ */
1923
+ export interface DescribeResourcePolicyRequest {
1924
+ /**
1925
+ * @public
1926
+ * <p>The Amazon Resource Name (ARN) of the resource that is associated with the resource policy.</p>
1927
+ */
1928
+ ResourceArn: string | undefined;
1929
+ }
1930
+ /**
1931
+ * @public
1932
+ */
1933
+ export interface DescribeResourcePolicyResponse {
1934
+ /**
1935
+ * @public
1936
+ * <p>A unique identifier for a revision of the resource policy.</p>
1937
+ */
1938
+ PolicyRevisionId?: string;
1939
+ /**
1940
+ * @public
1941
+ * <p>The resource policy in a JSON-formatted string.</p>
1942
+ */
1943
+ ResourcePolicy?: string;
1944
+ /**
1945
+ * @public
1946
+ * <p>The time when the resource policy was created.</p>
1947
+ */
1948
+ CreationTime?: Date;
1949
+ /**
1950
+ * @public
1951
+ * <p>The time when the resource policy was last modified.</p>
1952
+ */
1953
+ LastModifiedTime?: Date;
1954
+ }
1955
+ /**
1956
+ * @public
1957
+ */
1958
+ export interface ImportDatasetRequest {
1959
+ /**
1960
+ * @public
1961
+ * <p>The Amazon Resource Name (ARN) of the dataset to import.</p>
1962
+ */
1963
+ SourceDatasetArn: string | undefined;
1964
+ /**
1965
+ * @public
1966
+ * <p>The name of the machine learning dataset to be created. If the dataset already exists, Amazon Lookout for Equipment overwrites the existing dataset. If you don't specify this field, it is filled with the name of the source dataset.</p>
1967
+ */
1968
+ DatasetName?: string;
1969
+ /**
1970
+ * @public
1971
+ * <p>A unique identifier for the request.
1972
+ * If you do not set the client request token,
1973
+ * Amazon Lookout for Equipment generates one. </p>
1974
+ */
1975
+ ClientToken?: string;
1976
+ /**
1977
+ * @public
1978
+ * <p>Provides the identifier of the KMS key key used to
1979
+ * encrypt model data by Amazon Lookout for Equipment. </p>
1980
+ */
1981
+ ServerSideKmsKeyId?: string;
1982
+ /**
1983
+ * @public
1984
+ * <p>Any tags associated with the dataset to be created.</p>
1985
+ */
1986
+ Tags?: Tag[];
1987
+ }
1988
+ /**
1989
+ * @public
1990
+ */
1991
+ export interface ImportDatasetResponse {
1992
+ /**
1993
+ * @public
1994
+ * <p>The name of the created machine learning dataset.</p>
1995
+ */
1996
+ DatasetName?: string;
1997
+ /**
1998
+ * @public
1999
+ * <p>The Amazon Resource Name (ARN) of the dataset that was imported.</p>
2000
+ */
2001
+ DatasetArn?: string;
2002
+ /**
2003
+ * @public
2004
+ * <p>The status of the <code>ImportDataset</code> operation.</p>
2005
+ */
2006
+ Status?: DatasetStatus | string;
2007
+ /**
2008
+ * @public
2009
+ * <p>A unique identifier for the job of importing the dataset.</p>
2010
+ */
2011
+ JobId?: string;
2012
+ }
2013
+ /**
2014
+ * @public
2015
+ */
2016
+ export interface ImportModelVersionRequest {
2017
+ /**
2018
+ * @public
2019
+ * <p>The Amazon Resource Name (ARN) of the model version to import.</p>
2020
+ */
2021
+ SourceModelVersionArn: string | undefined;
2022
+ /**
2023
+ * @public
2024
+ * <p>The name for the machine learning model to be created.
2025
+ * If the model already exists, Amazon Lookout for Equipment creates a new version.
2026
+ * If you do not specify this field, it is filled with the name of the source model.</p>
2027
+ */
2028
+ ModelName?: string;
2029
+ /**
2030
+ * @public
2031
+ * <p>The name of the dataset for the machine learning model being imported. </p>
2032
+ */
2033
+ DatasetName: string | undefined;
2034
+ /**
2035
+ * @public
2036
+ * <p>Contains the configuration information for the S3 location being used to hold label
2037
+ * data. </p>
2038
+ */
2039
+ LabelsInputConfiguration?: LabelsInputConfiguration;
2040
+ /**
2041
+ * @public
2042
+ * <p>A unique identifier for the request. If you do not set the client request
2043
+ * token, Amazon Lookout for Equipment generates one. </p>
2044
+ */
2045
+ ClientToken?: string;
2046
+ /**
2047
+ * @public
2048
+ * <p>The Amazon Resource Name (ARN) of a role with permission to
2049
+ * access the data source being used to create the machine learning model. </p>
2050
+ */
2051
+ RoleArn?: string;
2052
+ /**
2053
+ * @public
2054
+ * <p>Provides the identifier of the KMS key key used to encrypt
2055
+ * model data by Amazon Lookout for Equipment. </p>
2056
+ */
2057
+ ServerSideKmsKeyId?: string;
2058
+ /**
2059
+ * @public
2060
+ * <p>The tags associated with the machine learning model to be created. </p>
2061
+ */
2062
+ Tags?: Tag[];
2063
+ }
2064
+ /**
2065
+ * @public
2066
+ */
2067
+ export interface ImportModelVersionResponse {
2068
+ /**
2069
+ * @public
2070
+ * <p>The name for the machine learning model.</p>
2071
+ */
2072
+ ModelName?: string;
2073
+ /**
2074
+ * @public
2075
+ * <p>The Amazon Resource Name (ARN) of the model being created. </p>
2076
+ */
2077
+ ModelArn?: string;
2078
+ /**
2079
+ * @public
2080
+ * <p>The Amazon Resource Name (ARN) of the model version being created. </p>
2081
+ */
2082
+ ModelVersionArn?: string;
2083
+ /**
2084
+ * @public
2085
+ * <p>The version of the model being created.</p>
2086
+ */
2087
+ ModelVersion?: number;
2088
+ /**
2089
+ * @public
2090
+ * <p>The status of the <code>ImportModelVersion</code> operation. </p>
2091
+ */
2092
+ Status?: ModelVersionStatus | string;
1443
2093
  }
1444
2094
  /**
1445
2095
  * @public
1446
2096
  */
1447
2097
  export interface ListDataIngestionJobsRequest {
1448
2098
  /**
2099
+ * @public
1449
2100
  * <p>The name of the dataset being used for the data ingestion job. </p>
1450
2101
  */
1451
2102
  DatasetName?: string;
1452
2103
  /**
2104
+ * @public
1453
2105
  * <p>An opaque pagination token indicating where to continue the listing of data ingestion
1454
2106
  * jobs. </p>
1455
2107
  */
1456
2108
  NextToken?: string;
1457
2109
  /**
2110
+ * @public
1458
2111
  * <p> Specifies the maximum number of data ingestion jobs to list. </p>
1459
2112
  */
1460
2113
  MaxResults?: number;
1461
2114
  /**
2115
+ * @public
1462
2116
  * <p>Indicates the status of the data ingestion job. </p>
1463
2117
  */
1464
2118
  Status?: IngestionJobStatus | string;
@@ -1470,23 +2124,28 @@ export interface ListDataIngestionJobsRequest {
1470
2124
  */
1471
2125
  export interface DataIngestionJobSummary {
1472
2126
  /**
2127
+ * @public
1473
2128
  * <p>Indicates the job ID of the data ingestion job. </p>
1474
2129
  */
1475
2130
  JobId?: string;
1476
2131
  /**
2132
+ * @public
1477
2133
  * <p>The name of the dataset used for the data ingestion job. </p>
1478
2134
  */
1479
2135
  DatasetName?: string;
1480
2136
  /**
2137
+ * @public
1481
2138
  * <p>The Amazon Resource Name (ARN) of the dataset used in the data ingestion job. </p>
1482
2139
  */
1483
2140
  DatasetArn?: string;
1484
2141
  /**
2142
+ * @public
1485
2143
  * <p> Specifies information for the input data for the data inference job, including data
1486
2144
  * Amazon S3 location parameters. </p>
1487
2145
  */
1488
2146
  IngestionInputConfiguration?: IngestionInputConfiguration;
1489
2147
  /**
2148
+ * @public
1490
2149
  * <p>Indicates the status of the data ingestion job. </p>
1491
2150
  */
1492
2151
  Status?: IngestionJobStatus | string;
@@ -1496,11 +2155,13 @@ export interface DataIngestionJobSummary {
1496
2155
  */
1497
2156
  export interface ListDataIngestionJobsResponse {
1498
2157
  /**
2158
+ * @public
1499
2159
  * <p> An opaque pagination token indicating where to continue the listing of data ingestion
1500
2160
  * jobs. </p>
1501
2161
  */
1502
2162
  NextToken?: string;
1503
2163
  /**
2164
+ * @public
1504
2165
  * <p>Specifies information about the specific data ingestion job, including dataset name and
1505
2166
  * status. </p>
1506
2167
  */
@@ -1511,15 +2172,18 @@ export interface ListDataIngestionJobsResponse {
1511
2172
  */
1512
2173
  export interface ListDatasetsRequest {
1513
2174
  /**
2175
+ * @public
1514
2176
  * <p> An opaque pagination token indicating where to continue the listing of datasets.
1515
2177
  * </p>
1516
2178
  */
1517
2179
  NextToken?: string;
1518
2180
  /**
2181
+ * @public
1519
2182
  * <p> Specifies the maximum number of datasets to list. </p>
1520
2183
  */
1521
2184
  MaxResults?: number;
1522
2185
  /**
2186
+ * @public
1523
2187
  * <p>The beginning of the name of the datasets to be listed. </p>
1524
2188
  */
1525
2189
  DatasetNameBeginsWith?: string;
@@ -1531,18 +2195,22 @@ export interface ListDatasetsRequest {
1531
2195
  */
1532
2196
  export interface DatasetSummary {
1533
2197
  /**
2198
+ * @public
1534
2199
  * <p>The name of the dataset. </p>
1535
2200
  */
1536
2201
  DatasetName?: string;
1537
2202
  /**
2203
+ * @public
1538
2204
  * <p>The Amazon Resource Name (ARN) of the specified dataset. </p>
1539
2205
  */
1540
2206
  DatasetArn?: string;
1541
2207
  /**
2208
+ * @public
1542
2209
  * <p>Indicates the status of the dataset. </p>
1543
2210
  */
1544
2211
  Status?: DatasetStatus | string;
1545
2212
  /**
2213
+ * @public
1546
2214
  * <p>The time at which the dataset was created in Amazon Lookout for Equipment. </p>
1547
2215
  */
1548
2216
  CreatedAt?: Date;
@@ -1552,11 +2220,13 @@ export interface DatasetSummary {
1552
2220
  */
1553
2221
  export interface ListDatasetsResponse {
1554
2222
  /**
2223
+ * @public
1555
2224
  * <p> An opaque pagination token indicating where to continue the listing of datasets.
1556
2225
  * </p>
1557
2226
  */
1558
2227
  NextToken?: string;
1559
2228
  /**
2229
+ * @public
1560
2230
  * <p>Provides information about the specified dataset, including creation time, dataset ARN,
1561
2231
  * and status. </p>
1562
2232
  */
@@ -1567,25 +2237,30 @@ export interface ListDatasetsResponse {
1567
2237
  */
1568
2238
  export interface ListInferenceEventsRequest {
1569
2239
  /**
2240
+ * @public
1570
2241
  * <p>An opaque pagination token indicating where to continue the listing of inference
1571
2242
  * events.</p>
1572
2243
  */
1573
2244
  NextToken?: string;
1574
2245
  /**
2246
+ * @public
1575
2247
  * <p>Specifies the maximum number of inference events to list. </p>
1576
2248
  */
1577
2249
  MaxResults?: number;
1578
2250
  /**
2251
+ * @public
1579
2252
  * <p>The name of the inference scheduler for the inference events listed. </p>
1580
2253
  */
1581
2254
  InferenceSchedulerName: string | undefined;
1582
2255
  /**
2256
+ * @public
1583
2257
  * <p> Lookout for Equipment will return all the inference events with an end time equal to or greater than the
1584
2258
  * start time given.</p>
1585
2259
  */
1586
2260
  IntervalStartTime: Date | undefined;
1587
2261
  /**
1588
- * <p>Returns all the inference events with an end start time equal to or greater than less than the end time given</p>
2262
+ * @public
2263
+ * <p>Returns all the inference events with an end start time equal to or greater than less than the end time given.</p>
1589
2264
  */
1590
2265
  IntervalEndTime: Date | undefined;
1591
2266
  }
@@ -1596,28 +2271,34 @@ export interface ListInferenceEventsRequest {
1596
2271
  */
1597
2272
  export interface InferenceEventSummary {
1598
2273
  /**
2274
+ * @public
1599
2275
  * <p> The Amazon Resource Name (ARN) of the inference scheduler being used for the inference
1600
2276
  * event. </p>
1601
2277
  */
1602
2278
  InferenceSchedulerArn?: string;
1603
2279
  /**
2280
+ * @public
1604
2281
  * <p>The name of the inference scheduler being used for the inference events. </p>
1605
2282
  */
1606
2283
  InferenceSchedulerName?: string;
1607
2284
  /**
2285
+ * @public
1608
2286
  * <p>Indicates the starting time of an inference event. </p>
1609
2287
  */
1610
2288
  EventStartTime?: Date;
1611
2289
  /**
2290
+ * @public
1612
2291
  * <p>Indicates the ending time of an inference event. </p>
1613
2292
  */
1614
2293
  EventEndTime?: Date;
1615
2294
  /**
2295
+ * @public
1616
2296
  * <p> An array which specifies the names and values of all sensors contributing to an
1617
2297
  * inference event.</p>
1618
2298
  */
1619
2299
  Diagnostics?: string;
1620
2300
  /**
2301
+ * @public
1621
2302
  * <p> Indicates the size of an inference event in seconds. </p>
1622
2303
  */
1623
2304
  EventDurationInSeconds?: number;
@@ -1627,11 +2308,13 @@ export interface InferenceEventSummary {
1627
2308
  */
1628
2309
  export interface ListInferenceEventsResponse {
1629
2310
  /**
2311
+ * @public
1630
2312
  * <p>An opaque pagination token indicating where to continue the listing of inference
1631
2313
  * executions. </p>
1632
2314
  */
1633
2315
  NextToken?: string;
1634
2316
  /**
2317
+ * @public
1635
2318
  * <p>Provides an array of information about the individual inference events returned from the
1636
2319
  * <code>ListInferenceEvents</code> operation, including scheduler used, event start time,
1637
2320
  * event end time, diagnostics, and so on. </p>
@@ -1656,29 +2339,35 @@ export type InferenceExecutionStatus = (typeof InferenceExecutionStatus)[keyof t
1656
2339
  */
1657
2340
  export interface ListInferenceExecutionsRequest {
1658
2341
  /**
2342
+ * @public
1659
2343
  * <p>An opaque pagination token indicating where to continue the listing of inference
1660
2344
  * executions.</p>
1661
2345
  */
1662
2346
  NextToken?: string;
1663
2347
  /**
2348
+ * @public
1664
2349
  * <p>Specifies the maximum number of inference executions to list. </p>
1665
2350
  */
1666
2351
  MaxResults?: number;
1667
2352
  /**
2353
+ * @public
1668
2354
  * <p>The name of the inference scheduler for the inference execution listed. </p>
1669
2355
  */
1670
2356
  InferenceSchedulerName: string | undefined;
1671
2357
  /**
2358
+ * @public
1672
2359
  * <p>The time reference in the inferenced dataset after which Amazon Lookout for Equipment
1673
2360
  * started the inference execution. </p>
1674
2361
  */
1675
2362
  DataStartTimeAfter?: Date;
1676
2363
  /**
2364
+ * @public
1677
2365
  * <p>The time reference in the inferenced dataset before which Amazon Lookout for Equipment
1678
2366
  * stopped the inference execution. </p>
1679
2367
  */
1680
2368
  DataEndTimeBefore?: Date;
1681
2369
  /**
2370
+ * @public
1682
2371
  * <p>The status of the inference execution. </p>
1683
2372
  */
1684
2373
  Status?: InferenceExecutionStatus | string;
@@ -1690,58 +2379,70 @@ export interface ListInferenceExecutionsRequest {
1690
2379
  */
1691
2380
  export interface InferenceExecutionSummary {
1692
2381
  /**
2382
+ * @public
1693
2383
  * <p>The name of the ML model being used for the inference execution. </p>
1694
2384
  */
1695
2385
  ModelName?: string;
1696
2386
  /**
2387
+ * @public
1697
2388
  * <p>The Amazon Resource Name (ARN) of the ML model used for the inference execution. </p>
1698
2389
  */
1699
2390
  ModelArn?: string;
1700
2391
  /**
2392
+ * @public
1701
2393
  * <p>The name of the inference scheduler being used for the inference execution. </p>
1702
2394
  */
1703
2395
  InferenceSchedulerName?: string;
1704
2396
  /**
2397
+ * @public
1705
2398
  * <p> The Amazon Resource Name (ARN) of the inference scheduler being used for the inference
1706
2399
  * execution. </p>
1707
2400
  */
1708
2401
  InferenceSchedulerArn?: string;
1709
2402
  /**
2403
+ * @public
1710
2404
  * <p>Indicates the start time at which the inference scheduler began the specific inference
1711
2405
  * execution. </p>
1712
2406
  */
1713
2407
  ScheduledStartTime?: Date;
1714
2408
  /**
2409
+ * @public
1715
2410
  * <p>Indicates the time reference in the dataset at which the inference execution began.
1716
2411
  * </p>
1717
2412
  */
1718
2413
  DataStartTime?: Date;
1719
2414
  /**
2415
+ * @public
1720
2416
  * <p>Indicates the time reference in the dataset at which the inference execution stopped.
1721
2417
  * </p>
1722
2418
  */
1723
2419
  DataEndTime?: Date;
1724
2420
  /**
2421
+ * @public
1725
2422
  * <p> Specifies configuration information for the input data for the inference scheduler,
1726
2423
  * including delimiter, format, and dataset location. </p>
1727
2424
  */
1728
2425
  DataInputConfiguration?: InferenceInputConfiguration;
1729
2426
  /**
2427
+ * @public
1730
2428
  * <p> Specifies configuration information for the output results from for the inference
1731
2429
  * execution, including the output Amazon S3 location.
1732
2430
  * </p>
1733
2431
  */
1734
2432
  DataOutputConfiguration?: InferenceOutputConfiguration;
1735
2433
  /**
2434
+ * @public
1736
2435
  * <p>
1737
2436
  * </p>
1738
2437
  */
1739
2438
  CustomerResultObject?: S3Object;
1740
2439
  /**
2440
+ * @public
1741
2441
  * <p>Indicates the status of the inference execution. </p>
1742
2442
  */
1743
2443
  Status?: InferenceExecutionStatus | string;
1744
2444
  /**
2445
+ * @public
1745
2446
  * <p> Specifies the reason for failure when an inference execution has failed. </p>
1746
2447
  */
1747
2448
  FailedReason?: string;
@@ -1751,11 +2452,13 @@ export interface InferenceExecutionSummary {
1751
2452
  */
1752
2453
  export interface ListInferenceExecutionsResponse {
1753
2454
  /**
2455
+ * @public
1754
2456
  * <p> An opaque pagination token indicating where to continue the listing of inference
1755
2457
  * executions. </p>
1756
2458
  */
1757
2459
  NextToken?: string;
1758
2460
  /**
2461
+ * @public
1759
2462
  * <p>Provides an array of information about the individual inference executions returned from
1760
2463
  * the <code>ListInferenceExecutions</code> operation, including model used, inference
1761
2464
  * scheduler, data configuration, and so on. </p>
@@ -1767,24 +2470,29 @@ export interface ListInferenceExecutionsResponse {
1767
2470
  */
1768
2471
  export interface ListInferenceSchedulersRequest {
1769
2472
  /**
2473
+ * @public
1770
2474
  * <p> An opaque pagination token indicating where to continue the listing of inference
1771
2475
  * schedulers. </p>
1772
2476
  */
1773
2477
  NextToken?: string;
1774
2478
  /**
2479
+ * @public
1775
2480
  * <p> Specifies the maximum number of inference schedulers to list. </p>
1776
2481
  */
1777
2482
  MaxResults?: number;
1778
2483
  /**
2484
+ * @public
1779
2485
  * <p>The beginning of the name of the inference schedulers to be listed. </p>
1780
2486
  */
1781
2487
  InferenceSchedulerNameBeginsWith?: string;
1782
2488
  /**
2489
+ * @public
1783
2490
  * <p>The name of the ML model used by the inference scheduler to be listed. </p>
1784
2491
  */
1785
2492
  ModelName?: string;
1786
2493
  /**
1787
- * <p>Specifies the current status of the inference schedulers to list.</p>
2494
+ * @public
2495
+ * <p>Specifies the current status of the inference schedulers.</p>
1788
2496
  */
1789
2497
  Status?: InferenceSchedulerStatus | string;
1790
2498
  }
@@ -1795,26 +2503,32 @@ export interface ListInferenceSchedulersRequest {
1795
2503
  */
1796
2504
  export interface InferenceSchedulerSummary {
1797
2505
  /**
2506
+ * @public
1798
2507
  * <p>The name of the ML model used for the inference scheduler. </p>
1799
2508
  */
1800
2509
  ModelName?: string;
1801
2510
  /**
2511
+ * @public
1802
2512
  * <p> The Amazon Resource Name (ARN) of the ML model used by the inference scheduler. </p>
1803
2513
  */
1804
2514
  ModelArn?: string;
1805
2515
  /**
2516
+ * @public
1806
2517
  * <p>The name of the inference scheduler. </p>
1807
2518
  */
1808
2519
  InferenceSchedulerName?: string;
1809
2520
  /**
2521
+ * @public
1810
2522
  * <p> The Amazon Resource Name (ARN) of the inference scheduler. </p>
1811
2523
  */
1812
2524
  InferenceSchedulerArn?: string;
1813
2525
  /**
2526
+ * @public
1814
2527
  * <p>Indicates the status of the inference scheduler. </p>
1815
2528
  */
1816
2529
  Status?: InferenceSchedulerStatus | string;
1817
2530
  /**
2531
+ * @public
1818
2532
  * <p>A period of time (in minutes) by which inference on the data is delayed after the data
1819
2533
  * starts. For instance, if an offset delay time of five minutes was selected, inference will
1820
2534
  * not begin on the data until the first data measurement after the five minute mark. For
@@ -1825,6 +2539,7 @@ export interface InferenceSchedulerSummary {
1825
2539
  */
1826
2540
  DataDelayOffsetInMinutes?: number;
1827
2541
  /**
2542
+ * @public
1828
2543
  * <p>How often data is uploaded to the source S3 bucket for the input data. This value is the
1829
2544
  * length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout
1830
2545
  * for Equipment will upload the real-time data to the source bucket once every 5 minutes.
@@ -1833,6 +2548,7 @@ export interface InferenceSchedulerSummary {
1833
2548
  */
1834
2549
  DataUploadFrequency?: DataUploadFrequency | string;
1835
2550
  /**
2551
+ * @public
1836
2552
  * <p>Indicates whether the latest execution for the inference scheduler was Anomalous
1837
2553
  * (anomalous events found) or Normal (no anomalous events found).</p>
1838
2554
  */
@@ -1843,11 +2559,13 @@ export interface InferenceSchedulerSummary {
1843
2559
  */
1844
2560
  export interface ListInferenceSchedulersResponse {
1845
2561
  /**
2562
+ * @public
1846
2563
  * <p> An opaque pagination token indicating where to continue the listing of inference
1847
2564
  * schedulers. </p>
1848
2565
  */
1849
2566
  NextToken?: string;
1850
2567
  /**
2568
+ * @public
1851
2569
  * <p>Provides information about the specified inference scheduler, including data upload
1852
2570
  * frequency, model name and ARN, and status. </p>
1853
2571
  */
@@ -1858,53 +2576,60 @@ export interface ListInferenceSchedulersResponse {
1858
2576
  */
1859
2577
  export interface ListLabelGroupsRequest {
1860
2578
  /**
2579
+ * @public
1861
2580
  * <p>
1862
- * The beginning of the name of the label groups to be listed.
1863
- * </p>
2581
+ * The beginning of the name of the label groups to be listed.
2582
+ * </p>
1864
2583
  */
1865
2584
  LabelGroupNameBeginsWith?: string;
1866
2585
  /**
2586
+ * @public
1867
2587
  * <p>
1868
- * An opaque pagination token indicating where to continue the listing of label groups.
1869
- * </p>
2588
+ * An opaque pagination token indicating where to continue the listing of label groups.
2589
+ * </p>
1870
2590
  */
1871
2591
  NextToken?: string;
1872
2592
  /**
2593
+ * @public
1873
2594
  * <p>
1874
- * Specifies the maximum number of label groups to list.
1875
- * </p>
2595
+ * Specifies the maximum number of label groups to list.
2596
+ * </p>
1876
2597
  */
1877
2598
  MaxResults?: number;
1878
2599
  }
1879
2600
  /**
1880
2601
  * @public
1881
2602
  * <p>
1882
- * Contains information about the label group.
1883
- * </p>
2603
+ * Contains information about the label group.
2604
+ * </p>
1884
2605
  */
1885
2606
  export interface LabelGroupSummary {
1886
2607
  /**
2608
+ * @public
1887
2609
  * <p>
1888
- * The name of the label group.
1889
- * </p>
2610
+ * The name of the label group.
2611
+ * </p>
1890
2612
  */
1891
2613
  LabelGroupName?: string;
1892
2614
  /**
2615
+ * @public
1893
2616
  * <p>
1894
- * The ARN of the label group.
1895
- * </p>
2617
+ * The Amazon Resource Name (ARN) of the label group.
2618
+ * </p>
1896
2619
  */
1897
2620
  LabelGroupArn?: string;
1898
2621
  /**
2622
+ * @public
1899
2623
  * <p>
1900
- * The time at which the label group was created.
1901
- * </p>
2624
+ * The time at which the label group was created.
2625
+ * </p>
1902
2626
  */
1903
2627
  CreatedAt?: Date;
1904
2628
  /**
2629
+ * @public
1905
2630
  * <p>
1906
- * The time at which the label group was updated.
1907
- * </p>
2631
+ * The time at which the label group was updated.
2632
+ * </p>
1908
2633
  */
1909
2634
  UpdatedAt?: Date;
1910
2635
  }
@@ -1913,15 +2638,17 @@ export interface LabelGroupSummary {
1913
2638
  */
1914
2639
  export interface ListLabelGroupsResponse {
1915
2640
  /**
2641
+ * @public
1916
2642
  * <p>
1917
- * An opaque pagination token indicating where to continue the listing of label groups.
1918
- * </p>
2643
+ * An opaque pagination token indicating where to continue the listing of label groups.
2644
+ * </p>
1919
2645
  */
1920
2646
  NextToken?: string;
1921
2647
  /**
2648
+ * @public
1922
2649
  * <p>
1923
- * A summary of the label groups.
1924
- * </p>
2650
+ * A summary of the label groups.
2651
+ * </p>
1925
2652
  */
1926
2653
  LabelGroupSummaries?: LabelGroupSummary[];
1927
2654
  }
@@ -1930,108 +2657,124 @@ export interface ListLabelGroupsResponse {
1930
2657
  */
1931
2658
  export interface ListLabelsRequest {
1932
2659
  /**
2660
+ * @public
1933
2661
  * <p>
1934
- * Retruns the name of the label group.
1935
- * </p>
2662
+ * Retruns the name of the label group.
2663
+ * </p>
1936
2664
  */
1937
2665
  LabelGroupName: string | undefined;
1938
2666
  /**
2667
+ * @public
1939
2668
  * <p>
1940
- * Returns all the labels with a end time equal to or later than the start time given.
1941
- * </p>
2669
+ * Returns all the labels with a end time equal to or later than the start time given.
2670
+ * </p>
1942
2671
  */
1943
2672
  IntervalStartTime?: Date;
1944
2673
  /**
2674
+ * @public
1945
2675
  * <p>
1946
- * Returns all labels with a start time earlier than the end time given.
1947
- * </p>
2676
+ * Returns all labels with a start time earlier than the end time given.
2677
+ * </p>
1948
2678
  */
1949
2679
  IntervalEndTime?: Date;
1950
2680
  /**
2681
+ * @public
1951
2682
  * <p>
1952
- * Returns labels with a particular fault code.
1953
- * </p>
2683
+ * Returns labels with a particular fault code.
2684
+ * </p>
1954
2685
  */
1955
2686
  FaultCode?: string;
1956
2687
  /**
2688
+ * @public
1957
2689
  * <p>
1958
- * Lists the labels that pertain to a particular piece of equipment.
1959
- * </p>
2690
+ * Lists the labels that pertain to a particular piece of equipment.
2691
+ * </p>
1960
2692
  */
1961
2693
  Equipment?: string;
1962
2694
  /**
2695
+ * @public
1963
2696
  * <p>
1964
- * An opaque pagination token indicating where to continue the listing of label groups.
1965
- * </p>
2697
+ * An opaque pagination token indicating where to continue the listing of label groups.
2698
+ * </p>
1966
2699
  */
1967
2700
  NextToken?: string;
1968
2701
  /**
2702
+ * @public
1969
2703
  * <p>
1970
- * Specifies the maximum number of labels to list.
1971
- * </p>
2704
+ * Specifies the maximum number of labels to list.
2705
+ * </p>
1972
2706
  */
1973
2707
  MaxResults?: number;
1974
2708
  }
1975
2709
  /**
1976
2710
  * @public
1977
2711
  * <p>
1978
- * Information about the label.
1979
- * </p>
2712
+ * Information about the label.
2713
+ * </p>
1980
2714
  */
1981
2715
  export interface LabelSummary {
1982
2716
  /**
2717
+ * @public
1983
2718
  * <p>
1984
- * The name of the label group.
1985
- * </p>
2719
+ * The name of the label group.
2720
+ * </p>
1986
2721
  */
1987
2722
  LabelGroupName?: string;
1988
2723
  /**
2724
+ * @public
1989
2725
  * <p>
1990
- * The ID of the label.
1991
- * </p>
2726
+ * The ID of the label.
2727
+ * </p>
1992
2728
  */
1993
2729
  LabelId?: string;
1994
2730
  /**
2731
+ * @public
1995
2732
  * <p>
1996
- * The ARN of the label group.
1997
- * </p>
2733
+ * The Amazon Resource Name (ARN) of the label group.
2734
+ * </p>
1998
2735
  */
1999
2736
  LabelGroupArn?: string;
2000
2737
  /**
2738
+ * @public
2001
2739
  * <p>
2002
- * The timestamp indicating the start of the label.
2003
- * </p>
2740
+ * The timestamp indicating the start of the label.
2741
+ * </p>
2004
2742
  */
2005
2743
  StartTime?: Date;
2006
2744
  /**
2745
+ * @public
2007
2746
  * <p>
2008
- * The timestamp indicating the end of the label.
2009
- * </p>
2747
+ * The timestamp indicating the end of the label.
2748
+ * </p>
2010
2749
  */
2011
2750
  EndTime?: Date;
2012
2751
  /**
2752
+ * @public
2013
2753
  * <p>
2014
- * Indicates whether a labeled event represents an anomaly.
2015
- * </p>
2754
+ * Indicates whether a labeled event represents an anomaly.
2755
+ * </p>
2016
2756
  */
2017
2757
  Rating?: LabelRating | string;
2018
2758
  /**
2759
+ * @public
2019
2760
  * <p>
2020
- * Indicates the type of anomaly associated with the label.
2021
- * </p>
2761
+ * Indicates the type of anomaly associated with the label.
2762
+ * </p>
2022
2763
  * <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.</p>
2023
2764
  */
2024
2765
  FaultCode?: string;
2025
2766
  /**
2767
+ * @public
2026
2768
  * <p>
2027
- * Indicates that a label pertains to a particular piece of equipment.
2028
- * </p>
2769
+ * Indicates that a label pertains to a particular piece of equipment.
2770
+ * </p>
2029
2771
  */
2030
2772
  Equipment?: string;
2031
2773
  /**
2774
+ * @public
2032
2775
  * <p>
2033
- * The time at which the label was created.
2034
- * </p>
2776
+ * The time at which the label was created.
2777
+ * </p>
2035
2778
  */
2036
2779
  CreatedAt?: Date;
2037
2780
  }
@@ -2040,15 +2783,17 @@ export interface LabelSummary {
2040
2783
  */
2041
2784
  export interface ListLabelsResponse {
2042
2785
  /**
2786
+ * @public
2043
2787
  * <p>
2044
- * An opaque pagination token indicating where to continue the listing of datasets.
2045
- * </p>
2788
+ * An opaque pagination token indicating where to continue the listing of datasets.
2789
+ * </p>
2046
2790
  */
2047
2791
  NextToken?: string;
2048
2792
  /**
2793
+ * @public
2049
2794
  * <p>
2050
- * A summary of the items in the label group.
2051
- * </p>
2795
+ * A summary of the items in the label group.
2796
+ * </p>
2052
2797
  */
2053
2798
  LabelSummaries?: LabelSummary[];
2054
2799
  }
@@ -2057,23 +2802,28 @@ export interface ListLabelsResponse {
2057
2802
  */
2058
2803
  export interface ListModelsRequest {
2059
2804
  /**
2805
+ * @public
2060
2806
  * <p> An opaque pagination token indicating where to continue the listing of ML models.
2061
2807
  * </p>
2062
2808
  */
2063
2809
  NextToken?: string;
2064
2810
  /**
2811
+ * @public
2065
2812
  * <p> Specifies the maximum number of ML models to list. </p>
2066
2813
  */
2067
2814
  MaxResults?: number;
2068
2815
  /**
2816
+ * @public
2069
2817
  * <p>The status of the ML model. </p>
2070
2818
  */
2071
2819
  Status?: ModelStatus | string;
2072
2820
  /**
2821
+ * @public
2073
2822
  * <p>The beginning of the name of the ML models being listed. </p>
2074
2823
  */
2075
2824
  ModelNameBeginsWith?: string;
2076
2825
  /**
2826
+ * @public
2077
2827
  * <p>The beginning of the name of the dataset of the ML models to be listed. </p>
2078
2828
  */
2079
2829
  DatasetNameBeginsWith?: string;
@@ -2085,64 +2835,203 @@ export interface ListModelsRequest {
2085
2835
  */
2086
2836
  export interface ModelSummary {
2087
2837
  /**
2838
+ * @public
2088
2839
  * <p>The name of the ML model. </p>
2089
2840
  */
2090
2841
  ModelName?: string;
2091
2842
  /**
2843
+ * @public
2092
2844
  * <p> The Amazon Resource Name (ARN) of the ML model. </p>
2093
2845
  */
2094
2846
  ModelArn?: string;
2095
2847
  /**
2848
+ * @public
2096
2849
  * <p>The name of the dataset being used for the ML model. </p>
2097
2850
  */
2098
2851
  DatasetName?: string;
2099
2852
  /**
2853
+ * @public
2100
2854
  * <p> The Amazon Resource Name (ARN) of the dataset used to create the model. </p>
2101
2855
  */
2102
2856
  DatasetArn?: string;
2103
2857
  /**
2858
+ * @public
2104
2859
  * <p>Indicates the status of the ML model. </p>
2105
2860
  */
2106
2861
  Status?: ModelStatus | string;
2107
2862
  /**
2863
+ * @public
2108
2864
  * <p>The time at which the specific model was created. </p>
2109
2865
  */
2110
2866
  CreatedAt?: Date;
2867
+ /**
2868
+ * @public
2869
+ * <p>The model version that the inference scheduler uses to run an inference
2870
+ * execution.</p>
2871
+ */
2872
+ ActiveModelVersion?: number;
2873
+ /**
2874
+ * @public
2875
+ * <p>The Amazon Resource Name (ARN) of the model version that is set as active. The active model version
2876
+ * is the model version that the inference scheduler uses to run an inference
2877
+ * execution.</p>
2878
+ */
2879
+ ActiveModelVersionArn?: string;
2111
2880
  }
2112
2881
  /**
2113
2882
  * @public
2114
2883
  */
2115
2884
  export interface ListModelsResponse {
2116
2885
  /**
2886
+ * @public
2117
2887
  * <p> An opaque pagination token indicating where to continue the listing of ML models.
2118
2888
  * </p>
2119
2889
  */
2120
2890
  NextToken?: string;
2121
2891
  /**
2892
+ * @public
2122
2893
  * <p>Provides information on the specified model, including created time, model and dataset
2123
2894
  * ARNs, and status. </p>
2124
2895
  */
2125
2896
  ModelSummaries?: ModelSummary[];
2126
2897
  }
2898
+ /**
2899
+ * @public
2900
+ */
2901
+ export interface ListModelVersionsRequest {
2902
+ /**
2903
+ * @public
2904
+ * <p>Then name of the machine learning model for which the
2905
+ * model versions are to be listed.</p>
2906
+ */
2907
+ ModelName: string | undefined;
2908
+ /**
2909
+ * @public
2910
+ * <p>If the total number of results exceeds the limit that the response can
2911
+ * display, the response returns an opaque pagination token indicating where to
2912
+ * continue the listing of machine learning model versions. Use this token in the <code>NextToken</code>
2913
+ * field in the request to list the next page of results.</p>
2914
+ */
2915
+ NextToken?: string;
2916
+ /**
2917
+ * @public
2918
+ * <p>Specifies the maximum number of machine learning model versions to list.</p>
2919
+ */
2920
+ MaxResults?: number;
2921
+ /**
2922
+ * @public
2923
+ * <p>Filter the results based on the current status of the model version.</p>
2924
+ */
2925
+ Status?: ModelVersionStatus | string;
2926
+ /**
2927
+ * @public
2928
+ * <p>Filter the results based on the way the model version was generated.</p>
2929
+ */
2930
+ SourceType?: ModelVersionSourceType | string;
2931
+ /**
2932
+ * @public
2933
+ * <p>Filter results to return all the model versions created before this time.</p>
2934
+ */
2935
+ CreatedAtEndTime?: Date;
2936
+ /**
2937
+ * @public
2938
+ * <p>Filter results to return all the model versions created after this time.</p>
2939
+ */
2940
+ CreatedAtStartTime?: Date;
2941
+ /**
2942
+ * @public
2943
+ * <p>Specifies the highest version of the model to return in the list.</p>
2944
+ */
2945
+ MaxModelVersion?: number;
2946
+ /**
2947
+ * @public
2948
+ * <p>Specifies the lowest version of the model to return in the list.</p>
2949
+ */
2950
+ MinModelVersion?: number;
2951
+ }
2952
+ /**
2953
+ * @public
2954
+ * <p>Contains information about the specific model version.</p>
2955
+ */
2956
+ export interface ModelVersionSummary {
2957
+ /**
2958
+ * @public
2959
+ * <p>The name of the model that this model version is a version of.</p>
2960
+ */
2961
+ ModelName?: string;
2962
+ /**
2963
+ * @public
2964
+ * <p>The Amazon Resource Name (ARN) of the model that this model version is a version of.</p>
2965
+ */
2966
+ ModelArn?: string;
2967
+ /**
2968
+ * @public
2969
+ * <p>The version of the model.</p>
2970
+ */
2971
+ ModelVersion?: number;
2972
+ /**
2973
+ * @public
2974
+ * <p>The Amazon Resource Name (ARN) of the model version.</p>
2975
+ */
2976
+ ModelVersionArn?: string;
2977
+ /**
2978
+ * @public
2979
+ * <p>The time when this model version was created.</p>
2980
+ */
2981
+ CreatedAt?: Date;
2982
+ /**
2983
+ * @public
2984
+ * <p>The current status of the model version.</p>
2985
+ */
2986
+ Status?: ModelVersionStatus | string;
2987
+ /**
2988
+ * @public
2989
+ * <p>Indicates how this model version was generated.</p>
2990
+ */
2991
+ SourceType?: ModelVersionSourceType | string;
2992
+ }
2993
+ /**
2994
+ * @public
2995
+ */
2996
+ export interface ListModelVersionsResponse {
2997
+ /**
2998
+ * @public
2999
+ * <p>If the total number of results exceeds the limit that the response can
3000
+ * display, the response returns an opaque pagination token indicating where to
3001
+ * continue the listing of machine learning model versions. Use this token in the <code>NextToken</code>
3002
+ * field in the request to list the next page of results.</p>
3003
+ */
3004
+ NextToken?: string;
3005
+ /**
3006
+ * @public
3007
+ * <p>Provides information on the specified model version,
3008
+ * including the created time, model and dataset ARNs, and status.</p>
3009
+ */
3010
+ ModelVersionSummaries?: ModelVersionSummary[];
3011
+ }
2127
3012
  /**
2128
3013
  * @public
2129
3014
  */
2130
3015
  export interface ListSensorStatisticsRequest {
2131
3016
  /**
3017
+ * @public
2132
3018
  * <p> The name of the dataset associated with the list of Sensor Statistics. </p>
2133
3019
  */
2134
3020
  DatasetName: string | undefined;
2135
3021
  /**
3022
+ * @public
2136
3023
  * <p> The ingestion job id associated with the list of Sensor Statistics. To get sensor
2137
3024
  * statistics for a particular ingestion job id, both dataset name and ingestion job id must
2138
3025
  * be submitted as inputs. </p>
2139
3026
  */
2140
3027
  IngestionJobId?: string;
2141
3028
  /**
3029
+ * @public
2142
3030
  * <p>Specifies the maximum number of sensors for which to retrieve statistics. </p>
2143
3031
  */
2144
3032
  MaxResults?: number;
2145
3033
  /**
3034
+ * @public
2146
3035
  * <p>An opaque pagination token indicating where to continue the listing of sensor
2147
3036
  * statistics. </p>
2148
3037
  */
@@ -2166,11 +3055,13 @@ export type StatisticalIssueStatus = (typeof StatisticalIssueStatus)[keyof typeo
2166
3055
  */
2167
3056
  export interface CategoricalValues {
2168
3057
  /**
3058
+ * @public
2169
3059
  * <p> Indicates whether there is a potential data issue related to categorical values.
2170
3060
  * </p>
2171
3061
  */
2172
3062
  Status: StatisticalIssueStatus | string | undefined;
2173
3063
  /**
3064
+ * @public
2174
3065
  * <p> Indicates the number of categories in the data. </p>
2175
3066
  */
2176
3067
  NumberOfCategory?: number;
@@ -2181,10 +3072,12 @@ export interface CategoricalValues {
2181
3072
  */
2182
3073
  export interface CountPercent {
2183
3074
  /**
3075
+ * @public
2184
3076
  * <p> Indicates the count of occurences of the given statistic. </p>
2185
3077
  */
2186
3078
  Count: number | undefined;
2187
3079
  /**
3080
+ * @public
2188
3081
  * <p> Indicates the percentage of occurances of the given statistic. </p>
2189
3082
  */
2190
3083
  Percentage: number | undefined;
@@ -2196,15 +3089,18 @@ export interface CountPercent {
2196
3089
  */
2197
3090
  export interface LargeTimestampGaps {
2198
3091
  /**
3092
+ * @public
2199
3093
  * <p> Indicates whether there is a potential data issue related to large gaps in timestamps.
2200
3094
  * </p>
2201
3095
  */
2202
3096
  Status: StatisticalIssueStatus | string | undefined;
2203
3097
  /**
3098
+ * @public
2204
3099
  * <p> Indicates the number of large timestamp gaps, if there are any. </p>
2205
3100
  */
2206
3101
  NumberOfLargeTimestampGaps?: number;
2207
3102
  /**
3103
+ * @public
2208
3104
  * <p> Indicates the size of the largest timestamp gap, in days. </p>
2209
3105
  */
2210
3106
  MaxTimestampGapInDays?: number;
@@ -2228,11 +3124,13 @@ export type Monotonicity = (typeof Monotonicity)[keyof typeof Monotonicity];
2228
3124
  */
2229
3125
  export interface MonotonicValues {
2230
3126
  /**
3127
+ * @public
2231
3128
  * <p> Indicates whether there is a potential data issue related to having monotonic values.
2232
3129
  * </p>
2233
3130
  */
2234
3131
  Status: StatisticalIssueStatus | string | undefined;
2235
3132
  /**
3133
+ * @public
2236
3134
  * <p> Indicates the monotonicity of values. Can be INCREASING, DECREASING, or STATIC. </p>
2237
3135
  */
2238
3136
  Monotonicity?: Monotonicity | string;
@@ -2243,6 +3141,7 @@ export interface MonotonicValues {
2243
3141
  */
2244
3142
  export interface MultipleOperatingModes {
2245
3143
  /**
3144
+ * @public
2246
3145
  * <p> Indicates whether there is a potential data issue related to having multiple operating
2247
3146
  * modes. </p>
2248
3147
  */
@@ -2255,65 +3154,78 @@ export interface MultipleOperatingModes {
2255
3154
  */
2256
3155
  export interface SensorStatisticsSummary {
2257
3156
  /**
3157
+ * @public
2258
3158
  * <p> Name of the component to which the particular sensor belongs for which the statistics
2259
3159
  * belong to. </p>
2260
3160
  */
2261
3161
  ComponentName?: string;
2262
3162
  /**
3163
+ * @public
2263
3164
  * <p> Name of the sensor that the statistics belong to. </p>
2264
3165
  */
2265
3166
  SensorName?: string;
2266
3167
  /**
3168
+ * @public
2267
3169
  * <p> Parameter that indicates whether data exists for the sensor that the statistics belong
2268
3170
  * to. </p>
2269
3171
  */
2270
3172
  DataExists?: boolean;
2271
3173
  /**
3174
+ * @public
2272
3175
  * <p> Parameter that describes the total number of, and percentage of, values that are
2273
3176
  * missing for the sensor that the statistics belong to. </p>
2274
3177
  */
2275
3178
  MissingValues?: CountPercent;
2276
3179
  /**
3180
+ * @public
2277
3181
  * <p> Parameter that describes the total number of, and percentage of, values that are
2278
3182
  * invalid for the sensor that the statistics belong to. </p>
2279
3183
  */
2280
3184
  InvalidValues?: CountPercent;
2281
3185
  /**
3186
+ * @public
2282
3187
  * <p> Parameter that describes the total number of invalid date entries associated with the
2283
3188
  * sensor that the statistics belong to. </p>
2284
3189
  */
2285
3190
  InvalidDateEntries?: CountPercent;
2286
3191
  /**
3192
+ * @public
2287
3193
  * <p> Parameter that describes the total number of duplicate timestamp records associated
2288
3194
  * with the sensor that the statistics belong to. </p>
2289
3195
  */
2290
3196
  DuplicateTimestamps?: CountPercent;
2291
3197
  /**
3198
+ * @public
2292
3199
  * <p> Parameter that describes potential risk about whether data associated with the sensor
2293
3200
  * is categorical. </p>
2294
3201
  */
2295
3202
  CategoricalValues?: CategoricalValues;
2296
3203
  /**
3204
+ * @public
2297
3205
  * <p> Parameter that describes potential risk about whether data associated with the sensor
2298
3206
  * has more than one operating mode. </p>
2299
3207
  */
2300
3208
  MultipleOperatingModes?: MultipleOperatingModes;
2301
3209
  /**
3210
+ * @public
2302
3211
  * <p> Parameter that describes potential risk about whether data associated with the sensor
2303
3212
  * contains one or more large gaps between consecutive timestamps. </p>
2304
3213
  */
2305
3214
  LargeTimestampGaps?: LargeTimestampGaps;
2306
3215
  /**
3216
+ * @public
2307
3217
  * <p> Parameter that describes potential risk about whether data associated with the sensor
2308
3218
  * is mostly monotonic. </p>
2309
3219
  */
2310
3220
  MonotonicValues?: MonotonicValues;
2311
3221
  /**
3222
+ * @public
2312
3223
  * <p> Indicates the time reference to indicate the beginning of valid data associated with
2313
3224
  * the sensor that the statistics belong to. </p>
2314
3225
  */
2315
3226
  DataStartTime?: Date;
2316
3227
  /**
3228
+ * @public
2317
3229
  * <p> Indicates the time reference to indicate the end of valid data associated with the
2318
3230
  * sensor that the statistics belong to. </p>
2319
3231
  */
@@ -2324,12 +3236,14 @@ export interface SensorStatisticsSummary {
2324
3236
  */
2325
3237
  export interface ListSensorStatisticsResponse {
2326
3238
  /**
3239
+ * @public
2327
3240
  * <p>Provides ingestion-based statistics regarding the specified sensor with respect to
2328
3241
  * various validation types, such as whether data exists, the number and percentage of missing
2329
3242
  * values, and the number and percentage of duplicate timestamps. </p>
2330
3243
  */
2331
3244
  SensorStatisticsSummaries?: SensorStatisticsSummary[];
2332
3245
  /**
3246
+ * @public
2333
3247
  * <p>An opaque pagination token indicating where to continue the listing of sensor
2334
3248
  * statistics. </p>
2335
3249
  */
@@ -2340,6 +3254,7 @@ export interface ListSensorStatisticsResponse {
2340
3254
  */
2341
3255
  export interface ListTagsForResourceRequest {
2342
3256
  /**
3257
+ * @public
2343
3258
  * <p>The Amazon Resource Name (ARN) of the resource (such as the dataset or model) that is
2344
3259
  * the focus of the <code>ListTagsForResource</code> operation. </p>
2345
3260
  */
@@ -2350,29 +3265,78 @@ export interface ListTagsForResourceRequest {
2350
3265
  */
2351
3266
  export interface ListTagsForResourceResponse {
2352
3267
  /**
3268
+ * @public
2353
3269
  * <p> Any tags associated with the resource. </p>
2354
3270
  */
2355
3271
  Tags?: Tag[];
2356
3272
  }
3273
+ /**
3274
+ * @public
3275
+ */
3276
+ export interface PutResourcePolicyRequest {
3277
+ /**
3278
+ * @public
3279
+ * <p>The Amazon Resource Name (ARN) of the resource for which the
3280
+ * policy is being created.</p>
3281
+ */
3282
+ ResourceArn: string | undefined;
3283
+ /**
3284
+ * @public
3285
+ * <p>The JSON-formatted resource policy to create.</p>
3286
+ */
3287
+ ResourcePolicy: string | undefined;
3288
+ /**
3289
+ * @public
3290
+ * <p>A unique identifier for a revision of the resource policy.</p>
3291
+ */
3292
+ PolicyRevisionId?: string;
3293
+ /**
3294
+ * @public
3295
+ * <p>A unique identifier for the request.
3296
+ * If you do not set the client request token, Amazon Lookout for Equipment
3297
+ * generates one. </p>
3298
+ */
3299
+ ClientToken?: string;
3300
+ }
3301
+ /**
3302
+ * @public
3303
+ */
3304
+ export interface PutResourcePolicyResponse {
3305
+ /**
3306
+ * @public
3307
+ * <p>The Amazon Resource Name (ARN) of the resource for which the
3308
+ * policy was created.</p>
3309
+ */
3310
+ ResourceArn?: string;
3311
+ /**
3312
+ * @public
3313
+ * <p>A unique identifier for a revision of the resource policy.</p>
3314
+ */
3315
+ PolicyRevisionId?: string;
3316
+ }
2357
3317
  /**
2358
3318
  * @public
2359
3319
  */
2360
3320
  export interface StartDataIngestionJobRequest {
2361
3321
  /**
3322
+ * @public
2362
3323
  * <p>The name of the dataset being used by the data ingestion job. </p>
2363
3324
  */
2364
3325
  DatasetName: string | undefined;
2365
3326
  /**
3327
+ * @public
2366
3328
  * <p> Specifies information for the input data for the data ingestion job, including dataset
2367
3329
  * S3 location. </p>
2368
3330
  */
2369
3331
  IngestionInputConfiguration: IngestionInputConfiguration | undefined;
2370
3332
  /**
3333
+ * @public
2371
3334
  * <p> The Amazon Resource Name (ARN) of a role with permission to access the data source for
2372
3335
  * the data ingestion job. </p>
2373
3336
  */
2374
3337
  RoleArn: string | undefined;
2375
3338
  /**
3339
+ * @public
2376
3340
  * <p> A unique identifier for the request. If you do not set the client request token, Amazon
2377
3341
  * Lookout for Equipment generates one. </p>
2378
3342
  */
@@ -2383,10 +3347,12 @@ export interface StartDataIngestionJobRequest {
2383
3347
  */
2384
3348
  export interface StartDataIngestionJobResponse {
2385
3349
  /**
3350
+ * @public
2386
3351
  * <p>Indicates the job ID of the data ingestion job. </p>
2387
3352
  */
2388
3353
  JobId?: string;
2389
3354
  /**
3355
+ * @public
2390
3356
  * <p>Indicates the status of the <code>StartDataIngestionJob</code> operation. </p>
2391
3357
  */
2392
3358
  Status?: IngestionJobStatus | string;
@@ -2396,6 +3362,7 @@ export interface StartDataIngestionJobResponse {
2396
3362
  */
2397
3363
  export interface StartInferenceSchedulerRequest {
2398
3364
  /**
3365
+ * @public
2399
3366
  * <p>The name of the inference scheduler to be started. </p>
2400
3367
  */
2401
3368
  InferenceSchedulerName: string | undefined;
@@ -2405,23 +3372,28 @@ export interface StartInferenceSchedulerRequest {
2405
3372
  */
2406
3373
  export interface StartInferenceSchedulerResponse {
2407
3374
  /**
3375
+ * @public
2408
3376
  * <p>The Amazon Resource Name (ARN) of the ML model being used by the inference scheduler.
2409
3377
  * </p>
2410
3378
  */
2411
3379
  ModelArn?: string;
2412
3380
  /**
3381
+ * @public
2413
3382
  * <p>The name of the ML model being used by the inference scheduler. </p>
2414
3383
  */
2415
3384
  ModelName?: string;
2416
3385
  /**
3386
+ * @public
2417
3387
  * <p>The name of the inference scheduler being started. </p>
2418
3388
  */
2419
3389
  InferenceSchedulerName?: string;
2420
3390
  /**
3391
+ * @public
2421
3392
  * <p>The Amazon Resource Name (ARN) of the inference scheduler being started. </p>
2422
3393
  */
2423
3394
  InferenceSchedulerArn?: string;
2424
3395
  /**
3396
+ * @public
2425
3397
  * <p>Indicates the status of the inference scheduler. </p>
2426
3398
  */
2427
3399
  Status?: InferenceSchedulerStatus | string;
@@ -2431,6 +3403,7 @@ export interface StartInferenceSchedulerResponse {
2431
3403
  */
2432
3404
  export interface StopInferenceSchedulerRequest {
2433
3405
  /**
3406
+ * @public
2434
3407
  * <p>The name of the inference scheduler to be stopped. </p>
2435
3408
  */
2436
3409
  InferenceSchedulerName: string | undefined;
@@ -2440,23 +3413,28 @@ export interface StopInferenceSchedulerRequest {
2440
3413
  */
2441
3414
  export interface StopInferenceSchedulerResponse {
2442
3415
  /**
3416
+ * @public
2443
3417
  * <p>The Amazon Resource Name (ARN) of the ML model used by the inference scheduler being
2444
3418
  * stopped. </p>
2445
3419
  */
2446
3420
  ModelArn?: string;
2447
3421
  /**
3422
+ * @public
2448
3423
  * <p>The name of the ML model used by the inference scheduler being stopped. </p>
2449
3424
  */
2450
3425
  ModelName?: string;
2451
3426
  /**
3427
+ * @public
2452
3428
  * <p>The name of the inference scheduler being stopped. </p>
2453
3429
  */
2454
3430
  InferenceSchedulerName?: string;
2455
3431
  /**
3432
+ * @public
2456
3433
  * <p>The Amazon Resource Name (ARN) of the inference schedule being stopped. </p>
2457
3434
  */
2458
3435
  InferenceSchedulerArn?: string;
2459
3436
  /**
3437
+ * @public
2460
3438
  * <p>Indicates the status of the inference scheduler. </p>
2461
3439
  */
2462
3440
  Status?: InferenceSchedulerStatus | string;
@@ -2466,11 +3444,13 @@ export interface StopInferenceSchedulerResponse {
2466
3444
  */
2467
3445
  export interface TagResourceRequest {
2468
3446
  /**
3447
+ * @public
2469
3448
  * <p>The Amazon Resource Name (ARN) of the specific resource to which the tag should be
2470
3449
  * associated. </p>
2471
3450
  */
2472
3451
  ResourceArn: string | undefined;
2473
3452
  /**
3453
+ * @public
2474
3454
  * <p>The tag or tags to be associated with a specific resource. Both the tag key and value
2475
3455
  * are specified. </p>
2476
3456
  */
@@ -2486,11 +3466,13 @@ export interface TagResourceResponse {
2486
3466
  */
2487
3467
  export interface UntagResourceRequest {
2488
3468
  /**
3469
+ * @public
2489
3470
  * <p>The Amazon Resource Name (ARN) of the resource to which the tag is currently associated.
2490
3471
  * </p>
2491
3472
  */
2492
3473
  ResourceArn: string | undefined;
2493
3474
  /**
3475
+ * @public
2494
3476
  * <p>Specifies the key of the tag to be removed from a specified resource. </p>
2495
3477
  */
2496
3478
  TagKeys: string[] | undefined;
@@ -2500,15 +3482,74 @@ export interface UntagResourceRequest {
2500
3482
  */
2501
3483
  export interface UntagResourceResponse {
2502
3484
  }
3485
+ /**
3486
+ * @public
3487
+ */
3488
+ export interface UpdateActiveModelVersionRequest {
3489
+ /**
3490
+ * @public
3491
+ * <p>The name of the machine learning model for which the active model version
3492
+ * is being set.</p>
3493
+ */
3494
+ ModelName: string | undefined;
3495
+ /**
3496
+ * @public
3497
+ * <p>The version of the machine learning model for which the active model version
3498
+ * is being set.</p>
3499
+ */
3500
+ ModelVersion: number | undefined;
3501
+ }
3502
+ /**
3503
+ * @public
3504
+ */
3505
+ export interface UpdateActiveModelVersionResponse {
3506
+ /**
3507
+ * @public
3508
+ * <p>The name of the machine learning model for which the active model version was set.</p>
3509
+ */
3510
+ ModelName?: string;
3511
+ /**
3512
+ * @public
3513
+ * <p>The Amazon Resource Name (ARN) of the machine learning model for which
3514
+ * the active model version was set.</p>
3515
+ */
3516
+ ModelArn?: string;
3517
+ /**
3518
+ * @public
3519
+ * <p>The version that is currently active of the machine learning model
3520
+ * for which the active model version was set.</p>
3521
+ */
3522
+ CurrentActiveVersion?: number;
3523
+ /**
3524
+ * @public
3525
+ * <p>The previous version that was active of the machine learning model
3526
+ * for which the active model version was set.</p>
3527
+ */
3528
+ PreviousActiveVersion?: number;
3529
+ /**
3530
+ * @public
3531
+ * <p>The Amazon Resource Name (ARN) of the machine learning model version that is the
3532
+ * current active model version.</p>
3533
+ */
3534
+ CurrentActiveVersionArn?: string;
3535
+ /**
3536
+ * @public
3537
+ * <p>The Amazon Resource Name (ARN) of the machine learning model version that was the
3538
+ * previous active model version.</p>
3539
+ */
3540
+ PreviousActiveVersionArn?: string;
3541
+ }
2503
3542
  /**
2504
3543
  * @public
2505
3544
  */
2506
3545
  export interface UpdateInferenceSchedulerRequest {
2507
3546
  /**
3547
+ * @public
2508
3548
  * <p>The name of the inference scheduler to be updated. </p>
2509
3549
  */
2510
3550
  InferenceSchedulerName: string | undefined;
2511
3551
  /**
3552
+ * @public
2512
3553
  * <p> A period of time (in minutes) by which inference on the data is delayed after the data
2513
3554
  * starts. For instance, if you select an offset delay time of five minutes, inference will
2514
3555
  * not begin on the data until the first data measurement after the five minute mark. For
@@ -2519,6 +3560,7 @@ export interface UpdateInferenceSchedulerRequest {
2519
3560
  */
2520
3561
  DataDelayOffsetInMinutes?: number;
2521
3562
  /**
3563
+ * @public
2522
3564
  * <p>How often data is uploaded to the source S3 bucket for the input data. The value chosen
2523
3565
  * is the length of time between data uploads. For instance, if you select 5 minutes, Amazon
2524
3566
  * Lookout for Equipment will upload the real-time data to the source bucket once every 5
@@ -2527,16 +3569,19 @@ export interface UpdateInferenceSchedulerRequest {
2527
3569
  */
2528
3570
  DataUploadFrequency?: DataUploadFrequency | string;
2529
3571
  /**
3572
+ * @public
2530
3573
  * <p> Specifies information for the input data for the inference scheduler, including
2531
3574
  * delimiter, format, and dataset location. </p>
2532
3575
  */
2533
3576
  DataInputConfiguration?: InferenceInputConfiguration;
2534
3577
  /**
3578
+ * @public
2535
3579
  * <p> Specifies information for the output results from the inference scheduler, including
2536
3580
  * the output S3 location. </p>
2537
3581
  */
2538
3582
  DataOutputConfiguration?: InferenceOutputConfiguration;
2539
3583
  /**
3584
+ * @public
2540
3585
  * <p> The Amazon Resource Name (ARN) of a role with permission to access the data source for
2541
3586
  * the inference scheduler. </p>
2542
3587
  */
@@ -2547,15 +3592,17 @@ export interface UpdateInferenceSchedulerRequest {
2547
3592
  */
2548
3593
  export interface UpdateLabelGroupRequest {
2549
3594
  /**
3595
+ * @public
2550
3596
  * <p>
2551
- * The name of the label group to be updated.
2552
- * </p>
3597
+ * The name of the label group to be updated.
3598
+ * </p>
2553
3599
  */
2554
3600
  LabelGroupName: string | undefined;
2555
3601
  /**
3602
+ * @public
2556
3603
  * <p>
2557
- * Updates the code indicating the type of anomaly associated with the label.
2558
- * </p>
3604
+ * Updates the code indicating the type of anomaly associated with the label.
3605
+ * </p>
2559
3606
  * <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.</p>
2560
3607
  */
2561
3608
  FaultCodes?: string[];