@aws-sdk/client-lookoutequipment 3.410.0 → 3.414.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +64 -0
- package/dist-cjs/LookoutEquipment.js +16 -0
- package/dist-cjs/commands/CreateRetrainingSchedulerCommand.js +46 -0
- package/dist-cjs/commands/DeleteRetrainingSchedulerCommand.js +46 -0
- package/dist-cjs/commands/DescribeRetrainingSchedulerCommand.js +46 -0
- package/dist-cjs/commands/ListRetrainingSchedulersCommand.js +46 -0
- package/dist-cjs/commands/StartRetrainingSchedulerCommand.js +46 -0
- package/dist-cjs/commands/StopRetrainingSchedulerCommand.js +46 -0
- package/dist-cjs/commands/UpdateModelCommand.js +46 -0
- package/dist-cjs/commands/UpdateRetrainingSchedulerCommand.js +46 -0
- package/dist-cjs/commands/index.js +8 -0
- package/dist-cjs/models/models_0.js +28 -6
- package/dist-cjs/pagination/ListRetrainingSchedulersPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +1 -0
- package/dist-cjs/protocols/Aws_json1_0.js +502 -2
- package/dist-cjs/runtimeExtensions.js +3 -0
- package/dist-es/LookoutEquipment.js +16 -0
- package/dist-es/commands/CreateRetrainingSchedulerCommand.js +42 -0
- package/dist-es/commands/DeleteRetrainingSchedulerCommand.js +42 -0
- package/dist-es/commands/DescribeRetrainingSchedulerCommand.js +42 -0
- package/dist-es/commands/ListRetrainingSchedulersCommand.js +42 -0
- package/dist-es/commands/StartRetrainingSchedulerCommand.js +42 -0
- package/dist-es/commands/StopRetrainingSchedulerCommand.js +42 -0
- package/dist-es/commands/UpdateModelCommand.js +42 -0
- package/dist-es/commands/UpdateRetrainingSchedulerCommand.js +42 -0
- package/dist-es/commands/index.js +8 -0
- package/dist-es/models/models_0.js +27 -5
- package/dist-es/pagination/ListRetrainingSchedulersPaginator.js +25 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_json1_0.js +484 -0
- package/dist-es/runtimeExtensions.js +3 -0
- package/dist-types/LookoutEquipment.d.ts +56 -0
- package/dist-types/LookoutEquipmentClient.d.ts +10 -2
- package/dist-types/commands/CreateDatasetCommand.d.ts +2 -2
- package/dist-types/commands/CreateInferenceSchedulerCommand.d.ts +2 -2
- package/dist-types/commands/CreateLabelCommand.d.ts +3 -5
- package/dist-types/commands/CreateLabelGroupCommand.d.ts +3 -5
- package/dist-types/commands/CreateModelCommand.d.ts +7 -7
- package/dist-types/commands/CreateRetrainingSchedulerCommand.d.ts +147 -0
- package/dist-types/commands/DeleteDatasetCommand.d.ts +2 -2
- package/dist-types/commands/DeleteInferenceSchedulerCommand.d.ts +4 -4
- package/dist-types/commands/DeleteLabelCommand.d.ts +3 -5
- package/dist-types/commands/DeleteLabelGroupCommand.d.ts +3 -5
- package/dist-types/commands/DeleteModelCommand.d.ts +4 -5
- package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +2 -2
- package/dist-types/commands/DeleteRetrainingSchedulerCommand.d.ts +106 -0
- package/dist-types/commands/DescribeDataIngestionJobCommand.d.ts +2 -2
- package/dist-types/commands/DescribeDatasetCommand.d.ts +2 -2
- package/dist-types/commands/DescribeInferenceSchedulerCommand.d.ts +2 -2
- package/dist-types/commands/DescribeLabelCommand.d.ts +3 -5
- package/dist-types/commands/DescribeLabelGroupCommand.d.ts +3 -5
- package/dist-types/commands/DescribeModelCommand.d.ts +15 -5
- package/dist-types/commands/DescribeModelVersionCommand.d.ts +6 -2
- package/dist-types/commands/DescribeResourcePolicyCommand.d.ts +2 -2
- package/dist-types/commands/DescribeRetrainingSchedulerCommand.d.ts +125 -0
- package/dist-types/commands/ImportDatasetCommand.d.ts +2 -2
- package/dist-types/commands/ImportModelVersionCommand.d.ts +3 -2
- package/dist-types/commands/ListDataIngestionJobsCommand.d.ts +2 -2
- package/dist-types/commands/ListDatasetsCommand.d.ts +2 -2
- package/dist-types/commands/ListInferenceEventsCommand.d.ts +2 -2
- package/dist-types/commands/ListInferenceExecutionsCommand.d.ts +4 -2
- package/dist-types/commands/ListInferenceSchedulersCommand.d.ts +2 -2
- package/dist-types/commands/ListLabelGroupsCommand.d.ts +3 -5
- package/dist-types/commands/ListLabelsCommand.d.ts +3 -5
- package/dist-types/commands/ListModelVersionsCommand.d.ts +5 -5
- package/dist-types/commands/ListModelsCommand.d.ts +7 -2
- package/dist-types/commands/ListRetrainingSchedulersCommand.d.ts +143 -0
- package/dist-types/commands/ListSensorStatisticsCommand.d.ts +2 -2
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -2
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +2 -2
- package/dist-types/commands/StartDataIngestionJobCommand.d.ts +3 -4
- package/dist-types/commands/StartInferenceSchedulerCommand.d.ts +2 -2
- package/dist-types/commands/StartRetrainingSchedulerCommand.d.ts +116 -0
- package/dist-types/commands/StopInferenceSchedulerCommand.d.ts +2 -2
- package/dist-types/commands/StopRetrainingSchedulerCommand.d.ts +116 -0
- package/dist-types/commands/TagResourceCommand.d.ts +6 -6
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UpdateActiveModelVersionCommand.d.ts +2 -2
- package/dist-types/commands/UpdateInferenceSchedulerCommand.d.ts +2 -2
- package/dist-types/commands/UpdateLabelGroupCommand.d.ts +3 -5
- package/dist-types/commands/UpdateModelCommand.d.ts +116 -0
- package/dist-types/commands/UpdateRetrainingSchedulerCommand.d.ts +111 -0
- package/dist-types/commands/index.d.ts +8 -0
- package/dist-types/extensionConfiguration.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +895 -433
- package/dist-types/pagination/ListRetrainingSchedulersPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_json1_0.d.ts +72 -0
- package/dist-types/ts3.4/LookoutEquipment.d.ts +136 -0
- package/dist-types/ts3.4/LookoutEquipmentClient.d.ts +50 -2
- package/dist-types/ts3.4/commands/CreateRetrainingSchedulerCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteRetrainingSchedulerCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DescribeRetrainingSchedulerCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListRetrainingSchedulersCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/StartRetrainingSchedulerCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/StopRetrainingSchedulerCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateModelCommand.d.ts +33 -0
- package/dist-types/ts3.4/commands/UpdateRetrainingSchedulerCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +8 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +3 -1
- package/dist-types/ts3.4/models/models_0.d.ts +137 -9
- package/dist-types/ts3.4/pagination/ListRetrainingSchedulersPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +96 -0
- package/package.json +29 -28
|
@@ -14,6 +14,21 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
14
14
|
*/
|
|
15
15
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
16
16
|
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
* @enum
|
|
20
|
+
*/
|
|
21
|
+
export declare const AutoPromotionResult: {
|
|
22
|
+
readonly MODEL_NOT_PROMOTED: "MODEL_NOT_PROMOTED";
|
|
23
|
+
readonly MODEL_PROMOTED: "MODEL_PROMOTED";
|
|
24
|
+
readonly RETRAINING_CANCELLED: "RETRAINING_CANCELLED";
|
|
25
|
+
readonly RETRAINING_CUSTOMER_ERROR: "RETRAINING_CUSTOMER_ERROR";
|
|
26
|
+
readonly RETRAINING_INTERNAL_ERROR: "RETRAINING_INTERNAL_ERROR";
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* @public
|
|
30
|
+
*/
|
|
31
|
+
export type AutoPromotionResult = (typeof AutoPromotionResult)[keyof typeof AutoPromotionResult];
|
|
17
32
|
/**
|
|
18
33
|
* @public
|
|
19
34
|
* <p> The request could not be completed due to a conflict with the current state of the
|
|
@@ -35,8 +50,7 @@ export declare class ConflictException extends __BaseException {
|
|
|
35
50
|
export interface DatasetSchema {
|
|
36
51
|
/**
|
|
37
52
|
* @public
|
|
38
|
-
* <p>
|
|
39
|
-
* </p>
|
|
53
|
+
* <p>The data schema used within the given dataset.</p>
|
|
40
54
|
*/
|
|
41
55
|
InlineDataSchema?: __LazyJsonString | string;
|
|
42
56
|
}
|
|
@@ -165,8 +179,8 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
165
179
|
}
|
|
166
180
|
/**
|
|
167
181
|
* @public
|
|
168
|
-
* <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a
|
|
169
|
-
*
|
|
182
|
+
* <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services
|
|
183
|
+
* service that's being utilized. </p>
|
|
170
184
|
*/
|
|
171
185
|
export declare class ValidationException extends __BaseException {
|
|
172
186
|
readonly name: "ValidationException";
|
|
@@ -293,8 +307,8 @@ export type DataUploadFrequency = (typeof DataUploadFrequency)[keyof typeof Data
|
|
|
293
307
|
export interface CreateInferenceSchedulerRequest {
|
|
294
308
|
/**
|
|
295
309
|
* @public
|
|
296
|
-
* <p>The name of the previously trained
|
|
297
|
-
* scheduler. </p>
|
|
310
|
+
* <p>The name of the previously trained machine learning model being used to create the
|
|
311
|
+
* inference scheduler. </p>
|
|
298
312
|
*/
|
|
299
313
|
ModelName: string | undefined;
|
|
300
314
|
/**
|
|
@@ -305,19 +319,24 @@ export interface CreateInferenceSchedulerRequest {
|
|
|
305
319
|
/**
|
|
306
320
|
* @public
|
|
307
321
|
* <p>The interval (in minutes) of planned delay at the start of each inference segment. For
|
|
308
|
-
* example, if inference is set to run every ten minutes, the delay is set to five minutes and
|
|
309
|
-
*
|
|
310
|
-
*
|
|
311
|
-
*
|
|
312
|
-
*
|
|
322
|
+
* example, if inference is set to run every ten minutes, the delay is set to five minutes and
|
|
323
|
+
* the time is 09:08. The inference scheduler will wake up at the configured interval (which,
|
|
324
|
+
* without a delay configured, would be 09:10) plus the additional five minute delay time (so
|
|
325
|
+
* 09:15) to check your Amazon S3 bucket. The delay provides a buffer for you to upload data at the
|
|
326
|
+
* same frequency, so that you don't have to stop and restart the scheduler when uploading new
|
|
327
|
+
* data.</p>
|
|
328
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-inference-process.html">Understanding
|
|
329
|
+
* the inference process</a>.</p>
|
|
313
330
|
*/
|
|
314
331
|
DataDelayOffsetInMinutes?: number;
|
|
315
332
|
/**
|
|
316
333
|
* @public
|
|
317
|
-
* <p> How often data is uploaded to the source Amazon S3 bucket for the input data. The value
|
|
318
|
-
* is the length of time between data uploads. For instance, if you select 5 minutes,
|
|
319
|
-
*
|
|
320
|
-
*
|
|
334
|
+
* <p> How often data is uploaded to the source Amazon S3 bucket for the input data. The value
|
|
335
|
+
* chosen is the length of time between data uploads. For instance, if you select 5 minutes,
|
|
336
|
+
* Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This
|
|
337
|
+
* frequency also determines how often Amazon Lookout for Equipment runs inference on your data.</p>
|
|
338
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-inference-process.html">Understanding
|
|
339
|
+
* the inference process</a>.</p>
|
|
321
340
|
*/
|
|
322
341
|
DataUploadFrequency: DataUploadFrequency | string | undefined;
|
|
323
342
|
/**
|
|
@@ -423,62 +442,52 @@ export type LabelRating = (typeof LabelRating)[keyof typeof LabelRating];
|
|
|
423
442
|
export interface CreateLabelRequest {
|
|
424
443
|
/**
|
|
425
444
|
* @public
|
|
426
|
-
* <p>
|
|
427
|
-
*
|
|
428
|
-
*
|
|
429
|
-
* </p>
|
|
445
|
+
* <p> The name of a group of labels. </p>
|
|
446
|
+
* <p>Data in this field will be retained for service usage. Follow best practices for the
|
|
447
|
+
* security of your data. </p>
|
|
430
448
|
*/
|
|
431
449
|
LabelGroupName: string | undefined;
|
|
432
450
|
/**
|
|
433
451
|
* @public
|
|
434
|
-
* <p>
|
|
435
|
-
* The start time of the labeled event.
|
|
436
|
-
* </p>
|
|
452
|
+
* <p> The start time of the labeled event. </p>
|
|
437
453
|
*/
|
|
438
454
|
StartTime: Date | undefined;
|
|
439
455
|
/**
|
|
440
456
|
* @public
|
|
441
|
-
* <p>
|
|
442
|
-
* The end time of the labeled event.
|
|
443
|
-
* </p>
|
|
457
|
+
* <p> The end time of the labeled event. </p>
|
|
444
458
|
*/
|
|
445
459
|
EndTime: Date | undefined;
|
|
446
460
|
/**
|
|
447
461
|
* @public
|
|
448
|
-
* <p>
|
|
449
|
-
* Indicates whether a labeled event represents an anomaly.
|
|
450
|
-
* </p>
|
|
462
|
+
* <p> Indicates whether a labeled event represents an anomaly. </p>
|
|
451
463
|
*/
|
|
452
464
|
Rating: LabelRating | string | undefined;
|
|
453
465
|
/**
|
|
454
466
|
* @public
|
|
455
|
-
* <p>
|
|
456
|
-
*
|
|
457
|
-
* <p>Data in this field will be retained for service usage. Follow best practices for the
|
|
458
|
-
*
|
|
467
|
+
* <p> Provides additional information about the label. The fault code must be defined in the
|
|
468
|
+
* FaultCodes attribute of the label group.</p>
|
|
469
|
+
* <p>Data in this field will be retained for service usage. Follow best practices for the
|
|
470
|
+
* security of your data. </p>
|
|
459
471
|
*/
|
|
460
472
|
FaultCode?: string;
|
|
461
473
|
/**
|
|
462
474
|
* @public
|
|
463
|
-
* <p>
|
|
464
|
-
*
|
|
465
|
-
*
|
|
466
|
-
* <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.</p>
|
|
475
|
+
* <p> Metadata providing additional information about the label. </p>
|
|
476
|
+
* <p>Data in this field will be retained for service usage. Follow best practices for the
|
|
477
|
+
* security of your data.</p>
|
|
467
478
|
*/
|
|
468
479
|
Notes?: string;
|
|
469
480
|
/**
|
|
470
481
|
* @public
|
|
471
|
-
* <p>
|
|
472
|
-
*
|
|
473
|
-
*
|
|
474
|
-
* <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.</p>
|
|
482
|
+
* <p> Indicates that a label pertains to a particular piece of equipment. </p>
|
|
483
|
+
* <p>Data in this field will be retained for service usage. Follow best practices for the
|
|
484
|
+
* security of your data.</p>
|
|
475
485
|
*/
|
|
476
486
|
Equipment?: string;
|
|
477
487
|
/**
|
|
478
488
|
* @public
|
|
479
|
-
* <p>
|
|
480
|
-
*
|
|
481
|
-
* </p>
|
|
489
|
+
* <p> A unique identifier for the request to create a label. If you do not set the client
|
|
490
|
+
* request token, Lookout for Equipment generates one. </p>
|
|
482
491
|
*/
|
|
483
492
|
ClientToken?: string;
|
|
484
493
|
}
|
|
@@ -488,9 +497,7 @@ export interface CreateLabelRequest {
|
|
|
488
497
|
export interface CreateLabelResponse {
|
|
489
498
|
/**
|
|
490
499
|
* @public
|
|
491
|
-
* <p>
|
|
492
|
-
* The ID of the label that you have created.
|
|
493
|
-
* </p>
|
|
500
|
+
* <p> The ID of the label that you have created. </p>
|
|
494
501
|
*/
|
|
495
502
|
LabelId?: string;
|
|
496
503
|
}
|
|
@@ -500,32 +507,30 @@ export interface CreateLabelResponse {
|
|
|
500
507
|
export interface CreateLabelGroupRequest {
|
|
501
508
|
/**
|
|
502
509
|
* @public
|
|
503
|
-
* <p>
|
|
504
|
-
*
|
|
505
|
-
*
|
|
506
|
-
* </p>
|
|
510
|
+
* <p> Names a group of labels.</p>
|
|
511
|
+
* <p>Data in this field will be retained for service usage. Follow best practices for the
|
|
512
|
+
* security of your data. </p>
|
|
507
513
|
*/
|
|
508
514
|
LabelGroupName: string | undefined;
|
|
509
515
|
/**
|
|
510
516
|
* @public
|
|
511
|
-
* <p>
|
|
512
|
-
*
|
|
513
|
-
* <p>Data in this field will be retained for service usage. Follow best practices for the
|
|
517
|
+
* <p> The acceptable fault codes (indicating the type of anomaly associated with the label)
|
|
518
|
+
* that can be used with this label group.</p>
|
|
519
|
+
* <p>Data in this field will be retained for service usage. Follow best practices for the
|
|
520
|
+
* security of your data.</p>
|
|
514
521
|
*/
|
|
515
522
|
FaultCodes?: string[];
|
|
516
523
|
/**
|
|
517
524
|
* @public
|
|
518
|
-
* <p>
|
|
519
|
-
*
|
|
520
|
-
* </p>
|
|
525
|
+
* <p> A unique identifier for the request to create a label group. If you do not set the
|
|
526
|
+
* client request token, Lookout for Equipment generates one. </p>
|
|
521
527
|
*/
|
|
522
528
|
ClientToken?: string;
|
|
523
529
|
/**
|
|
524
530
|
* @public
|
|
525
|
-
* <p>
|
|
526
|
-
*
|
|
527
|
-
*
|
|
528
|
-
* <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.</p>
|
|
531
|
+
* <p> Tags that provide metadata about the label group you are creating. </p>
|
|
532
|
+
* <p>Data in this field will be retained for service usage. Follow best practices for the
|
|
533
|
+
* security of your data.</p>
|
|
529
534
|
*/
|
|
530
535
|
Tags?: Tag[];
|
|
531
536
|
}
|
|
@@ -535,16 +540,13 @@ export interface CreateLabelGroupRequest {
|
|
|
535
540
|
export interface CreateLabelGroupResponse {
|
|
536
541
|
/**
|
|
537
542
|
* @public
|
|
538
|
-
* <p>
|
|
539
|
-
*
|
|
540
|
-
* </p>
|
|
543
|
+
* <p> The name of the label group that you have created. Data in this field will be retained
|
|
544
|
+
* for service usage. Follow best practices for the security of your data. </p>
|
|
541
545
|
*/
|
|
542
546
|
LabelGroupName?: string;
|
|
543
547
|
/**
|
|
544
548
|
* @public
|
|
545
|
-
* <p>
|
|
546
|
-
* The Amazon Resource Name (ARN) of the label group that you have created.
|
|
547
|
-
* </p>
|
|
549
|
+
* <p> The Amazon Resource Name (ARN) of the label group that you have created. </p>
|
|
548
550
|
*/
|
|
549
551
|
LabelGroupArn?: string;
|
|
550
552
|
}
|
|
@@ -572,10 +574,9 @@ export type TargetSamplingRate = (typeof TargetSamplingRate)[keyof typeof Target
|
|
|
572
574
|
/**
|
|
573
575
|
* @public
|
|
574
576
|
* <p>The configuration is the <code>TargetSamplingRate</code>, which is the sampling rate of
|
|
575
|
-
* the data after post processing by Amazon Lookout for Equipment. For example, if you provide
|
|
576
|
-
*
|
|
577
|
-
*
|
|
578
|
-
* minute.</p>
|
|
577
|
+
* the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been
|
|
578
|
+
* collected at a 1 second level and you want the system to resample the data at a 1 minute
|
|
579
|
+
* rate before training, the <code>TargetSamplingRate</code> is 1 minute.</p>
|
|
579
580
|
* <p>When providing a value for the <code>TargetSamplingRate</code>, you must attach the
|
|
580
581
|
* prefix "PT" to the rate you want. The value for a 1 second rate is therefore
|
|
581
582
|
* <i>PT1S</i>, the value for a 15 minute rate is <i>PT15M</i>,
|
|
@@ -585,10 +586,10 @@ export type TargetSamplingRate = (typeof TargetSamplingRate)[keyof typeof Target
|
|
|
585
586
|
export interface DataPreProcessingConfiguration {
|
|
586
587
|
/**
|
|
587
588
|
* @public
|
|
588
|
-
* <p>The sampling rate of the data after post processing by Amazon Lookout for Equipment. For
|
|
589
|
-
*
|
|
590
|
-
*
|
|
591
|
-
*
|
|
589
|
+
* <p>The sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you
|
|
590
|
+
* provide data that has been collected at a 1 second level and you want the system to
|
|
591
|
+
* resample the data at a 1 minute rate before training, the <code>TargetSamplingRate</code>
|
|
592
|
+
* is 1 minute.</p>
|
|
592
593
|
* <p>When providing a value for the <code>TargetSamplingRate</code>, you must attach the
|
|
593
594
|
* prefix "PT" to the rate you want. The value for a 1 second rate is therefore
|
|
594
595
|
* <i>PT1S</i>, the value for a 15 minute rate is <i>PT15M</i>,
|
|
@@ -627,9 +628,7 @@ export interface LabelsInputConfiguration {
|
|
|
627
628
|
S3InputConfiguration?: LabelsS3InputConfiguration;
|
|
628
629
|
/**
|
|
629
630
|
* @public
|
|
630
|
-
* <p>
|
|
631
|
-
* The name of the label group to be used for label data.
|
|
632
|
-
* </p>
|
|
631
|
+
* <p> The name of the label group to be used for label data. </p>
|
|
633
632
|
*/
|
|
634
633
|
LabelGroupName?: string;
|
|
635
634
|
}
|
|
@@ -639,23 +638,23 @@ export interface LabelsInputConfiguration {
|
|
|
639
638
|
export interface CreateModelRequest {
|
|
640
639
|
/**
|
|
641
640
|
* @public
|
|
642
|
-
* <p>The name for the
|
|
641
|
+
* <p>The name for the machine learning model to be created.</p>
|
|
643
642
|
*/
|
|
644
643
|
ModelName: string | undefined;
|
|
645
644
|
/**
|
|
646
645
|
* @public
|
|
647
|
-
* <p>The name of the dataset for the
|
|
646
|
+
* <p>The name of the dataset for the machine learning model being created. </p>
|
|
648
647
|
*/
|
|
649
648
|
DatasetName: string | undefined;
|
|
650
649
|
/**
|
|
651
650
|
* @public
|
|
652
|
-
* <p>The data schema for the
|
|
651
|
+
* <p>The data schema for the machine learning model being created. </p>
|
|
653
652
|
*/
|
|
654
653
|
DatasetSchema?: DatasetSchema;
|
|
655
654
|
/**
|
|
656
655
|
* @public
|
|
657
|
-
* <p>The input configuration for the labels being used for the
|
|
658
|
-
*
|
|
656
|
+
* <p>The input configuration for the labels being used for the machine learning model that's
|
|
657
|
+
* being created. </p>
|
|
659
658
|
*/
|
|
660
659
|
LabelsInputConfiguration?: LabelsInputConfiguration;
|
|
661
660
|
/**
|
|
@@ -667,40 +666,39 @@ export interface CreateModelRequest {
|
|
|
667
666
|
/**
|
|
668
667
|
* @public
|
|
669
668
|
* <p>Indicates the time reference in the dataset that should be used to begin the subset of
|
|
670
|
-
* training data for the
|
|
669
|
+
* training data for the machine learning model. </p>
|
|
671
670
|
*/
|
|
672
671
|
TrainingDataStartTime?: Date;
|
|
673
672
|
/**
|
|
674
673
|
* @public
|
|
675
674
|
* <p>Indicates the time reference in the dataset that should be used to end the subset of
|
|
676
|
-
* training data for the
|
|
675
|
+
* training data for the machine learning model. </p>
|
|
677
676
|
*/
|
|
678
677
|
TrainingDataEndTime?: Date;
|
|
679
678
|
/**
|
|
680
679
|
* @public
|
|
681
680
|
* <p>Indicates the time reference in the dataset that should be used to begin the subset of
|
|
682
|
-
* evaluation data for the
|
|
681
|
+
* evaluation data for the machine learning model. </p>
|
|
683
682
|
*/
|
|
684
683
|
EvaluationDataStartTime?: Date;
|
|
685
684
|
/**
|
|
686
685
|
* @public
|
|
687
686
|
* <p> Indicates the time reference in the dataset that should be used to end the subset of
|
|
688
|
-
* evaluation data for the
|
|
687
|
+
* evaluation data for the machine learning model. </p>
|
|
689
688
|
*/
|
|
690
689
|
EvaluationDataEndTime?: Date;
|
|
691
690
|
/**
|
|
692
691
|
* @public
|
|
693
692
|
* <p> The Amazon Resource Name (ARN) of a role with permission to access the data source
|
|
694
|
-
* being used to create the
|
|
693
|
+
* being used to create the machine learning model. </p>
|
|
695
694
|
*/
|
|
696
695
|
RoleArn?: string;
|
|
697
696
|
/**
|
|
698
697
|
* @public
|
|
699
698
|
* <p>The configuration is the <code>TargetSamplingRate</code>, which is the sampling rate of
|
|
700
|
-
* the data after post processing by Amazon Lookout for Equipment. For example, if you provide
|
|
701
|
-
*
|
|
702
|
-
*
|
|
703
|
-
* minute.</p>
|
|
699
|
+
* the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been
|
|
700
|
+
* collected at a 1 second level and you want the system to resample the data at a 1 minute
|
|
701
|
+
* rate before training, the <code>TargetSamplingRate</code> is 1 minute.</p>
|
|
704
702
|
* <p>When providing a value for the <code>TargetSamplingRate</code>, you must attach the
|
|
705
703
|
* prefix "PT" to the rate you want. The value for a 1 second rate is therefore
|
|
706
704
|
* <i>PT1S</i>, the value for a 15 minute rate is <i>PT15M</i>,
|
|
@@ -716,7 +714,7 @@ export interface CreateModelRequest {
|
|
|
716
714
|
ServerSideKmsKeyId?: string;
|
|
717
715
|
/**
|
|
718
716
|
* @public
|
|
719
|
-
* <p> Any tags associated with the
|
|
717
|
+
* <p> Any tags associated with the machine learning model being created. </p>
|
|
720
718
|
*/
|
|
721
719
|
Tags?: Tag[];
|
|
722
720
|
/**
|
|
@@ -756,6 +754,106 @@ export interface CreateModelResponse {
|
|
|
756
754
|
*/
|
|
757
755
|
Status?: ModelStatus | string;
|
|
758
756
|
}
|
|
757
|
+
/**
|
|
758
|
+
* @public
|
|
759
|
+
* @enum
|
|
760
|
+
*/
|
|
761
|
+
export declare const ModelPromoteMode: {
|
|
762
|
+
readonly MANAGED: "MANAGED";
|
|
763
|
+
readonly MANUAL: "MANUAL";
|
|
764
|
+
};
|
|
765
|
+
/**
|
|
766
|
+
* @public
|
|
767
|
+
*/
|
|
768
|
+
export type ModelPromoteMode = (typeof ModelPromoteMode)[keyof typeof ModelPromoteMode];
|
|
769
|
+
/**
|
|
770
|
+
* @public
|
|
771
|
+
*/
|
|
772
|
+
export interface CreateRetrainingSchedulerRequest {
|
|
773
|
+
/**
|
|
774
|
+
* @public
|
|
775
|
+
* <p>The name of the model to add the retraining scheduler to. </p>
|
|
776
|
+
*/
|
|
777
|
+
ModelName: string | undefined;
|
|
778
|
+
/**
|
|
779
|
+
* @public
|
|
780
|
+
* <p>The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the
|
|
781
|
+
* nearest UTC day.</p>
|
|
782
|
+
*/
|
|
783
|
+
RetrainingStartDate?: Date;
|
|
784
|
+
/**
|
|
785
|
+
* @public
|
|
786
|
+
* <p>This parameter uses the <a href="https://en.wikipedia.org/wiki/ISO_8601#Durations">ISO 8601</a> standard to set the frequency at which you want retraining to occur in
|
|
787
|
+
* terms of Years, Months, and/or Days (note: other parameters like Time are not currently
|
|
788
|
+
* supported). The minimum value is 30 days (P30D) and the maximum value is 1 year (P1Y). For
|
|
789
|
+
* example, the following values are valid:</p>
|
|
790
|
+
* <ul>
|
|
791
|
+
* <li>
|
|
792
|
+
* <p>P3M15D – Every 3 months and 15 days</p>
|
|
793
|
+
* </li>
|
|
794
|
+
* <li>
|
|
795
|
+
* <p>P2M – Every 2 months</p>
|
|
796
|
+
* </li>
|
|
797
|
+
* <li>
|
|
798
|
+
* <p>P150D – Every 150 days</p>
|
|
799
|
+
* </li>
|
|
800
|
+
* </ul>
|
|
801
|
+
*/
|
|
802
|
+
RetrainingFrequency: string | undefined;
|
|
803
|
+
/**
|
|
804
|
+
* @public
|
|
805
|
+
* <p>The number of past days of data that will be used for retraining.</p>
|
|
806
|
+
*/
|
|
807
|
+
LookbackWindow: string | undefined;
|
|
808
|
+
/**
|
|
809
|
+
* @public
|
|
810
|
+
* <p>Indicates how the service will use new models. In <code>MANAGED</code> mode, new models
|
|
811
|
+
* will automatically be used for inference if they have better performance than the current
|
|
812
|
+
* model. In <code>MANUAL</code> mode, the new models will not be used <a href="https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/versioning-model.html#model-activation">until they
|
|
813
|
+
* are manually activated</a>.</p>
|
|
814
|
+
*/
|
|
815
|
+
PromoteMode?: ModelPromoteMode | string;
|
|
816
|
+
/**
|
|
817
|
+
* @public
|
|
818
|
+
* <p>A unique identifier for the request. If you do not set the client request token, Amazon
|
|
819
|
+
* Lookout for Equipment generates one. </p>
|
|
820
|
+
*/
|
|
821
|
+
ClientToken?: string;
|
|
822
|
+
}
|
|
823
|
+
/**
|
|
824
|
+
* @public
|
|
825
|
+
* @enum
|
|
826
|
+
*/
|
|
827
|
+
export declare const RetrainingSchedulerStatus: {
|
|
828
|
+
readonly PENDING: "PENDING";
|
|
829
|
+
readonly RUNNING: "RUNNING";
|
|
830
|
+
readonly STOPPED: "STOPPED";
|
|
831
|
+
readonly STOPPING: "STOPPING";
|
|
832
|
+
};
|
|
833
|
+
/**
|
|
834
|
+
* @public
|
|
835
|
+
*/
|
|
836
|
+
export type RetrainingSchedulerStatus = (typeof RetrainingSchedulerStatus)[keyof typeof RetrainingSchedulerStatus];
|
|
837
|
+
/**
|
|
838
|
+
* @public
|
|
839
|
+
*/
|
|
840
|
+
export interface CreateRetrainingSchedulerResponse {
|
|
841
|
+
/**
|
|
842
|
+
* @public
|
|
843
|
+
* <p>The name of the model that you added the retraining scheduler to. </p>
|
|
844
|
+
*/
|
|
845
|
+
ModelName?: string;
|
|
846
|
+
/**
|
|
847
|
+
* @public
|
|
848
|
+
* <p>The ARN of the model that you added the retraining scheduler to. </p>
|
|
849
|
+
*/
|
|
850
|
+
ModelArn?: string;
|
|
851
|
+
/**
|
|
852
|
+
* @public
|
|
853
|
+
* <p>The status of the retraining scheduler. </p>
|
|
854
|
+
*/
|
|
855
|
+
Status?: RetrainingSchedulerStatus | string;
|
|
856
|
+
}
|
|
759
857
|
/**
|
|
760
858
|
* @public
|
|
761
859
|
*/
|
|
@@ -782,16 +880,14 @@ export interface DeleteInferenceSchedulerRequest {
|
|
|
782
880
|
export interface DeleteLabelRequest {
|
|
783
881
|
/**
|
|
784
882
|
* @public
|
|
785
|
-
* <p>
|
|
786
|
-
*
|
|
787
|
-
*
|
|
883
|
+
* <p> The name of the label group that contains the label that you want to delete. Data in
|
|
884
|
+
* this field will be retained for service usage. Follow best practices for the security of
|
|
885
|
+
* your data. </p>
|
|
788
886
|
*/
|
|
789
887
|
LabelGroupName: string | undefined;
|
|
790
888
|
/**
|
|
791
889
|
* @public
|
|
792
|
-
* <p>
|
|
793
|
-
* The ID of the label that you want to delete.
|
|
794
|
-
* </p>
|
|
890
|
+
* <p> The ID of the label that you want to delete. </p>
|
|
795
891
|
*/
|
|
796
892
|
LabelId: string | undefined;
|
|
797
893
|
}
|
|
@@ -801,9 +897,8 @@ export interface DeleteLabelRequest {
|
|
|
801
897
|
export interface DeleteLabelGroupRequest {
|
|
802
898
|
/**
|
|
803
899
|
* @public
|
|
804
|
-
* <p>
|
|
805
|
-
*
|
|
806
|
-
* </p>
|
|
900
|
+
* <p> The name of the label group that you want to delete. Data in this field will be
|
|
901
|
+
* retained for service usage. Follow best practices for the security of your data. </p>
|
|
807
902
|
*/
|
|
808
903
|
LabelGroupName: string | undefined;
|
|
809
904
|
}
|
|
@@ -813,7 +908,7 @@ export interface DeleteLabelGroupRequest {
|
|
|
813
908
|
export interface DeleteModelRequest {
|
|
814
909
|
/**
|
|
815
910
|
* @public
|
|
816
|
-
* <p>The name of the
|
|
911
|
+
* <p>The name of the machine learning model to be deleted. </p>
|
|
817
912
|
*/
|
|
818
913
|
ModelName: string | undefined;
|
|
819
914
|
}
|
|
@@ -823,10 +918,21 @@ export interface DeleteModelRequest {
|
|
|
823
918
|
export interface DeleteResourcePolicyRequest {
|
|
824
919
|
/**
|
|
825
920
|
* @public
|
|
826
|
-
* <p>The Amazon Resource Name (ARN) of the resource for which the resource policy should be
|
|
921
|
+
* <p>The Amazon Resource Name (ARN) of the resource for which the resource policy should be
|
|
922
|
+
* deleted.</p>
|
|
827
923
|
*/
|
|
828
924
|
ResourceArn: string | undefined;
|
|
829
925
|
}
|
|
926
|
+
/**
|
|
927
|
+
* @public
|
|
928
|
+
*/
|
|
929
|
+
export interface DeleteRetrainingSchedulerRequest {
|
|
930
|
+
/**
|
|
931
|
+
* @public
|
|
932
|
+
* <p>The name of the model whose retraining scheduler you want to delete. </p>
|
|
933
|
+
*/
|
|
934
|
+
ModelName: string | undefined;
|
|
935
|
+
}
|
|
830
936
|
/**
|
|
831
937
|
* @public
|
|
832
938
|
*/
|
|
@@ -1032,9 +1138,13 @@ export interface IngestionS3InputConfiguration {
|
|
|
1032
1138
|
Prefix?: string;
|
|
1033
1139
|
/**
|
|
1034
1140
|
* @public
|
|
1035
|
-
* <p>
|
|
1036
|
-
*
|
|
1037
|
-
*
|
|
1141
|
+
* <p> The pattern for matching the Amazon S3 files that will be used for ingestion.
|
|
1142
|
+
* If the schema was created previously without any KeyPattern, then the default KeyPattern
|
|
1143
|
+
* \{prefix\}/\{component_name\}/* is used to download files from Amazon S3 according to
|
|
1144
|
+
* the schema. This field is required when ingestion is being done for the first time.</p>
|
|
1145
|
+
* <p>Valid Values: \{prefix\}/\{component_name\}_* | \{prefix\}/\{component_name\}/* |
|
|
1146
|
+
* \{prefix\}/\{component_name\}[DELIMITER]* (Allowed delimiters : space, dot, underscore,
|
|
1147
|
+
* hyphen)</p>
|
|
1038
1148
|
*/
|
|
1039
1149
|
KeyPattern?: string;
|
|
1040
1150
|
}
|
|
@@ -1145,8 +1255,8 @@ export interface DescribeDataIngestionJobResponse {
|
|
|
1145
1255
|
DataEndTime?: Date;
|
|
1146
1256
|
/**
|
|
1147
1257
|
* @public
|
|
1148
|
-
* <p>The Amazon Resource Name (ARN) of the source dataset from which the data
|
|
1149
|
-
*
|
|
1258
|
+
* <p>The Amazon Resource Name (ARN) of the source dataset from which the data used for the
|
|
1259
|
+
* data ingestion job was imported from.</p>
|
|
1150
1260
|
*/
|
|
1151
1261
|
SourceDatasetArn?: string;
|
|
1152
1262
|
}
|
|
@@ -1241,8 +1351,8 @@ export interface DescribeDatasetResponse {
|
|
|
1241
1351
|
DataEndTime?: Date;
|
|
1242
1352
|
/**
|
|
1243
1353
|
* @public
|
|
1244
|
-
* <p>The Amazon Resource Name (ARN) of the source dataset from which the
|
|
1245
|
-
*
|
|
1354
|
+
* <p>The Amazon Resource Name (ARN) of the source dataset from which the current data being
|
|
1355
|
+
* described was imported from.</p>
|
|
1246
1356
|
*/
|
|
1247
1357
|
SourceDatasetArn?: string;
|
|
1248
1358
|
}
|
|
@@ -1274,13 +1384,14 @@ export type LatestInferenceResult = (typeof LatestInferenceResult)[keyof typeof
|
|
|
1274
1384
|
export interface DescribeInferenceSchedulerResponse {
|
|
1275
1385
|
/**
|
|
1276
1386
|
* @public
|
|
1277
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
1278
|
-
* described. </p>
|
|
1387
|
+
* <p>The Amazon Resource Name (ARN) of the machine learning model of the inference scheduler
|
|
1388
|
+
* being described. </p>
|
|
1279
1389
|
*/
|
|
1280
1390
|
ModelArn?: string;
|
|
1281
1391
|
/**
|
|
1282
1392
|
* @public
|
|
1283
|
-
* <p>The name of the
|
|
1393
|
+
* <p>The name of the machine learning model of the inference scheduler being described.
|
|
1394
|
+
* </p>
|
|
1284
1395
|
*/
|
|
1285
1396
|
ModelName?: string;
|
|
1286
1397
|
/**
|
|
@@ -1313,9 +1424,9 @@ export interface DescribeInferenceSchedulerResponse {
|
|
|
1313
1424
|
* @public
|
|
1314
1425
|
* <p>Specifies how often data is uploaded to the source S3 bucket for the input data. This
|
|
1315
1426
|
* value is the length of time between data uploads. For instance, if you select 5 minutes,
|
|
1316
|
-
* Amazon Lookout for Equipment will upload the real-time data to the source bucket once every
|
|
1317
|
-
*
|
|
1318
|
-
*
|
|
1427
|
+
* Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This
|
|
1428
|
+
* frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data. In
|
|
1429
|
+
* this example, it starts once every 5 minutes. </p>
|
|
1319
1430
|
*/
|
|
1320
1431
|
DataUploadFrequency?: DataUploadFrequency | string;
|
|
1321
1432
|
/**
|
|
@@ -1365,16 +1476,12 @@ export interface DescribeInferenceSchedulerResponse {
|
|
|
1365
1476
|
export interface DescribeLabelRequest {
|
|
1366
1477
|
/**
|
|
1367
1478
|
* @public
|
|
1368
|
-
* <p>
|
|
1369
|
-
* Returns the name of the group containing the label.
|
|
1370
|
-
* </p>
|
|
1479
|
+
* <p> Returns the name of the group containing the label. </p>
|
|
1371
1480
|
*/
|
|
1372
1481
|
LabelGroupName: string | undefined;
|
|
1373
1482
|
/**
|
|
1374
1483
|
* @public
|
|
1375
|
-
* <p>
|
|
1376
|
-
* Returns the ID of the label.
|
|
1377
|
-
* </p>
|
|
1484
|
+
* <p> Returns the ID of the label. </p>
|
|
1378
1485
|
*/
|
|
1379
1486
|
LabelId: string | undefined;
|
|
1380
1487
|
}
|
|
@@ -1384,72 +1491,56 @@ export interface DescribeLabelRequest {
|
|
|
1384
1491
|
export interface DescribeLabelResponse {
|
|
1385
1492
|
/**
|
|
1386
1493
|
* @public
|
|
1387
|
-
* <p>
|
|
1388
|
-
* The name of the requested label group.
|
|
1389
|
-
* </p>
|
|
1494
|
+
* <p> The name of the requested label group. </p>
|
|
1390
1495
|
*/
|
|
1391
1496
|
LabelGroupName?: string;
|
|
1392
1497
|
/**
|
|
1393
1498
|
* @public
|
|
1394
|
-
* <p>
|
|
1395
|
-
* The Amazon Resource Name (ARN) of the requested label group.
|
|
1396
|
-
* </p>
|
|
1499
|
+
* <p> The Amazon Resource Name (ARN) of the requested label group. </p>
|
|
1397
1500
|
*/
|
|
1398
1501
|
LabelGroupArn?: string;
|
|
1399
1502
|
/**
|
|
1400
1503
|
* @public
|
|
1401
|
-
* <p>
|
|
1402
|
-
* The ID of the requested label.
|
|
1403
|
-
* </p>
|
|
1504
|
+
* <p> The ID of the requested label. </p>
|
|
1404
1505
|
*/
|
|
1405
1506
|
LabelId?: string;
|
|
1406
1507
|
/**
|
|
1407
1508
|
* @public
|
|
1408
|
-
* <p>
|
|
1409
|
-
* The start time of the requested label.
|
|
1410
|
-
* </p>
|
|
1509
|
+
* <p> The start time of the requested label. </p>
|
|
1411
1510
|
*/
|
|
1412
1511
|
StartTime?: Date;
|
|
1413
1512
|
/**
|
|
1414
1513
|
* @public
|
|
1415
|
-
* <p>
|
|
1416
|
-
* The end time of the requested label.
|
|
1417
|
-
* </p>
|
|
1514
|
+
* <p> The end time of the requested label. </p>
|
|
1418
1515
|
*/
|
|
1419
1516
|
EndTime?: Date;
|
|
1420
1517
|
/**
|
|
1421
1518
|
* @public
|
|
1422
|
-
* <p>
|
|
1423
|
-
* Indicates whether a labeled event represents an anomaly.
|
|
1424
|
-
* </p>
|
|
1519
|
+
* <p> Indicates whether a labeled event represents an anomaly. </p>
|
|
1425
1520
|
*/
|
|
1426
1521
|
Rating?: LabelRating | string;
|
|
1427
1522
|
/**
|
|
1428
1523
|
* @public
|
|
1429
|
-
* <p>
|
|
1430
|
-
*
|
|
1431
|
-
*
|
|
1432
|
-
* <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.</p>
|
|
1524
|
+
* <p> Indicates the type of anomaly associated with the label. </p>
|
|
1525
|
+
* <p>Data in this field will be retained for service usage. Follow best practices for the
|
|
1526
|
+
* security of your data.</p>
|
|
1433
1527
|
*/
|
|
1434
1528
|
FaultCode?: string;
|
|
1435
1529
|
/**
|
|
1436
1530
|
* @public
|
|
1437
1531
|
* <p>Metadata providing additional information about the label.</p>
|
|
1438
|
-
* <p>Data in this field will be retained for service usage. Follow best practices for the
|
|
1532
|
+
* <p>Data in this field will be retained for service usage. Follow best practices for the
|
|
1533
|
+
* security of your data.</p>
|
|
1439
1534
|
*/
|
|
1440
1535
|
Notes?: string;
|
|
1441
1536
|
/**
|
|
1442
1537
|
* @public
|
|
1443
|
-
* <p>
|
|
1444
|
-
* Indicates that a label pertains to a particular piece of equipment.
|
|
1445
|
-
* </p>
|
|
1538
|
+
* <p> Indicates that a label pertains to a particular piece of equipment. </p>
|
|
1446
1539
|
*/
|
|
1447
1540
|
Equipment?: string;
|
|
1448
1541
|
/**
|
|
1449
1542
|
* @public
|
|
1450
|
-
* <p>
|
|
1451
|
-
* The time at which the label was created.
|
|
1452
|
-
* </p>
|
|
1543
|
+
* <p> The time at which the label was created. </p>
|
|
1453
1544
|
*/
|
|
1454
1545
|
CreatedAt?: Date;
|
|
1455
1546
|
}
|
|
@@ -1459,9 +1550,7 @@ export interface DescribeLabelResponse {
|
|
|
1459
1550
|
export interface DescribeLabelGroupRequest {
|
|
1460
1551
|
/**
|
|
1461
1552
|
* @public
|
|
1462
|
-
* <p>
|
|
1463
|
-
* Returns the name of the label group.
|
|
1464
|
-
* </p>
|
|
1553
|
+
* <p> Returns the name of the label group. </p>
|
|
1465
1554
|
*/
|
|
1466
1555
|
LabelGroupName: string | undefined;
|
|
1467
1556
|
}
|
|
@@ -1471,37 +1560,28 @@ export interface DescribeLabelGroupRequest {
|
|
|
1471
1560
|
export interface DescribeLabelGroupResponse {
|
|
1472
1561
|
/**
|
|
1473
1562
|
* @public
|
|
1474
|
-
* <p>
|
|
1475
|
-
* The name of the label group.
|
|
1476
|
-
* </p>
|
|
1563
|
+
* <p> The name of the label group. </p>
|
|
1477
1564
|
*/
|
|
1478
1565
|
LabelGroupName?: string;
|
|
1479
1566
|
/**
|
|
1480
1567
|
* @public
|
|
1481
|
-
* <p>
|
|
1482
|
-
* The Amazon Resource Name (ARN) of the label group.
|
|
1483
|
-
* </p>
|
|
1568
|
+
* <p> The Amazon Resource Name (ARN) of the label group. </p>
|
|
1484
1569
|
*/
|
|
1485
1570
|
LabelGroupArn?: string;
|
|
1486
1571
|
/**
|
|
1487
1572
|
* @public
|
|
1488
|
-
* <p>
|
|
1489
|
-
* Codes indicating the type of anomaly associated with the labels in the lagbel group.
|
|
1573
|
+
* <p> Codes indicating the type of anomaly associated with the labels in the lagbel group.
|
|
1490
1574
|
* </p>
|
|
1491
1575
|
*/
|
|
1492
1576
|
FaultCodes?: string[];
|
|
1493
1577
|
/**
|
|
1494
1578
|
* @public
|
|
1495
|
-
* <p>
|
|
1496
|
-
* The time at which the label group was created.
|
|
1497
|
-
* </p>
|
|
1579
|
+
* <p> The time at which the label group was created. </p>
|
|
1498
1580
|
*/
|
|
1499
1581
|
CreatedAt?: Date;
|
|
1500
1582
|
/**
|
|
1501
1583
|
* @public
|
|
1502
|
-
* <p>
|
|
1503
|
-
* The time at which the label group was updated.
|
|
1504
|
-
* </p>
|
|
1584
|
+
* <p> The time at which the label group was updated. </p>
|
|
1505
1585
|
*/
|
|
1506
1586
|
UpdatedAt?: Date;
|
|
1507
1587
|
}
|
|
@@ -1511,33 +1591,48 @@ export interface DescribeLabelGroupResponse {
|
|
|
1511
1591
|
export interface DescribeModelRequest {
|
|
1512
1592
|
/**
|
|
1513
1593
|
* @public
|
|
1514
|
-
* <p>The name of the
|
|
1594
|
+
* <p>The name of the machine learning model to be described. </p>
|
|
1515
1595
|
*/
|
|
1516
1596
|
ModelName: string | undefined;
|
|
1517
1597
|
}
|
|
1598
|
+
/**
|
|
1599
|
+
* @public
|
|
1600
|
+
* @enum
|
|
1601
|
+
*/
|
|
1602
|
+
export declare const ModelVersionStatus: {
|
|
1603
|
+
readonly CANCELED: "CANCELED";
|
|
1604
|
+
readonly FAILED: "FAILED";
|
|
1605
|
+
readonly IMPORT_IN_PROGRESS: "IMPORT_IN_PROGRESS";
|
|
1606
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
1607
|
+
readonly SUCCESS: "SUCCESS";
|
|
1608
|
+
};
|
|
1609
|
+
/**
|
|
1610
|
+
* @public
|
|
1611
|
+
*/
|
|
1612
|
+
export type ModelVersionStatus = (typeof ModelVersionStatus)[keyof typeof ModelVersionStatus];
|
|
1518
1613
|
/**
|
|
1519
1614
|
* @public
|
|
1520
1615
|
*/
|
|
1521
1616
|
export interface DescribeModelResponse {
|
|
1522
1617
|
/**
|
|
1523
1618
|
* @public
|
|
1524
|
-
* <p>The name of the
|
|
1619
|
+
* <p>The name of the machine learning model being described. </p>
|
|
1525
1620
|
*/
|
|
1526
1621
|
ModelName?: string;
|
|
1527
1622
|
/**
|
|
1528
1623
|
* @public
|
|
1529
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
1624
|
+
* <p>The Amazon Resource Name (ARN) of the machine learning model being described. </p>
|
|
1530
1625
|
*/
|
|
1531
1626
|
ModelArn?: string;
|
|
1532
1627
|
/**
|
|
1533
1628
|
* @public
|
|
1534
|
-
* <p>The name of the dataset being used by the
|
|
1629
|
+
* <p>The name of the dataset being used by the machine learning being described. </p>
|
|
1535
1630
|
*/
|
|
1536
1631
|
DatasetName?: string;
|
|
1537
1632
|
/**
|
|
1538
1633
|
* @public
|
|
1539
|
-
* <p>The Amazon Resouce Name (ARN) of the dataset used to create the
|
|
1540
|
-
* described. </p>
|
|
1634
|
+
* <p>The Amazon Resouce Name (ARN) of the dataset used to create the machine learning model
|
|
1635
|
+
* being described. </p>
|
|
1541
1636
|
*/
|
|
1542
1637
|
DatasetArn?: string;
|
|
1543
1638
|
/**
|
|
@@ -1555,40 +1650,39 @@ export interface DescribeModelResponse {
|
|
|
1555
1650
|
/**
|
|
1556
1651
|
* @public
|
|
1557
1652
|
* <p> Indicates the time reference in the dataset that was used to begin the subset of
|
|
1558
|
-
* training data for the
|
|
1653
|
+
* training data for the machine learning model. </p>
|
|
1559
1654
|
*/
|
|
1560
1655
|
TrainingDataStartTime?: Date;
|
|
1561
1656
|
/**
|
|
1562
1657
|
* @public
|
|
1563
1658
|
* <p> Indicates the time reference in the dataset that was used to end the subset of training
|
|
1564
|
-
* data for the
|
|
1659
|
+
* data for the machine learning model. </p>
|
|
1565
1660
|
*/
|
|
1566
1661
|
TrainingDataEndTime?: Date;
|
|
1567
1662
|
/**
|
|
1568
1663
|
* @public
|
|
1569
1664
|
* <p> Indicates the time reference in the dataset that was used to begin the subset of
|
|
1570
|
-
* evaluation data for the
|
|
1665
|
+
* evaluation data for the machine learning model. </p>
|
|
1571
1666
|
*/
|
|
1572
1667
|
EvaluationDataStartTime?: Date;
|
|
1573
1668
|
/**
|
|
1574
1669
|
* @public
|
|
1575
1670
|
* <p> Indicates the time reference in the dataset that was used to end the subset of
|
|
1576
|
-
* evaluation data for the
|
|
1671
|
+
* evaluation data for the machine learning model. </p>
|
|
1577
1672
|
*/
|
|
1578
1673
|
EvaluationDataEndTime?: Date;
|
|
1579
1674
|
/**
|
|
1580
1675
|
* @public
|
|
1581
1676
|
* <p> The Amazon Resource Name (ARN) of a role with permission to access the data source for
|
|
1582
|
-
* the
|
|
1677
|
+
* the machine learning model being described. </p>
|
|
1583
1678
|
*/
|
|
1584
1679
|
RoleArn?: string;
|
|
1585
1680
|
/**
|
|
1586
1681
|
* @public
|
|
1587
1682
|
* <p>The configuration is the <code>TargetSamplingRate</code>, which is the sampling rate of
|
|
1588
|
-
* the data after post processing by Amazon Lookout for Equipment. For example, if you provide
|
|
1589
|
-
*
|
|
1590
|
-
*
|
|
1591
|
-
* minute.</p>
|
|
1683
|
+
* the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been
|
|
1684
|
+
* collected at a 1 second level and you want the system to resample the data at a 1 minute
|
|
1685
|
+
* rate before training, the <code>TargetSamplingRate</code> is 1 minute.</p>
|
|
1592
1686
|
* <p>When providing a value for the <code>TargetSamplingRate</code>, you must attach the
|
|
1593
1687
|
* prefix "PT" to the rate you want. The value for a 1 second rate is therefore
|
|
1594
1688
|
* <i>PT1S</i>, the value for a 15 minute rate is <i>PT15M</i>,
|
|
@@ -1604,18 +1698,19 @@ export interface DescribeModelResponse {
|
|
|
1604
1698
|
Status?: ModelStatus | string;
|
|
1605
1699
|
/**
|
|
1606
1700
|
* @public
|
|
1607
|
-
* <p>Indicates the time at which the training of the
|
|
1701
|
+
* <p>Indicates the time at which the training of the machine learning model began. </p>
|
|
1608
1702
|
*/
|
|
1609
1703
|
TrainingExecutionStartTime?: Date;
|
|
1610
1704
|
/**
|
|
1611
1705
|
* @public
|
|
1612
|
-
* <p>Indicates the time at which the training of the
|
|
1706
|
+
* <p>Indicates the time at which the training of the machine learning model was completed.
|
|
1707
|
+
* </p>
|
|
1613
1708
|
*/
|
|
1614
1709
|
TrainingExecutionEndTime?: Date;
|
|
1615
1710
|
/**
|
|
1616
1711
|
* @public
|
|
1617
|
-
* <p>If the training of the
|
|
1618
|
-
*
|
|
1712
|
+
* <p>If the training of the machine learning model failed, this indicates the reason for that
|
|
1713
|
+
* failure. </p>
|
|
1619
1714
|
*/
|
|
1620
1715
|
FailedReason?: string;
|
|
1621
1716
|
/**
|
|
@@ -1627,13 +1722,13 @@ export interface DescribeModelResponse {
|
|
|
1627
1722
|
ModelMetrics?: __LazyJsonString | string;
|
|
1628
1723
|
/**
|
|
1629
1724
|
* @public
|
|
1630
|
-
* <p>Indicates the last time the
|
|
1631
|
-
*
|
|
1725
|
+
* <p>Indicates the last time the machine learning model was updated. The type of update is
|
|
1726
|
+
* not specified. </p>
|
|
1632
1727
|
*/
|
|
1633
1728
|
LastUpdatedTime?: Date;
|
|
1634
1729
|
/**
|
|
1635
1730
|
* @public
|
|
1636
|
-
* <p>Indicates the time and date at which the
|
|
1731
|
+
* <p>Indicates the time and date at which the machine learning model was created. </p>
|
|
1637
1732
|
*/
|
|
1638
1733
|
CreatedAt?: Date;
|
|
1639
1734
|
/**
|
|
@@ -1645,38 +1740,38 @@ export interface DescribeModelResponse {
|
|
|
1645
1740
|
/**
|
|
1646
1741
|
* @public
|
|
1647
1742
|
* <p>Indicates that the asset associated with this sensor has been shut off. As long as this
|
|
1648
|
-
* condition is met, Lookout for Equipment will not use data from this asset for training,
|
|
1649
|
-
*
|
|
1743
|
+
* condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or
|
|
1744
|
+
* inference.</p>
|
|
1650
1745
|
*/
|
|
1651
1746
|
OffCondition?: string;
|
|
1652
1747
|
/**
|
|
1653
1748
|
* @public
|
|
1654
|
-
* <p>The Amazon Resource Name (ARN) of the source model version. This field appears if the
|
|
1655
|
-
*
|
|
1749
|
+
* <p>The Amazon Resource Name (ARN) of the source model version. This field appears if the
|
|
1750
|
+
* active model version was imported.</p>
|
|
1656
1751
|
*/
|
|
1657
1752
|
SourceModelVersionArn?: string;
|
|
1658
1753
|
/**
|
|
1659
1754
|
* @public
|
|
1660
|
-
* <p>The date and time when the import job was started.
|
|
1661
|
-
*
|
|
1755
|
+
* <p>The date and time when the import job was started. This field appears if the active
|
|
1756
|
+
* model version was imported.</p>
|
|
1662
1757
|
*/
|
|
1663
1758
|
ImportJobStartTime?: Date;
|
|
1664
1759
|
/**
|
|
1665
1760
|
* @public
|
|
1666
|
-
* <p>The date and time when the import job was completed.
|
|
1667
|
-
*
|
|
1761
|
+
* <p>The date and time when the import job was completed. This field appears if the active
|
|
1762
|
+
* model version was imported.</p>
|
|
1668
1763
|
*/
|
|
1669
1764
|
ImportJobEndTime?: Date;
|
|
1670
1765
|
/**
|
|
1671
1766
|
* @public
|
|
1672
|
-
* <p>The name of the model version used by the inference schedular when running a
|
|
1673
|
-
*
|
|
1767
|
+
* <p>The name of the model version used by the inference schedular when running a scheduled
|
|
1768
|
+
* inference execution.</p>
|
|
1674
1769
|
*/
|
|
1675
1770
|
ActiveModelVersion?: number;
|
|
1676
1771
|
/**
|
|
1677
1772
|
* @public
|
|
1678
|
-
* <p>The Amazon Resource Name (ARN) of the model version used by the
|
|
1679
|
-
*
|
|
1773
|
+
* <p>The Amazon Resource Name (ARN) of the model version used by the inference scheduler when
|
|
1774
|
+
* running a scheduled inference execution.</p>
|
|
1680
1775
|
*/
|
|
1681
1776
|
ActiveModelVersionArn?: string;
|
|
1682
1777
|
/**
|
|
@@ -1686,8 +1781,8 @@ export interface DescribeModelResponse {
|
|
|
1686
1781
|
ModelVersionActivatedAt?: Date;
|
|
1687
1782
|
/**
|
|
1688
1783
|
* @public
|
|
1689
|
-
* <p>The model version that was set as the active model version prior to the
|
|
1690
|
-
*
|
|
1784
|
+
* <p>The model version that was set as the active model version prior to the current active
|
|
1785
|
+
* model version.</p>
|
|
1691
1786
|
*/
|
|
1692
1787
|
PreviousActiveModelVersion?: number;
|
|
1693
1788
|
/**
|
|
@@ -1701,6 +1796,61 @@ export interface DescribeModelResponse {
|
|
|
1701
1796
|
* <p>The date and time when the previous active model version was activated.</p>
|
|
1702
1797
|
*/
|
|
1703
1798
|
PreviousModelVersionActivatedAt?: Date;
|
|
1799
|
+
/**
|
|
1800
|
+
* @public
|
|
1801
|
+
* <p>If the model version was retrained, this field shows a summary of the performance of the
|
|
1802
|
+
* prior model on the new training range. You can use the information in this JSON-formatted
|
|
1803
|
+
* object to compare the new model version and the prior model version.</p>
|
|
1804
|
+
*/
|
|
1805
|
+
PriorModelMetrics?: __LazyJsonString | string;
|
|
1806
|
+
/**
|
|
1807
|
+
* @public
|
|
1808
|
+
* <p>If the model version was generated by retraining and the training failed, this indicates
|
|
1809
|
+
* the reason for that failure. </p>
|
|
1810
|
+
*/
|
|
1811
|
+
LatestScheduledRetrainingFailedReason?: string;
|
|
1812
|
+
/**
|
|
1813
|
+
* @public
|
|
1814
|
+
* <p>Indicates the status of the most recent scheduled retraining run. </p>
|
|
1815
|
+
*/
|
|
1816
|
+
LatestScheduledRetrainingStatus?: ModelVersionStatus | string;
|
|
1817
|
+
/**
|
|
1818
|
+
* @public
|
|
1819
|
+
* <p>Indicates the most recent model version that was generated by retraining. </p>
|
|
1820
|
+
*/
|
|
1821
|
+
LatestScheduledRetrainingModelVersion?: number;
|
|
1822
|
+
/**
|
|
1823
|
+
* @public
|
|
1824
|
+
* <p>Indicates the start time of the most recent scheduled retraining run. </p>
|
|
1825
|
+
*/
|
|
1826
|
+
LatestScheduledRetrainingStartTime?: Date;
|
|
1827
|
+
/**
|
|
1828
|
+
* @public
|
|
1829
|
+
* <p>Indicates the number of days of data used in the most recent scheduled retraining run.
|
|
1830
|
+
* </p>
|
|
1831
|
+
*/
|
|
1832
|
+
LatestScheduledRetrainingAvailableDataInDays?: number;
|
|
1833
|
+
/**
|
|
1834
|
+
* @public
|
|
1835
|
+
* <p>Indicates the date and time that the next scheduled retraining run will start on. Lookout for Equipment
|
|
1836
|
+
* truncates the time you provide to the nearest UTC day.</p>
|
|
1837
|
+
*/
|
|
1838
|
+
NextScheduledRetrainingStartDate?: Date;
|
|
1839
|
+
/**
|
|
1840
|
+
* @public
|
|
1841
|
+
* <p>Indicates the start time of the inference data that has been accumulated. </p>
|
|
1842
|
+
*/
|
|
1843
|
+
AccumulatedInferenceDataStartTime?: Date;
|
|
1844
|
+
/**
|
|
1845
|
+
* @public
|
|
1846
|
+
* <p>Indicates the end time of the inference data that has been accumulated. </p>
|
|
1847
|
+
*/
|
|
1848
|
+
AccumulatedInferenceDataEndTime?: Date;
|
|
1849
|
+
/**
|
|
1850
|
+
* @public
|
|
1851
|
+
* <p>Indicates the status of the retraining scheduler. </p>
|
|
1852
|
+
*/
|
|
1853
|
+
RetrainingSchedulerStatus?: RetrainingSchedulerStatus | string;
|
|
1704
1854
|
}
|
|
1705
1855
|
/**
|
|
1706
1856
|
* @public
|
|
@@ -1730,21 +1880,6 @@ export declare const ModelVersionSourceType: {
|
|
|
1730
1880
|
* @public
|
|
1731
1881
|
*/
|
|
1732
1882
|
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
1883
|
/**
|
|
1749
1884
|
* @public
|
|
1750
1885
|
*/
|
|
@@ -1756,7 +1891,8 @@ export interface DescribeModelVersionResponse {
|
|
|
1756
1891
|
ModelName?: string;
|
|
1757
1892
|
/**
|
|
1758
1893
|
* @public
|
|
1759
|
-
* <p>The Amazon Resource Name (ARN) of the parent machine learning model that this version
|
|
1894
|
+
* <p>The Amazon Resource Name (ARN) of the parent machine learning model that this version
|
|
1895
|
+
* belong to.</p>
|
|
1760
1896
|
*/
|
|
1761
1897
|
ModelArn?: string;
|
|
1762
1898
|
/**
|
|
@@ -1802,44 +1938,43 @@ export interface DescribeModelVersionResponse {
|
|
|
1802
1938
|
LabelsInputConfiguration?: LabelsInputConfiguration;
|
|
1803
1939
|
/**
|
|
1804
1940
|
* @public
|
|
1805
|
-
* <p>The date on which the training data began being gathered. If you imported
|
|
1806
|
-
*
|
|
1807
|
-
* version began being gathered.</p>
|
|
1941
|
+
* <p>The date on which the training data began being gathered. If you imported the version,
|
|
1942
|
+
* this is the date that the training data in the source version began being gathered.</p>
|
|
1808
1943
|
*/
|
|
1809
1944
|
TrainingDataStartTime?: Date;
|
|
1810
1945
|
/**
|
|
1811
1946
|
* @public
|
|
1812
|
-
* <p>The date on which the training data finished being gathered.
|
|
1813
|
-
*
|
|
1814
|
-
*
|
|
1947
|
+
* <p>The date on which the training data finished being gathered. If you imported the
|
|
1948
|
+
* version, this is the date that the training data in the source version finished being
|
|
1949
|
+
* gathered.</p>
|
|
1815
1950
|
*/
|
|
1816
1951
|
TrainingDataEndTime?: Date;
|
|
1817
1952
|
/**
|
|
1818
1953
|
* @public
|
|
1819
|
-
* <p>The date on which the data in the evaluation set began being gathered.
|
|
1820
|
-
*
|
|
1821
|
-
*
|
|
1954
|
+
* <p>The date on which the data in the evaluation set began being gathered. If you imported
|
|
1955
|
+
* the version, this is the date that the evaluation set data in the source version began
|
|
1956
|
+
* being gathered.</p>
|
|
1822
1957
|
*/
|
|
1823
1958
|
EvaluationDataStartTime?: Date;
|
|
1824
1959
|
/**
|
|
1825
1960
|
* @public
|
|
1826
|
-
* <p>The date on which the data in the evaluation set began being gathered.
|
|
1827
|
-
*
|
|
1828
|
-
*
|
|
1961
|
+
* <p>The date on which the data in the evaluation set began being gathered. If you imported
|
|
1962
|
+
* the version, this is the date that the evaluation set data in the source version finished
|
|
1963
|
+
* being gathered.</p>
|
|
1829
1964
|
*/
|
|
1830
1965
|
EvaluationDataEndTime?: Date;
|
|
1831
1966
|
/**
|
|
1832
1967
|
* @public
|
|
1833
|
-
* <p>The Amazon Resource Name (ARN) of the role that was used to train the model
|
|
1968
|
+
* <p>The Amazon Resource Name (ARN) of the role that was used to train the model
|
|
1969
|
+
* version.</p>
|
|
1834
1970
|
*/
|
|
1835
1971
|
RoleArn?: string;
|
|
1836
1972
|
/**
|
|
1837
1973
|
* @public
|
|
1838
1974
|
* <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
|
-
*
|
|
1841
|
-
*
|
|
1842
|
-
* minute.</p>
|
|
1975
|
+
* the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been
|
|
1976
|
+
* collected at a 1 second level and you want the system to resample the data at a 1 minute
|
|
1977
|
+
* rate before training, the <code>TargetSamplingRate</code> is 1 minute.</p>
|
|
1843
1978
|
* <p>When providing a value for the <code>TargetSamplingRate</code>, you must attach the
|
|
1844
1979
|
* prefix "PT" to the rate you want. The value for a 1 second rate is therefore
|
|
1845
1980
|
* <i>PT1S</i>, the value for a 15 minute rate is <i>PT15M</i>,
|
|
@@ -1864,9 +1999,8 @@ export interface DescribeModelVersionResponse {
|
|
|
1864
1999
|
FailedReason?: string;
|
|
1865
2000
|
/**
|
|
1866
2001
|
* @public
|
|
1867
|
-
* <p>Shows an aggregated summary, in JSON format, of the model's
|
|
1868
|
-
*
|
|
1869
|
-
* are created when evaluating the model.</p>
|
|
2002
|
+
* <p>Shows an aggregated summary, in JSON format, of the model's performance within the
|
|
2003
|
+
* evaluation time range. These metrics are created when evaluating the model.</p>
|
|
1870
2004
|
*/
|
|
1871
2005
|
ModelMetrics?: string;
|
|
1872
2006
|
/**
|
|
@@ -1876,46 +2010,75 @@ export interface DescribeModelVersionResponse {
|
|
|
1876
2010
|
LastUpdatedTime?: Date;
|
|
1877
2011
|
/**
|
|
1878
2012
|
* @public
|
|
1879
|
-
* <p>Indicates the time and date at which the machine learning model version was
|
|
2013
|
+
* <p>Indicates the time and date at which the machine learning model version was
|
|
2014
|
+
* created.</p>
|
|
1880
2015
|
*/
|
|
1881
2016
|
CreatedAt?: Date;
|
|
1882
2017
|
/**
|
|
1883
2018
|
* @public
|
|
1884
2019
|
* <p>The identifier of the KMS key key used to encrypt model version data by
|
|
1885
|
-
*
|
|
2020
|
+
* Amazon Lookout for Equipment.</p>
|
|
1886
2021
|
*/
|
|
1887
2022
|
ServerSideKmsKeyId?: string;
|
|
1888
2023
|
/**
|
|
1889
2024
|
* @public
|
|
1890
|
-
* <p>Indicates that the asset associated with this sensor has been
|
|
1891
|
-
*
|
|
1892
|
-
*
|
|
2025
|
+
* <p>Indicates that the asset associated with this sensor has been shut off. As long as this
|
|
2026
|
+
* condition is met, Lookout for Equipment will not use data from this asset for training,
|
|
2027
|
+
* evaluation, or inference.</p>
|
|
1893
2028
|
*/
|
|
1894
2029
|
OffCondition?: string;
|
|
1895
2030
|
/**
|
|
1896
2031
|
* @public
|
|
1897
|
-
* <p>If model version was imported, then this field is the arn
|
|
1898
|
-
*
|
|
2032
|
+
* <p>If model version was imported, then this field is the arn of the source model
|
|
2033
|
+
* version.</p>
|
|
1899
2034
|
*/
|
|
1900
2035
|
SourceModelVersionArn?: string;
|
|
1901
2036
|
/**
|
|
1902
2037
|
* @public
|
|
1903
|
-
* <p>The date and time when the import job began.
|
|
1904
|
-
*
|
|
2038
|
+
* <p>The date and time when the import job began. This field appears if the model version was
|
|
2039
|
+
* imported.</p>
|
|
1905
2040
|
*/
|
|
1906
2041
|
ImportJobStartTime?: Date;
|
|
1907
2042
|
/**
|
|
1908
2043
|
* @public
|
|
1909
|
-
* <p>The date and time when the import job completed.
|
|
1910
|
-
*
|
|
2044
|
+
* <p>The date and time when the import job completed. This field appears if the model version
|
|
2045
|
+
* was imported.</p>
|
|
1911
2046
|
*/
|
|
1912
2047
|
ImportJobEndTime?: Date;
|
|
1913
2048
|
/**
|
|
1914
2049
|
* @public
|
|
1915
|
-
* <p>The size in bytes of the imported data.
|
|
1916
|
-
*
|
|
2050
|
+
* <p>The size in bytes of the imported data. This field appears if the model version was
|
|
2051
|
+
* imported.</p>
|
|
1917
2052
|
*/
|
|
1918
2053
|
ImportedDataSizeInBytes?: number;
|
|
2054
|
+
/**
|
|
2055
|
+
* @public
|
|
2056
|
+
* <p>If the model version was retrained, this field shows a summary of the performance of the
|
|
2057
|
+
* prior model on the new training range. You can use the information in this JSON-formatted
|
|
2058
|
+
* object to compare the new model version and the prior model version.</p>
|
|
2059
|
+
*/
|
|
2060
|
+
PriorModelMetrics?: string;
|
|
2061
|
+
/**
|
|
2062
|
+
* @public
|
|
2063
|
+
* <p>Indicates the number of days of data used in the most recent scheduled retraining run.
|
|
2064
|
+
* </p>
|
|
2065
|
+
*/
|
|
2066
|
+
RetrainingAvailableDataInDays?: number;
|
|
2067
|
+
/**
|
|
2068
|
+
* @public
|
|
2069
|
+
* <p>Indicates whether the model version was promoted to be the active version after
|
|
2070
|
+
* retraining or if there was an error with or cancellation of the retraining. </p>
|
|
2071
|
+
*/
|
|
2072
|
+
AutoPromotionResult?: AutoPromotionResult | string;
|
|
2073
|
+
/**
|
|
2074
|
+
* @public
|
|
2075
|
+
* <p>Indicates the reason for the <code>AutoPromotionResult</code>. For example, a model
|
|
2076
|
+
* might not be promoted if its performance was worse than the active version, if there was an
|
|
2077
|
+
* error during training, or if the retraining scheduler was using <code>MANUAL</code> promote
|
|
2078
|
+
* mode. The model will be promoted in <code>MANAGED</code> promote mode if the performance is
|
|
2079
|
+
* better than the previous model. </p>
|
|
2080
|
+
*/
|
|
2081
|
+
AutoPromotionResultReason?: string;
|
|
1919
2082
|
}
|
|
1920
2083
|
/**
|
|
1921
2084
|
* @public
|
|
@@ -1923,7 +2086,8 @@ export interface DescribeModelVersionResponse {
|
|
|
1923
2086
|
export interface DescribeResourcePolicyRequest {
|
|
1924
2087
|
/**
|
|
1925
2088
|
* @public
|
|
1926
|
-
* <p>The Amazon Resource Name (ARN) of the resource that is associated with the resource
|
|
2089
|
+
* <p>The Amazon Resource Name (ARN) of the resource that is associated with the resource
|
|
2090
|
+
* policy.</p>
|
|
1927
2091
|
*/
|
|
1928
2092
|
ResourceArn: string | undefined;
|
|
1929
2093
|
}
|
|
@@ -1952,6 +2116,71 @@ export interface DescribeResourcePolicyResponse {
|
|
|
1952
2116
|
*/
|
|
1953
2117
|
LastModifiedTime?: Date;
|
|
1954
2118
|
}
|
|
2119
|
+
/**
|
|
2120
|
+
* @public
|
|
2121
|
+
*/
|
|
2122
|
+
export interface DescribeRetrainingSchedulerRequest {
|
|
2123
|
+
/**
|
|
2124
|
+
* @public
|
|
2125
|
+
* <p>The name of the model that the retraining scheduler is attached to. </p>
|
|
2126
|
+
*/
|
|
2127
|
+
ModelName: string | undefined;
|
|
2128
|
+
}
|
|
2129
|
+
/**
|
|
2130
|
+
* @public
|
|
2131
|
+
*/
|
|
2132
|
+
export interface DescribeRetrainingSchedulerResponse {
|
|
2133
|
+
/**
|
|
2134
|
+
* @public
|
|
2135
|
+
* <p>The name of the model that the retraining scheduler is attached to. </p>
|
|
2136
|
+
*/
|
|
2137
|
+
ModelName?: string;
|
|
2138
|
+
/**
|
|
2139
|
+
* @public
|
|
2140
|
+
* <p>The ARN of the model that the retraining scheduler is attached to. </p>
|
|
2141
|
+
*/
|
|
2142
|
+
ModelArn?: string;
|
|
2143
|
+
/**
|
|
2144
|
+
* @public
|
|
2145
|
+
* <p>The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the
|
|
2146
|
+
* nearest UTC day.</p>
|
|
2147
|
+
*/
|
|
2148
|
+
RetrainingStartDate?: Date;
|
|
2149
|
+
/**
|
|
2150
|
+
* @public
|
|
2151
|
+
* <p>The frequency at which the model retraining is set. This follows the <a href="https://en.wikipedia.org/wiki/ISO_8601#Durations">ISO 8601</a>
|
|
2152
|
+
* guidelines.</p>
|
|
2153
|
+
*/
|
|
2154
|
+
RetrainingFrequency?: string;
|
|
2155
|
+
/**
|
|
2156
|
+
* @public
|
|
2157
|
+
* <p>The number of past days of data used for retraining.</p>
|
|
2158
|
+
*/
|
|
2159
|
+
LookbackWindow?: string;
|
|
2160
|
+
/**
|
|
2161
|
+
* @public
|
|
2162
|
+
* <p>The status of the retraining scheduler. </p>
|
|
2163
|
+
*/
|
|
2164
|
+
Status?: RetrainingSchedulerStatus | string;
|
|
2165
|
+
/**
|
|
2166
|
+
* @public
|
|
2167
|
+
* <p>Indicates how the service uses new models. In <code>MANAGED</code> mode, new models are
|
|
2168
|
+
* used for inference if they have better performance than the current model. In
|
|
2169
|
+
* <code>MANUAL</code> mode, the new models are not used until they are <a href="https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/versioning-model.html#model-activation">manually
|
|
2170
|
+
* activated</a>.</p>
|
|
2171
|
+
*/
|
|
2172
|
+
PromoteMode?: ModelPromoteMode | string;
|
|
2173
|
+
/**
|
|
2174
|
+
* @public
|
|
2175
|
+
* <p>Indicates the time and date at which the retraining scheduler was created. </p>
|
|
2176
|
+
*/
|
|
2177
|
+
CreatedAt?: Date;
|
|
2178
|
+
/**
|
|
2179
|
+
* @public
|
|
2180
|
+
* <p>Indicates the time and date at which the retraining scheduler was updated. </p>
|
|
2181
|
+
*/
|
|
2182
|
+
UpdatedAt?: Date;
|
|
2183
|
+
}
|
|
1955
2184
|
/**
|
|
1956
2185
|
* @public
|
|
1957
2186
|
*/
|
|
@@ -1963,20 +2192,21 @@ export interface ImportDatasetRequest {
|
|
|
1963
2192
|
SourceDatasetArn: string | undefined;
|
|
1964
2193
|
/**
|
|
1965
2194
|
* @public
|
|
1966
|
-
* <p>The name of the machine learning dataset to be created. If the dataset already exists,
|
|
2195
|
+
* <p>The name of the machine learning dataset to be created. If the dataset already exists,
|
|
2196
|
+
* Amazon Lookout for Equipment overwrites the existing dataset. If you don't specify this field, it is filled
|
|
2197
|
+
* with the name of the source dataset.</p>
|
|
1967
2198
|
*/
|
|
1968
2199
|
DatasetName?: string;
|
|
1969
2200
|
/**
|
|
1970
2201
|
* @public
|
|
1971
|
-
* <p>A unique identifier for the request.
|
|
1972
|
-
*
|
|
1973
|
-
* Amazon Lookout for Equipment generates one. </p>
|
|
2202
|
+
* <p>A unique identifier for the request. If you do not set the client request token,
|
|
2203
|
+
* Amazon Lookout for Equipment generates one. </p>
|
|
1974
2204
|
*/
|
|
1975
2205
|
ClientToken?: string;
|
|
1976
2206
|
/**
|
|
1977
2207
|
* @public
|
|
1978
|
-
* <p>Provides the identifier of the KMS key key used to
|
|
1979
|
-
*
|
|
2208
|
+
* <p>Provides the identifier of the KMS key key used to encrypt model data by Amazon Lookout for Equipment.
|
|
2209
|
+
* </p>
|
|
1980
2210
|
*/
|
|
1981
2211
|
ServerSideKmsKeyId?: string;
|
|
1982
2212
|
/**
|
|
@@ -2010,6 +2240,19 @@ export interface ImportDatasetResponse {
|
|
|
2010
2240
|
*/
|
|
2011
2241
|
JobId?: string;
|
|
2012
2242
|
}
|
|
2243
|
+
/**
|
|
2244
|
+
* @public
|
|
2245
|
+
* @enum
|
|
2246
|
+
*/
|
|
2247
|
+
export declare const InferenceDataImportStrategy: {
|
|
2248
|
+
readonly ADD_WHEN_EMPTY: "ADD_WHEN_EMPTY";
|
|
2249
|
+
readonly NO_IMPORT: "NO_IMPORT";
|
|
2250
|
+
readonly OVERWRITE: "OVERWRITE";
|
|
2251
|
+
};
|
|
2252
|
+
/**
|
|
2253
|
+
* @public
|
|
2254
|
+
*/
|
|
2255
|
+
export type InferenceDataImportStrategy = (typeof InferenceDataImportStrategy)[keyof typeof InferenceDataImportStrategy];
|
|
2013
2256
|
/**
|
|
2014
2257
|
* @public
|
|
2015
2258
|
*/
|
|
@@ -2021,9 +2264,9 @@ export interface ImportModelVersionRequest {
|
|
|
2021
2264
|
SourceModelVersionArn: string | undefined;
|
|
2022
2265
|
/**
|
|
2023
2266
|
* @public
|
|
2024
|
-
* <p>The name for the machine learning model to be created.
|
|
2025
|
-
*
|
|
2026
|
-
*
|
|
2267
|
+
* <p>The name for the machine learning model to be created. If the model already exists,
|
|
2268
|
+
* Amazon Lookout for Equipment creates a new version. If you do not specify this field, it is filled with the
|
|
2269
|
+
* name of the source model.</p>
|
|
2027
2270
|
*/
|
|
2028
2271
|
ModelName?: string;
|
|
2029
2272
|
/**
|
|
@@ -2039,20 +2282,20 @@ export interface ImportModelVersionRequest {
|
|
|
2039
2282
|
LabelsInputConfiguration?: LabelsInputConfiguration;
|
|
2040
2283
|
/**
|
|
2041
2284
|
* @public
|
|
2042
|
-
* <p>A unique identifier for the request. If you do not set the client request
|
|
2043
|
-
*
|
|
2285
|
+
* <p>A unique identifier for the request. If you do not set the client request token,
|
|
2286
|
+
* Amazon Lookout for Equipment generates one. </p>
|
|
2044
2287
|
*/
|
|
2045
2288
|
ClientToken?: string;
|
|
2046
2289
|
/**
|
|
2047
2290
|
* @public
|
|
2048
|
-
* <p>The Amazon Resource Name (ARN) of a role with permission to
|
|
2049
|
-
*
|
|
2291
|
+
* <p>The Amazon Resource Name (ARN) of a role with permission to access the data source being
|
|
2292
|
+
* used to create the machine learning model. </p>
|
|
2050
2293
|
*/
|
|
2051
2294
|
RoleArn?: string;
|
|
2052
2295
|
/**
|
|
2053
2296
|
* @public
|
|
2054
|
-
* <p>Provides the identifier of the KMS key key used to encrypt
|
|
2055
|
-
*
|
|
2297
|
+
* <p>Provides the identifier of the KMS key key used to encrypt model data by Amazon Lookout for Equipment.
|
|
2298
|
+
* </p>
|
|
2056
2299
|
*/
|
|
2057
2300
|
ServerSideKmsKeyId?: string;
|
|
2058
2301
|
/**
|
|
@@ -2060,6 +2303,25 @@ export interface ImportModelVersionRequest {
|
|
|
2060
2303
|
* <p>The tags associated with the machine learning model to be created. </p>
|
|
2061
2304
|
*/
|
|
2062
2305
|
Tags?: Tag[];
|
|
2306
|
+
/**
|
|
2307
|
+
* @public
|
|
2308
|
+
* <p>Indicates how to import the accumulated inference data when a model version is imported.
|
|
2309
|
+
* The possible values are as follows:</p>
|
|
2310
|
+
* <ul>
|
|
2311
|
+
* <li>
|
|
2312
|
+
* <p>NO_IMPORT – Don't import the data.</p>
|
|
2313
|
+
* </li>
|
|
2314
|
+
* <li>
|
|
2315
|
+
* <p>ADD_WHEN_EMPTY – Only import the data from the source model if there is no
|
|
2316
|
+
* existing data in the target model.</p>
|
|
2317
|
+
* </li>
|
|
2318
|
+
* <li>
|
|
2319
|
+
* <p>OVERWRITE – Import the data from the source model and overwrite the
|
|
2320
|
+
* existing data in the target model.</p>
|
|
2321
|
+
* </li>
|
|
2322
|
+
* </ul>
|
|
2323
|
+
*/
|
|
2324
|
+
InferenceDataImportStrategy?: InferenceDataImportStrategy | string;
|
|
2063
2325
|
}
|
|
2064
2326
|
/**
|
|
2065
2327
|
* @public
|
|
@@ -2254,13 +2516,14 @@ export interface ListInferenceEventsRequest {
|
|
|
2254
2516
|
InferenceSchedulerName: string | undefined;
|
|
2255
2517
|
/**
|
|
2256
2518
|
* @public
|
|
2257
|
-
* <p> Lookout for Equipment will return all the inference events with an end time equal to or greater than
|
|
2258
|
-
* start time given.</p>
|
|
2519
|
+
* <p> Lookout for Equipment will return all the inference events with an end time equal to or greater than
|
|
2520
|
+
* the start time given.</p>
|
|
2259
2521
|
*/
|
|
2260
2522
|
IntervalStartTime: Date | undefined;
|
|
2261
2523
|
/**
|
|
2262
2524
|
* @public
|
|
2263
|
-
* <p>Returns all the inference events with an end start time equal to or greater than less
|
|
2525
|
+
* <p>Returns all the inference events with an end start time equal to or greater than less
|
|
2526
|
+
* than the end time given.</p>
|
|
2264
2527
|
*/
|
|
2265
2528
|
IntervalEndTime: Date | undefined;
|
|
2266
2529
|
}
|
|
@@ -2356,14 +2619,14 @@ export interface ListInferenceExecutionsRequest {
|
|
|
2356
2619
|
InferenceSchedulerName: string | undefined;
|
|
2357
2620
|
/**
|
|
2358
2621
|
* @public
|
|
2359
|
-
* <p>The time reference in the inferenced dataset after which Amazon Lookout for Equipment
|
|
2360
|
-
*
|
|
2622
|
+
* <p>The time reference in the inferenced dataset after which Amazon Lookout for Equipment started the inference
|
|
2623
|
+
* execution. </p>
|
|
2361
2624
|
*/
|
|
2362
2625
|
DataStartTimeAfter?: Date;
|
|
2363
2626
|
/**
|
|
2364
2627
|
* @public
|
|
2365
|
-
* <p>The time reference in the inferenced dataset before which Amazon Lookout for Equipment
|
|
2366
|
-
*
|
|
2628
|
+
* <p>The time reference in the inferenced dataset before which Amazon Lookout for Equipment stopped the
|
|
2629
|
+
* inference execution. </p>
|
|
2367
2630
|
*/
|
|
2368
2631
|
DataEndTimeBefore?: Date;
|
|
2369
2632
|
/**
|
|
@@ -2380,12 +2643,13 @@ export interface ListInferenceExecutionsRequest {
|
|
|
2380
2643
|
export interface InferenceExecutionSummary {
|
|
2381
2644
|
/**
|
|
2382
2645
|
* @public
|
|
2383
|
-
* <p>The name of the
|
|
2646
|
+
* <p>The name of the machine learning model being used for the inference execution. </p>
|
|
2384
2647
|
*/
|
|
2385
2648
|
ModelName?: string;
|
|
2386
2649
|
/**
|
|
2387
2650
|
* @public
|
|
2388
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
2651
|
+
* <p>The Amazon Resource Name (ARN) of the machine learning model used for the inference
|
|
2652
|
+
* execution. </p>
|
|
2389
2653
|
*/
|
|
2390
2654
|
ModelArn?: string;
|
|
2391
2655
|
/**
|
|
@@ -2432,8 +2696,7 @@ export interface InferenceExecutionSummary {
|
|
|
2432
2696
|
DataOutputConfiguration?: InferenceOutputConfiguration;
|
|
2433
2697
|
/**
|
|
2434
2698
|
* @public
|
|
2435
|
-
* <p>
|
|
2436
|
-
* </p>
|
|
2699
|
+
* <p>The S3 object that the inference execution results were uploaded to.</p>
|
|
2437
2700
|
*/
|
|
2438
2701
|
CustomerResultObject?: S3Object;
|
|
2439
2702
|
/**
|
|
@@ -2446,6 +2709,17 @@ export interface InferenceExecutionSummary {
|
|
|
2446
2709
|
* <p> Specifies the reason for failure when an inference execution has failed. </p>
|
|
2447
2710
|
*/
|
|
2448
2711
|
FailedReason?: string;
|
|
2712
|
+
/**
|
|
2713
|
+
* @public
|
|
2714
|
+
* <p>The model version used for the inference execution.</p>
|
|
2715
|
+
*/
|
|
2716
|
+
ModelVersion?: number;
|
|
2717
|
+
/**
|
|
2718
|
+
* @public
|
|
2719
|
+
* <p>The Amazon Resource Number (ARN) of the model version used for the inference
|
|
2720
|
+
* execution.</p>
|
|
2721
|
+
*/
|
|
2722
|
+
ModelVersionArn?: string;
|
|
2449
2723
|
}
|
|
2450
2724
|
/**
|
|
2451
2725
|
* @public
|
|
@@ -2487,7 +2761,8 @@ export interface ListInferenceSchedulersRequest {
|
|
|
2487
2761
|
InferenceSchedulerNameBeginsWith?: string;
|
|
2488
2762
|
/**
|
|
2489
2763
|
* @public
|
|
2490
|
-
* <p>The name of the
|
|
2764
|
+
* <p>The name of the machine learning model used by the inference scheduler to be listed.
|
|
2765
|
+
* </p>
|
|
2491
2766
|
*/
|
|
2492
2767
|
ModelName?: string;
|
|
2493
2768
|
/**
|
|
@@ -2504,12 +2779,13 @@ export interface ListInferenceSchedulersRequest {
|
|
|
2504
2779
|
export interface InferenceSchedulerSummary {
|
|
2505
2780
|
/**
|
|
2506
2781
|
* @public
|
|
2507
|
-
* <p>The name of the
|
|
2782
|
+
* <p>The name of the machine learning model used for the inference scheduler. </p>
|
|
2508
2783
|
*/
|
|
2509
2784
|
ModelName?: string;
|
|
2510
2785
|
/**
|
|
2511
2786
|
* @public
|
|
2512
|
-
* <p> The Amazon Resource Name (ARN) of the
|
|
2787
|
+
* <p> The Amazon Resource Name (ARN) of the machine learning model used by the inference
|
|
2788
|
+
* scheduler. </p>
|
|
2513
2789
|
*/
|
|
2514
2790
|
ModelArn?: string;
|
|
2515
2791
|
/**
|
|
@@ -2543,8 +2819,8 @@ export interface InferenceSchedulerSummary {
|
|
|
2543
2819
|
* <p>How often data is uploaded to the source S3 bucket for the input data. This value is the
|
|
2544
2820
|
* length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout
|
|
2545
2821
|
* for Equipment will upload the real-time data to the source bucket once every 5 minutes.
|
|
2546
|
-
* This frequency also determines how often Amazon Lookout for Equipment starts a scheduled
|
|
2547
|
-
*
|
|
2822
|
+
* This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your
|
|
2823
|
+
* data. In this example, it starts once every 5 minutes. </p>
|
|
2548
2824
|
*/
|
|
2549
2825
|
DataUploadFrequency?: DataUploadFrequency | string;
|
|
2550
2826
|
/**
|
|
@@ -2577,59 +2853,44 @@ export interface ListInferenceSchedulersResponse {
|
|
|
2577
2853
|
export interface ListLabelGroupsRequest {
|
|
2578
2854
|
/**
|
|
2579
2855
|
* @public
|
|
2580
|
-
* <p>
|
|
2581
|
-
* The beginning of the name of the label groups to be listed.
|
|
2582
|
-
* </p>
|
|
2856
|
+
* <p> The beginning of the name of the label groups to be listed. </p>
|
|
2583
2857
|
*/
|
|
2584
2858
|
LabelGroupNameBeginsWith?: string;
|
|
2585
2859
|
/**
|
|
2586
2860
|
* @public
|
|
2587
|
-
* <p>
|
|
2588
|
-
* An opaque pagination token indicating where to continue the listing of label groups.
|
|
2861
|
+
* <p> An opaque pagination token indicating where to continue the listing of label groups.
|
|
2589
2862
|
* </p>
|
|
2590
2863
|
*/
|
|
2591
2864
|
NextToken?: string;
|
|
2592
2865
|
/**
|
|
2593
2866
|
* @public
|
|
2594
|
-
* <p>
|
|
2595
|
-
* Specifies the maximum number of label groups to list.
|
|
2596
|
-
* </p>
|
|
2867
|
+
* <p> Specifies the maximum number of label groups to list. </p>
|
|
2597
2868
|
*/
|
|
2598
2869
|
MaxResults?: number;
|
|
2599
2870
|
}
|
|
2600
2871
|
/**
|
|
2601
2872
|
* @public
|
|
2602
|
-
* <p>
|
|
2603
|
-
* Contains information about the label group.
|
|
2604
|
-
* </p>
|
|
2873
|
+
* <p> Contains information about the label group. </p>
|
|
2605
2874
|
*/
|
|
2606
2875
|
export interface LabelGroupSummary {
|
|
2607
2876
|
/**
|
|
2608
2877
|
* @public
|
|
2609
|
-
* <p>
|
|
2610
|
-
* The name of the label group.
|
|
2611
|
-
* </p>
|
|
2878
|
+
* <p> The name of the label group. </p>
|
|
2612
2879
|
*/
|
|
2613
2880
|
LabelGroupName?: string;
|
|
2614
2881
|
/**
|
|
2615
2882
|
* @public
|
|
2616
|
-
* <p>
|
|
2617
|
-
* The Amazon Resource Name (ARN) of the label group.
|
|
2618
|
-
* </p>
|
|
2883
|
+
* <p> The Amazon Resource Name (ARN) of the label group. </p>
|
|
2619
2884
|
*/
|
|
2620
2885
|
LabelGroupArn?: string;
|
|
2621
2886
|
/**
|
|
2622
2887
|
* @public
|
|
2623
|
-
* <p>
|
|
2624
|
-
* The time at which the label group was created.
|
|
2625
|
-
* </p>
|
|
2888
|
+
* <p> The time at which the label group was created. </p>
|
|
2626
2889
|
*/
|
|
2627
2890
|
CreatedAt?: Date;
|
|
2628
2891
|
/**
|
|
2629
2892
|
* @public
|
|
2630
|
-
* <p>
|
|
2631
|
-
* The time at which the label group was updated.
|
|
2632
|
-
* </p>
|
|
2893
|
+
* <p> The time at which the label group was updated. </p>
|
|
2633
2894
|
*/
|
|
2634
2895
|
UpdatedAt?: Date;
|
|
2635
2896
|
}
|
|
@@ -2639,16 +2900,13 @@ export interface LabelGroupSummary {
|
|
|
2639
2900
|
export interface ListLabelGroupsResponse {
|
|
2640
2901
|
/**
|
|
2641
2902
|
* @public
|
|
2642
|
-
* <p>
|
|
2643
|
-
* An opaque pagination token indicating where to continue the listing of label groups.
|
|
2903
|
+
* <p> An opaque pagination token indicating where to continue the listing of label groups.
|
|
2644
2904
|
* </p>
|
|
2645
2905
|
*/
|
|
2646
2906
|
NextToken?: string;
|
|
2647
2907
|
/**
|
|
2648
2908
|
* @public
|
|
2649
|
-
* <p>
|
|
2650
|
-
* A summary of the label groups.
|
|
2651
|
-
* </p>
|
|
2909
|
+
* <p> A summary of the label groups. </p>
|
|
2652
2910
|
*/
|
|
2653
2911
|
LabelGroupSummaries?: LabelGroupSummary[];
|
|
2654
2912
|
}
|
|
@@ -2658,123 +2916,92 @@ export interface ListLabelGroupsResponse {
|
|
|
2658
2916
|
export interface ListLabelsRequest {
|
|
2659
2917
|
/**
|
|
2660
2918
|
* @public
|
|
2661
|
-
* <p>
|
|
2662
|
-
* Retruns the name of the label group.
|
|
2663
|
-
* </p>
|
|
2919
|
+
* <p> Retruns the name of the label group. </p>
|
|
2664
2920
|
*/
|
|
2665
2921
|
LabelGroupName: string | undefined;
|
|
2666
2922
|
/**
|
|
2667
2923
|
* @public
|
|
2668
|
-
* <p>
|
|
2669
|
-
* Returns all the labels with a end time equal to or later than the start time given.
|
|
2924
|
+
* <p> Returns all the labels with a end time equal to or later than the start time given.
|
|
2670
2925
|
* </p>
|
|
2671
2926
|
*/
|
|
2672
2927
|
IntervalStartTime?: Date;
|
|
2673
2928
|
/**
|
|
2674
2929
|
* @public
|
|
2675
|
-
* <p>
|
|
2676
|
-
* Returns all labels with a start time earlier than the end time given.
|
|
2677
|
-
* </p>
|
|
2930
|
+
* <p> Returns all labels with a start time earlier than the end time given. </p>
|
|
2678
2931
|
*/
|
|
2679
2932
|
IntervalEndTime?: Date;
|
|
2680
2933
|
/**
|
|
2681
2934
|
* @public
|
|
2682
|
-
* <p>
|
|
2683
|
-
* Returns labels with a particular fault code.
|
|
2684
|
-
* </p>
|
|
2935
|
+
* <p> Returns labels with a particular fault code. </p>
|
|
2685
2936
|
*/
|
|
2686
2937
|
FaultCode?: string;
|
|
2687
2938
|
/**
|
|
2688
2939
|
* @public
|
|
2689
|
-
* <p>
|
|
2690
|
-
* Lists the labels that pertain to a particular piece of equipment.
|
|
2691
|
-
* </p>
|
|
2940
|
+
* <p> Lists the labels that pertain to a particular piece of equipment. </p>
|
|
2692
2941
|
*/
|
|
2693
2942
|
Equipment?: string;
|
|
2694
2943
|
/**
|
|
2695
2944
|
* @public
|
|
2696
|
-
* <p>
|
|
2697
|
-
* An opaque pagination token indicating where to continue the listing of label groups.
|
|
2945
|
+
* <p> An opaque pagination token indicating where to continue the listing of label groups.
|
|
2698
2946
|
* </p>
|
|
2699
2947
|
*/
|
|
2700
2948
|
NextToken?: string;
|
|
2701
2949
|
/**
|
|
2702
2950
|
* @public
|
|
2703
|
-
* <p>
|
|
2704
|
-
* Specifies the maximum number of labels to list.
|
|
2705
|
-
* </p>
|
|
2951
|
+
* <p> Specifies the maximum number of labels to list. </p>
|
|
2706
2952
|
*/
|
|
2707
2953
|
MaxResults?: number;
|
|
2708
2954
|
}
|
|
2709
2955
|
/**
|
|
2710
2956
|
* @public
|
|
2711
|
-
* <p>
|
|
2712
|
-
* Information about the label.
|
|
2713
|
-
* </p>
|
|
2957
|
+
* <p> Information about the label. </p>
|
|
2714
2958
|
*/
|
|
2715
2959
|
export interface LabelSummary {
|
|
2716
2960
|
/**
|
|
2717
2961
|
* @public
|
|
2718
|
-
* <p>
|
|
2719
|
-
* The name of the label group.
|
|
2720
|
-
* </p>
|
|
2962
|
+
* <p> The name of the label group. </p>
|
|
2721
2963
|
*/
|
|
2722
2964
|
LabelGroupName?: string;
|
|
2723
2965
|
/**
|
|
2724
2966
|
* @public
|
|
2725
|
-
* <p>
|
|
2726
|
-
* The ID of the label.
|
|
2727
|
-
* </p>
|
|
2967
|
+
* <p> The ID of the label. </p>
|
|
2728
2968
|
*/
|
|
2729
2969
|
LabelId?: string;
|
|
2730
2970
|
/**
|
|
2731
2971
|
* @public
|
|
2732
|
-
* <p>
|
|
2733
|
-
* The Amazon Resource Name (ARN) of the label group.
|
|
2734
|
-
* </p>
|
|
2972
|
+
* <p> The Amazon Resource Name (ARN) of the label group. </p>
|
|
2735
2973
|
*/
|
|
2736
2974
|
LabelGroupArn?: string;
|
|
2737
2975
|
/**
|
|
2738
2976
|
* @public
|
|
2739
|
-
* <p>
|
|
2740
|
-
* The timestamp indicating the start of the label.
|
|
2741
|
-
* </p>
|
|
2977
|
+
* <p> The timestamp indicating the start of the label. </p>
|
|
2742
2978
|
*/
|
|
2743
2979
|
StartTime?: Date;
|
|
2744
2980
|
/**
|
|
2745
2981
|
* @public
|
|
2746
|
-
* <p>
|
|
2747
|
-
* The timestamp indicating the end of the label.
|
|
2748
|
-
* </p>
|
|
2982
|
+
* <p> The timestamp indicating the end of the label. </p>
|
|
2749
2983
|
*/
|
|
2750
2984
|
EndTime?: Date;
|
|
2751
2985
|
/**
|
|
2752
2986
|
* @public
|
|
2753
|
-
* <p>
|
|
2754
|
-
* Indicates whether a labeled event represents an anomaly.
|
|
2755
|
-
* </p>
|
|
2987
|
+
* <p> Indicates whether a labeled event represents an anomaly. </p>
|
|
2756
2988
|
*/
|
|
2757
2989
|
Rating?: LabelRating | string;
|
|
2758
2990
|
/**
|
|
2759
2991
|
* @public
|
|
2760
|
-
* <p>
|
|
2761
|
-
*
|
|
2762
|
-
*
|
|
2763
|
-
* <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.</p>
|
|
2992
|
+
* <p> Indicates the type of anomaly associated with the label. </p>
|
|
2993
|
+
* <p>Data in this field will be retained for service usage. Follow best practices for the
|
|
2994
|
+
* security of your data.</p>
|
|
2764
2995
|
*/
|
|
2765
2996
|
FaultCode?: string;
|
|
2766
2997
|
/**
|
|
2767
2998
|
* @public
|
|
2768
|
-
* <p>
|
|
2769
|
-
* Indicates that a label pertains to a particular piece of equipment.
|
|
2770
|
-
* </p>
|
|
2999
|
+
* <p> Indicates that a label pertains to a particular piece of equipment. </p>
|
|
2771
3000
|
*/
|
|
2772
3001
|
Equipment?: string;
|
|
2773
3002
|
/**
|
|
2774
3003
|
* @public
|
|
2775
|
-
* <p>
|
|
2776
|
-
* The time at which the label was created.
|
|
2777
|
-
* </p>
|
|
3004
|
+
* <p> The time at which the label was created. </p>
|
|
2778
3005
|
*/
|
|
2779
3006
|
CreatedAt?: Date;
|
|
2780
3007
|
}
|
|
@@ -2784,16 +3011,13 @@ export interface LabelSummary {
|
|
|
2784
3011
|
export interface ListLabelsResponse {
|
|
2785
3012
|
/**
|
|
2786
3013
|
* @public
|
|
2787
|
-
* <p>
|
|
2788
|
-
* An opaque pagination token indicating where to continue the listing of datasets.
|
|
3014
|
+
* <p> An opaque pagination token indicating where to continue the listing of datasets.
|
|
2789
3015
|
* </p>
|
|
2790
3016
|
*/
|
|
2791
3017
|
NextToken?: string;
|
|
2792
3018
|
/**
|
|
2793
3019
|
* @public
|
|
2794
|
-
* <p>
|
|
2795
|
-
* A summary of the items in the label group.
|
|
2796
|
-
* </p>
|
|
3020
|
+
* <p> A summary of the items in the label group. </p>
|
|
2797
3021
|
*/
|
|
2798
3022
|
LabelSummaries?: LabelSummary[];
|
|
2799
3023
|
}
|
|
@@ -2803,50 +3027,51 @@ export interface ListLabelsResponse {
|
|
|
2803
3027
|
export interface ListModelsRequest {
|
|
2804
3028
|
/**
|
|
2805
3029
|
* @public
|
|
2806
|
-
* <p> An opaque pagination token indicating where to continue the listing of
|
|
2807
|
-
*
|
|
3030
|
+
* <p> An opaque pagination token indicating where to continue the listing of machine learning
|
|
3031
|
+
* models. </p>
|
|
2808
3032
|
*/
|
|
2809
3033
|
NextToken?: string;
|
|
2810
3034
|
/**
|
|
2811
3035
|
* @public
|
|
2812
|
-
* <p> Specifies the maximum number of
|
|
3036
|
+
* <p> Specifies the maximum number of machine learning models to list. </p>
|
|
2813
3037
|
*/
|
|
2814
3038
|
MaxResults?: number;
|
|
2815
3039
|
/**
|
|
2816
3040
|
* @public
|
|
2817
|
-
* <p>The status of the
|
|
3041
|
+
* <p>The status of the machine learning model. </p>
|
|
2818
3042
|
*/
|
|
2819
3043
|
Status?: ModelStatus | string;
|
|
2820
3044
|
/**
|
|
2821
3045
|
* @public
|
|
2822
|
-
* <p>The beginning of the name of the
|
|
3046
|
+
* <p>The beginning of the name of the machine learning models being listed. </p>
|
|
2823
3047
|
*/
|
|
2824
3048
|
ModelNameBeginsWith?: string;
|
|
2825
3049
|
/**
|
|
2826
3050
|
* @public
|
|
2827
|
-
* <p>The beginning of the name of the dataset of the
|
|
3051
|
+
* <p>The beginning of the name of the dataset of the machine learning models to be listed.
|
|
3052
|
+
* </p>
|
|
2828
3053
|
*/
|
|
2829
3054
|
DatasetNameBeginsWith?: string;
|
|
2830
3055
|
}
|
|
2831
3056
|
/**
|
|
2832
3057
|
* @public
|
|
2833
|
-
* <p>Provides information about the specified
|
|
2834
|
-
* ARNs, as well as status. </p>
|
|
3058
|
+
* <p>Provides information about the specified machine learning model, including dataset and
|
|
3059
|
+
* model names and ARNs, as well as status. </p>
|
|
2835
3060
|
*/
|
|
2836
3061
|
export interface ModelSummary {
|
|
2837
3062
|
/**
|
|
2838
3063
|
* @public
|
|
2839
|
-
* <p>The name of the
|
|
3064
|
+
* <p>The name of the machine learning model. </p>
|
|
2840
3065
|
*/
|
|
2841
3066
|
ModelName?: string;
|
|
2842
3067
|
/**
|
|
2843
3068
|
* @public
|
|
2844
|
-
* <p> The Amazon Resource Name (ARN) of the
|
|
3069
|
+
* <p> The Amazon Resource Name (ARN) of the machine learning model. </p>
|
|
2845
3070
|
*/
|
|
2846
3071
|
ModelArn?: string;
|
|
2847
3072
|
/**
|
|
2848
3073
|
* @public
|
|
2849
|
-
* <p>The name of the dataset being used for the
|
|
3074
|
+
* <p>The name of the dataset being used for the machine learning model. </p>
|
|
2850
3075
|
*/
|
|
2851
3076
|
DatasetName?: string;
|
|
2852
3077
|
/**
|
|
@@ -2856,7 +3081,7 @@ export interface ModelSummary {
|
|
|
2856
3081
|
DatasetArn?: string;
|
|
2857
3082
|
/**
|
|
2858
3083
|
* @public
|
|
2859
|
-
* <p>Indicates the status of the
|
|
3084
|
+
* <p>Indicates the status of the machine learning model. </p>
|
|
2860
3085
|
*/
|
|
2861
3086
|
Status?: ModelStatus | string;
|
|
2862
3087
|
/**
|
|
@@ -2872,11 +3097,37 @@ export interface ModelSummary {
|
|
|
2872
3097
|
ActiveModelVersion?: number;
|
|
2873
3098
|
/**
|
|
2874
3099
|
* @public
|
|
2875
|
-
* <p>The Amazon Resource Name (ARN) of the model version that is set as active. The active
|
|
2876
|
-
* is the model version that the inference scheduler uses to run an inference
|
|
3100
|
+
* <p>The Amazon Resource Name (ARN) of the model version that is set as active. The active
|
|
3101
|
+
* model version is the model version that the inference scheduler uses to run an inference
|
|
2877
3102
|
* execution.</p>
|
|
2878
3103
|
*/
|
|
2879
3104
|
ActiveModelVersionArn?: string;
|
|
3105
|
+
/**
|
|
3106
|
+
* @public
|
|
3107
|
+
* <p>Indicates the status of the most recent scheduled retraining run. </p>
|
|
3108
|
+
*/
|
|
3109
|
+
LatestScheduledRetrainingStatus?: ModelVersionStatus | string;
|
|
3110
|
+
/**
|
|
3111
|
+
* @public
|
|
3112
|
+
* <p>Indicates the most recent model version that was generated by retraining. </p>
|
|
3113
|
+
*/
|
|
3114
|
+
LatestScheduledRetrainingModelVersion?: number;
|
|
3115
|
+
/**
|
|
3116
|
+
* @public
|
|
3117
|
+
* <p>Indicates the start time of the most recent scheduled retraining run. </p>
|
|
3118
|
+
*/
|
|
3119
|
+
LatestScheduledRetrainingStartTime?: Date;
|
|
3120
|
+
/**
|
|
3121
|
+
* @public
|
|
3122
|
+
* <p>Indicates the date that the next scheduled retraining run will start on. Lookout for Equipment truncates
|
|
3123
|
+
* the time you provide to <a href="https://docs.aws.amazon.com/https:/docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">the nearest UTC day</a>.</p>
|
|
3124
|
+
*/
|
|
3125
|
+
NextScheduledRetrainingStartDate?: Date;
|
|
3126
|
+
/**
|
|
3127
|
+
* @public
|
|
3128
|
+
* <p>Indicates the status of the retraining scheduler. </p>
|
|
3129
|
+
*/
|
|
3130
|
+
RetrainingSchedulerStatus?: RetrainingSchedulerStatus | string;
|
|
2880
3131
|
}
|
|
2881
3132
|
/**
|
|
2882
3133
|
* @public
|
|
@@ -2884,8 +3135,8 @@ export interface ModelSummary {
|
|
|
2884
3135
|
export interface ListModelsResponse {
|
|
2885
3136
|
/**
|
|
2886
3137
|
* @public
|
|
2887
|
-
* <p> An opaque pagination token indicating where to continue the listing of
|
|
2888
|
-
*
|
|
3138
|
+
* <p> An opaque pagination token indicating where to continue the listing of machine learning
|
|
3139
|
+
* models. </p>
|
|
2889
3140
|
*/
|
|
2890
3141
|
NextToken?: string;
|
|
2891
3142
|
/**
|
|
@@ -2901,16 +3152,16 @@ export interface ListModelsResponse {
|
|
|
2901
3152
|
export interface ListModelVersionsRequest {
|
|
2902
3153
|
/**
|
|
2903
3154
|
* @public
|
|
2904
|
-
* <p>Then name of the machine learning model for which the
|
|
2905
|
-
*
|
|
3155
|
+
* <p>Then name of the machine learning model for which the model versions are to be
|
|
3156
|
+
* listed.</p>
|
|
2906
3157
|
*/
|
|
2907
3158
|
ModelName: string | undefined;
|
|
2908
3159
|
/**
|
|
2909
3160
|
* @public
|
|
2910
|
-
* <p>If the total number of results exceeds the limit that the response can
|
|
2911
|
-
*
|
|
2912
|
-
*
|
|
2913
|
-
*
|
|
3161
|
+
* <p>If the total number of results exceeds the limit that the response can display, the
|
|
3162
|
+
* response returns an opaque pagination token indicating where to continue the listing of
|
|
3163
|
+
* machine learning model versions. Use this token in the <code>NextToken</code> field in the
|
|
3164
|
+
* request to list the next page of results.</p>
|
|
2914
3165
|
*/
|
|
2915
3166
|
NextToken?: string;
|
|
2916
3167
|
/**
|
|
@@ -2961,7 +3212,8 @@ export interface ModelVersionSummary {
|
|
|
2961
3212
|
ModelName?: string;
|
|
2962
3213
|
/**
|
|
2963
3214
|
* @public
|
|
2964
|
-
* <p>The Amazon Resource Name (ARN) of the model that this model version is a version
|
|
3215
|
+
* <p>The Amazon Resource Name (ARN) of the model that this model version is a version
|
|
3216
|
+
* of.</p>
|
|
2965
3217
|
*/
|
|
2966
3218
|
ModelArn?: string;
|
|
2967
3219
|
/**
|
|
@@ -2996,19 +3248,103 @@ export interface ModelVersionSummary {
|
|
|
2996
3248
|
export interface ListModelVersionsResponse {
|
|
2997
3249
|
/**
|
|
2998
3250
|
* @public
|
|
2999
|
-
* <p>If the total number of results exceeds the limit that the response can
|
|
3000
|
-
*
|
|
3001
|
-
*
|
|
3002
|
-
*
|
|
3251
|
+
* <p>If the total number of results exceeds the limit that the response can display, the
|
|
3252
|
+
* response returns an opaque pagination token indicating where to continue the listing of
|
|
3253
|
+
* machine learning model versions. Use this token in the <code>NextToken</code> field in the
|
|
3254
|
+
* request to list the next page of results.</p>
|
|
3003
3255
|
*/
|
|
3004
3256
|
NextToken?: string;
|
|
3005
3257
|
/**
|
|
3006
3258
|
* @public
|
|
3007
|
-
* <p>Provides information on the specified model version,
|
|
3008
|
-
*
|
|
3259
|
+
* <p>Provides information on the specified model version, including the created time, model
|
|
3260
|
+
* and dataset ARNs, and status.</p>
|
|
3009
3261
|
*/
|
|
3010
3262
|
ModelVersionSummaries?: ModelVersionSummary[];
|
|
3011
3263
|
}
|
|
3264
|
+
/**
|
|
3265
|
+
* @public
|
|
3266
|
+
*/
|
|
3267
|
+
export interface ListRetrainingSchedulersRequest {
|
|
3268
|
+
/**
|
|
3269
|
+
* @public
|
|
3270
|
+
* <p>Specify this field to only list retraining schedulers whose machine learning models
|
|
3271
|
+
* begin with the value you specify. </p>
|
|
3272
|
+
*/
|
|
3273
|
+
ModelNameBeginsWith?: string;
|
|
3274
|
+
/**
|
|
3275
|
+
* @public
|
|
3276
|
+
* <p>Specify this field to only list retraining schedulers whose status matches the value you
|
|
3277
|
+
* specify. </p>
|
|
3278
|
+
*/
|
|
3279
|
+
Status?: RetrainingSchedulerStatus | string;
|
|
3280
|
+
/**
|
|
3281
|
+
* @public
|
|
3282
|
+
* <p>If the number of results exceeds the maximum, a pagination token is returned. Use the
|
|
3283
|
+
* token in the request to show the next page of retraining schedulers.</p>
|
|
3284
|
+
*/
|
|
3285
|
+
NextToken?: string;
|
|
3286
|
+
/**
|
|
3287
|
+
* @public
|
|
3288
|
+
* <p>Specifies the maximum number of retraining schedulers to list. </p>
|
|
3289
|
+
*/
|
|
3290
|
+
MaxResults?: number;
|
|
3291
|
+
}
|
|
3292
|
+
/**
|
|
3293
|
+
* @public
|
|
3294
|
+
* <p>Provides information about the specified retraining scheduler, including model name,
|
|
3295
|
+
* status, start date, frequency, and lookback window. </p>
|
|
3296
|
+
*/
|
|
3297
|
+
export interface RetrainingSchedulerSummary {
|
|
3298
|
+
/**
|
|
3299
|
+
* @public
|
|
3300
|
+
* <p>The name of the model that the retraining scheduler is attached to. </p>
|
|
3301
|
+
*/
|
|
3302
|
+
ModelName?: string;
|
|
3303
|
+
/**
|
|
3304
|
+
* @public
|
|
3305
|
+
* <p>The ARN of the model that the retraining scheduler is attached to. </p>
|
|
3306
|
+
*/
|
|
3307
|
+
ModelArn?: string;
|
|
3308
|
+
/**
|
|
3309
|
+
* @public
|
|
3310
|
+
* <p>The status of the retraining scheduler. </p>
|
|
3311
|
+
*/
|
|
3312
|
+
Status?: RetrainingSchedulerStatus | string;
|
|
3313
|
+
/**
|
|
3314
|
+
* @public
|
|
3315
|
+
* <p>The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the
|
|
3316
|
+
* nearest UTC day.</p>
|
|
3317
|
+
*/
|
|
3318
|
+
RetrainingStartDate?: Date;
|
|
3319
|
+
/**
|
|
3320
|
+
* @public
|
|
3321
|
+
* <p>The frequency at which the model retraining is set. This follows the <a href="https://en.wikipedia.org/wiki/ISO_8601#Durations">ISO 8601</a>
|
|
3322
|
+
* guidelines.</p>
|
|
3323
|
+
*/
|
|
3324
|
+
RetrainingFrequency?: string;
|
|
3325
|
+
/**
|
|
3326
|
+
* @public
|
|
3327
|
+
* <p>The number of past days of data used for retraining.</p>
|
|
3328
|
+
*/
|
|
3329
|
+
LookbackWindow?: string;
|
|
3330
|
+
}
|
|
3331
|
+
/**
|
|
3332
|
+
* @public
|
|
3333
|
+
*/
|
|
3334
|
+
export interface ListRetrainingSchedulersResponse {
|
|
3335
|
+
/**
|
|
3336
|
+
* @public
|
|
3337
|
+
* <p>Provides information on the specified retraining scheduler, including the model name,
|
|
3338
|
+
* model ARN, status, and start date. </p>
|
|
3339
|
+
*/
|
|
3340
|
+
RetrainingSchedulerSummaries?: RetrainingSchedulerSummary[];
|
|
3341
|
+
/**
|
|
3342
|
+
* @public
|
|
3343
|
+
* <p>If the number of results exceeds the maximum, this pagination token is returned. Use
|
|
3344
|
+
* this token in the request to show the next page of retraining schedulers.</p>
|
|
3345
|
+
*/
|
|
3346
|
+
NextToken?: string;
|
|
3347
|
+
}
|
|
3012
3348
|
/**
|
|
3013
3349
|
* @public
|
|
3014
3350
|
*/
|
|
@@ -3276,8 +3612,8 @@ export interface ListTagsForResourceResponse {
|
|
|
3276
3612
|
export interface PutResourcePolicyRequest {
|
|
3277
3613
|
/**
|
|
3278
3614
|
* @public
|
|
3279
|
-
* <p>The Amazon Resource Name (ARN) of the resource for which the
|
|
3280
|
-
*
|
|
3615
|
+
* <p>The Amazon Resource Name (ARN) of the resource for which the policy is being
|
|
3616
|
+
* created.</p>
|
|
3281
3617
|
*/
|
|
3282
3618
|
ResourceArn: string | undefined;
|
|
3283
3619
|
/**
|
|
@@ -3292,9 +3628,8 @@ export interface PutResourcePolicyRequest {
|
|
|
3292
3628
|
PolicyRevisionId?: string;
|
|
3293
3629
|
/**
|
|
3294
3630
|
* @public
|
|
3295
|
-
* <p>A unique identifier for the request.
|
|
3296
|
-
*
|
|
3297
|
-
* generates one. </p>
|
|
3631
|
+
* <p>A unique identifier for the request. If you do not set the client request token,
|
|
3632
|
+
* Amazon Lookout for Equipment generates one. </p>
|
|
3298
3633
|
*/
|
|
3299
3634
|
ClientToken?: string;
|
|
3300
3635
|
}
|
|
@@ -3304,8 +3639,7 @@ export interface PutResourcePolicyRequest {
|
|
|
3304
3639
|
export interface PutResourcePolicyResponse {
|
|
3305
3640
|
/**
|
|
3306
3641
|
* @public
|
|
3307
|
-
* <p>The Amazon Resource Name (ARN) of the resource for which the
|
|
3308
|
-
* policy was created.</p>
|
|
3642
|
+
* <p>The Amazon Resource Name (ARN) of the resource for which the policy was created.</p>
|
|
3309
3643
|
*/
|
|
3310
3644
|
ResourceArn?: string;
|
|
3311
3645
|
/**
|
|
@@ -3373,13 +3707,13 @@ export interface StartInferenceSchedulerRequest {
|
|
|
3373
3707
|
export interface StartInferenceSchedulerResponse {
|
|
3374
3708
|
/**
|
|
3375
3709
|
* @public
|
|
3376
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
3377
|
-
*
|
|
3710
|
+
* <p>The Amazon Resource Name (ARN) of the machine learning model being used by the inference
|
|
3711
|
+
* scheduler. </p>
|
|
3378
3712
|
*/
|
|
3379
3713
|
ModelArn?: string;
|
|
3380
3714
|
/**
|
|
3381
3715
|
* @public
|
|
3382
|
-
* <p>The name of the
|
|
3716
|
+
* <p>The name of the machine learning model being used by the inference scheduler. </p>
|
|
3383
3717
|
*/
|
|
3384
3718
|
ModelName?: string;
|
|
3385
3719
|
/**
|
|
@@ -3398,6 +3732,36 @@ export interface StartInferenceSchedulerResponse {
|
|
|
3398
3732
|
*/
|
|
3399
3733
|
Status?: InferenceSchedulerStatus | string;
|
|
3400
3734
|
}
|
|
3735
|
+
/**
|
|
3736
|
+
* @public
|
|
3737
|
+
*/
|
|
3738
|
+
export interface StartRetrainingSchedulerRequest {
|
|
3739
|
+
/**
|
|
3740
|
+
* @public
|
|
3741
|
+
* <p>The name of the model whose retraining scheduler you want to start.</p>
|
|
3742
|
+
*/
|
|
3743
|
+
ModelName: string | undefined;
|
|
3744
|
+
}
|
|
3745
|
+
/**
|
|
3746
|
+
* @public
|
|
3747
|
+
*/
|
|
3748
|
+
export interface StartRetrainingSchedulerResponse {
|
|
3749
|
+
/**
|
|
3750
|
+
* @public
|
|
3751
|
+
* <p>The name of the model whose retraining scheduler is being started. </p>
|
|
3752
|
+
*/
|
|
3753
|
+
ModelName?: string;
|
|
3754
|
+
/**
|
|
3755
|
+
* @public
|
|
3756
|
+
* <p>The ARN of the model whose retraining scheduler is being started. </p>
|
|
3757
|
+
*/
|
|
3758
|
+
ModelArn?: string;
|
|
3759
|
+
/**
|
|
3760
|
+
* @public
|
|
3761
|
+
* <p>The status of the retraining scheduler. </p>
|
|
3762
|
+
*/
|
|
3763
|
+
Status?: RetrainingSchedulerStatus | string;
|
|
3764
|
+
}
|
|
3401
3765
|
/**
|
|
3402
3766
|
* @public
|
|
3403
3767
|
*/
|
|
@@ -3414,13 +3778,14 @@ export interface StopInferenceSchedulerRequest {
|
|
|
3414
3778
|
export interface StopInferenceSchedulerResponse {
|
|
3415
3779
|
/**
|
|
3416
3780
|
* @public
|
|
3417
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
3418
|
-
* stopped. </p>
|
|
3781
|
+
* <p>The Amazon Resource Name (ARN) of the machine learning model used by the inference
|
|
3782
|
+
* scheduler being stopped. </p>
|
|
3419
3783
|
*/
|
|
3420
3784
|
ModelArn?: string;
|
|
3421
3785
|
/**
|
|
3422
3786
|
* @public
|
|
3423
|
-
* <p>The name of the
|
|
3787
|
+
* <p>The name of the machine learning model used by the inference scheduler being stopped.
|
|
3788
|
+
* </p>
|
|
3424
3789
|
*/
|
|
3425
3790
|
ModelName?: string;
|
|
3426
3791
|
/**
|
|
@@ -3439,6 +3804,36 @@ export interface StopInferenceSchedulerResponse {
|
|
|
3439
3804
|
*/
|
|
3440
3805
|
Status?: InferenceSchedulerStatus | string;
|
|
3441
3806
|
}
|
|
3807
|
+
/**
|
|
3808
|
+
* @public
|
|
3809
|
+
*/
|
|
3810
|
+
export interface StopRetrainingSchedulerRequest {
|
|
3811
|
+
/**
|
|
3812
|
+
* @public
|
|
3813
|
+
* <p>The name of the model whose retraining scheduler you want to stop.</p>
|
|
3814
|
+
*/
|
|
3815
|
+
ModelName: string | undefined;
|
|
3816
|
+
}
|
|
3817
|
+
/**
|
|
3818
|
+
* @public
|
|
3819
|
+
*/
|
|
3820
|
+
export interface StopRetrainingSchedulerResponse {
|
|
3821
|
+
/**
|
|
3822
|
+
* @public
|
|
3823
|
+
* <p>The name of the model whose retraining scheduler is being stopped. </p>
|
|
3824
|
+
*/
|
|
3825
|
+
ModelName?: string;
|
|
3826
|
+
/**
|
|
3827
|
+
* @public
|
|
3828
|
+
* <p>The ARN of the model whose retraining scheduler is being stopped. </p>
|
|
3829
|
+
*/
|
|
3830
|
+
ModelArn?: string;
|
|
3831
|
+
/**
|
|
3832
|
+
* @public
|
|
3833
|
+
* <p>The status of the retraining scheduler. </p>
|
|
3834
|
+
*/
|
|
3835
|
+
Status?: RetrainingSchedulerStatus | string;
|
|
3836
|
+
}
|
|
3442
3837
|
/**
|
|
3443
3838
|
* @public
|
|
3444
3839
|
*/
|
|
@@ -3488,14 +3883,14 @@ export interface UntagResourceResponse {
|
|
|
3488
3883
|
export interface UpdateActiveModelVersionRequest {
|
|
3489
3884
|
/**
|
|
3490
3885
|
* @public
|
|
3491
|
-
* <p>The name of the machine learning model for which the active model version
|
|
3492
|
-
*
|
|
3886
|
+
* <p>The name of the machine learning model for which the active model version is being
|
|
3887
|
+
* set.</p>
|
|
3493
3888
|
*/
|
|
3494
3889
|
ModelName: string | undefined;
|
|
3495
3890
|
/**
|
|
3496
3891
|
* @public
|
|
3497
|
-
* <p>The version of the machine learning model for which the active model version
|
|
3498
|
-
*
|
|
3892
|
+
* <p>The version of the machine learning model for which the active model version is being
|
|
3893
|
+
* set.</p>
|
|
3499
3894
|
*/
|
|
3500
3895
|
ModelVersion: number | undefined;
|
|
3501
3896
|
}
|
|
@@ -3505,37 +3900,38 @@ export interface UpdateActiveModelVersionRequest {
|
|
|
3505
3900
|
export interface UpdateActiveModelVersionResponse {
|
|
3506
3901
|
/**
|
|
3507
3902
|
* @public
|
|
3508
|
-
* <p>The name of the machine learning model for which the active model version was
|
|
3903
|
+
* <p>The name of the machine learning model for which the active model version was
|
|
3904
|
+
* set.</p>
|
|
3509
3905
|
*/
|
|
3510
3906
|
ModelName?: string;
|
|
3511
3907
|
/**
|
|
3512
3908
|
* @public
|
|
3513
|
-
* <p>The Amazon Resource Name (ARN) of the machine learning model for which
|
|
3514
|
-
*
|
|
3909
|
+
* <p>The Amazon Resource Name (ARN) of the machine learning model for which the active model
|
|
3910
|
+
* version was set.</p>
|
|
3515
3911
|
*/
|
|
3516
3912
|
ModelArn?: string;
|
|
3517
3913
|
/**
|
|
3518
3914
|
* @public
|
|
3519
|
-
* <p>The version that is currently active of the machine learning model
|
|
3520
|
-
*
|
|
3915
|
+
* <p>The version that is currently active of the machine learning model for which the active
|
|
3916
|
+
* model version was set.</p>
|
|
3521
3917
|
*/
|
|
3522
3918
|
CurrentActiveVersion?: number;
|
|
3523
3919
|
/**
|
|
3524
3920
|
* @public
|
|
3525
|
-
* <p>The previous version that was active of the machine learning model
|
|
3526
|
-
*
|
|
3921
|
+
* <p>The previous version that was active of the machine learning model for which the active
|
|
3922
|
+
* model version was set.</p>
|
|
3527
3923
|
*/
|
|
3528
3924
|
PreviousActiveVersion?: number;
|
|
3529
3925
|
/**
|
|
3530
3926
|
* @public
|
|
3531
|
-
* <p>The Amazon Resource Name (ARN) of the machine learning model version that is the
|
|
3532
|
-
*
|
|
3927
|
+
* <p>The Amazon Resource Name (ARN) of the machine learning model version that is the current
|
|
3928
|
+
* active model version.</p>
|
|
3533
3929
|
*/
|
|
3534
3930
|
CurrentActiveVersionArn?: string;
|
|
3535
3931
|
/**
|
|
3536
3932
|
* @public
|
|
3537
3933
|
* <p>The Amazon Resource Name (ARN) of the machine learning model version that was the
|
|
3538
|
-
*
|
|
3934
|
+
* previous active model version.</p>
|
|
3539
3935
|
*/
|
|
3540
3936
|
PreviousActiveVersionArn?: string;
|
|
3541
3937
|
}
|
|
@@ -3564,8 +3960,8 @@ export interface UpdateInferenceSchedulerRequest {
|
|
|
3564
3960
|
* <p>How often data is uploaded to the source S3 bucket for the input data. The value chosen
|
|
3565
3961
|
* is the length of time between data uploads. For instance, if you select 5 minutes, Amazon
|
|
3566
3962
|
* Lookout for Equipment will upload the real-time data to the source bucket once every 5
|
|
3567
|
-
* minutes. This frequency also determines how often Amazon Lookout for Equipment starts a
|
|
3568
|
-
*
|
|
3963
|
+
* minutes. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on
|
|
3964
|
+
* your data. In this example, it starts once every 5 minutes. </p>
|
|
3569
3965
|
*/
|
|
3570
3966
|
DataUploadFrequency?: DataUploadFrequency | string;
|
|
3571
3967
|
/**
|
|
@@ -3593,17 +3989,83 @@ export interface UpdateInferenceSchedulerRequest {
|
|
|
3593
3989
|
export interface UpdateLabelGroupRequest {
|
|
3594
3990
|
/**
|
|
3595
3991
|
* @public
|
|
3596
|
-
* <p>
|
|
3597
|
-
* The name of the label group to be updated.
|
|
3598
|
-
* </p>
|
|
3992
|
+
* <p> The name of the label group to be updated. </p>
|
|
3599
3993
|
*/
|
|
3600
3994
|
LabelGroupName: string | undefined;
|
|
3601
3995
|
/**
|
|
3602
3996
|
* @public
|
|
3603
|
-
* <p>
|
|
3604
|
-
*
|
|
3605
|
-
*
|
|
3606
|
-
* <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.</p>
|
|
3997
|
+
* <p> Updates the code indicating the type of anomaly associated with the label. </p>
|
|
3998
|
+
* <p>Data in this field will be retained for service usage. Follow best practices for the
|
|
3999
|
+
* security of your data.</p>
|
|
3607
4000
|
*/
|
|
3608
4001
|
FaultCodes?: string[];
|
|
3609
4002
|
}
|
|
4003
|
+
/**
|
|
4004
|
+
* @public
|
|
4005
|
+
*/
|
|
4006
|
+
export interface UpdateModelRequest {
|
|
4007
|
+
/**
|
|
4008
|
+
* @public
|
|
4009
|
+
* <p>The name of the model to update.</p>
|
|
4010
|
+
*/
|
|
4011
|
+
ModelName: string | undefined;
|
|
4012
|
+
/**
|
|
4013
|
+
* @public
|
|
4014
|
+
* <p>Contains the configuration information for the S3 location being used to hold label
|
|
4015
|
+
* data. </p>
|
|
4016
|
+
*/
|
|
4017
|
+
LabelsInputConfiguration?: LabelsInputConfiguration;
|
|
4018
|
+
/**
|
|
4019
|
+
* @public
|
|
4020
|
+
* <p>The ARN of the model to update.</p>
|
|
4021
|
+
*/
|
|
4022
|
+
RoleArn?: string;
|
|
4023
|
+
}
|
|
4024
|
+
/**
|
|
4025
|
+
* @public
|
|
4026
|
+
*/
|
|
4027
|
+
export interface UpdateRetrainingSchedulerRequest {
|
|
4028
|
+
/**
|
|
4029
|
+
* @public
|
|
4030
|
+
* <p>The name of the model whose retraining scheduler you want to update. </p>
|
|
4031
|
+
*/
|
|
4032
|
+
ModelName: string | undefined;
|
|
4033
|
+
/**
|
|
4034
|
+
* @public
|
|
4035
|
+
* <p>The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the
|
|
4036
|
+
* nearest UTC day.</p>
|
|
4037
|
+
*/
|
|
4038
|
+
RetrainingStartDate?: Date;
|
|
4039
|
+
/**
|
|
4040
|
+
* @public
|
|
4041
|
+
* <p>This parameter uses the <a href="https://en.wikipedia.org/wiki/ISO_8601#Durations">ISO 8601</a> standard to set the frequency at which you want retraining to occur in
|
|
4042
|
+
* terms of Years, Months, and/or Days (note: other parameters like Time are not currently
|
|
4043
|
+
* supported). The minimum value is 30 days (P30D) and the maximum value is 1 year (P1Y). For
|
|
4044
|
+
* example, the following values are valid:</p>
|
|
4045
|
+
* <ul>
|
|
4046
|
+
* <li>
|
|
4047
|
+
* <p>P3M15D – Every 3 months and 15 days</p>
|
|
4048
|
+
* </li>
|
|
4049
|
+
* <li>
|
|
4050
|
+
* <p>P2M – Every 2 months</p>
|
|
4051
|
+
* </li>
|
|
4052
|
+
* <li>
|
|
4053
|
+
* <p>P150D – Every 150 days</p>
|
|
4054
|
+
* </li>
|
|
4055
|
+
* </ul>
|
|
4056
|
+
*/
|
|
4057
|
+
RetrainingFrequency?: string;
|
|
4058
|
+
/**
|
|
4059
|
+
* @public
|
|
4060
|
+
* <p>The number of past days of data that will be used for retraining.</p>
|
|
4061
|
+
*/
|
|
4062
|
+
LookbackWindow?: string;
|
|
4063
|
+
/**
|
|
4064
|
+
* @public
|
|
4065
|
+
* <p>Indicates how the service will use new models. In <code>MANAGED</code> mode, new models
|
|
4066
|
+
* will automatically be used for inference if they have better performance than the current
|
|
4067
|
+
* model. In <code>MANUAL</code> mode, the new models will not be used <a href="https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/versioning-model.html#model-activation">until they
|
|
4068
|
+
* are manually activated</a>.</p>
|
|
4069
|
+
*/
|
|
4070
|
+
PromoteMode?: ModelPromoteMode | string;
|
|
4071
|
+
}
|