@aws-sdk/client-iot-events-data 3.533.0 → 3.535.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/IoTEventsData.d.ts +1 -1
- package/dist-types/IoTEventsDataClient.d.ts +1 -1
- package/dist-types/commands/BatchAcknowledgeAlarmCommand.d.ts +2 -1
- package/dist-types/commands/BatchDeleteDetectorCommand.d.ts +2 -1
- package/dist-types/commands/BatchDisableAlarmCommand.d.ts +2 -1
- package/dist-types/commands/BatchEnableAlarmCommand.d.ts +2 -1
- package/dist-types/commands/BatchPutMessageCommand.d.ts +2 -1
- package/dist-types/commands/BatchResetAlarmCommand.d.ts +2 -1
- package/dist-types/commands/BatchSnoozeAlarmCommand.d.ts +2 -1
- package/dist-types/commands/BatchUpdateDetectorCommand.d.ts +2 -1
- package/dist-types/commands/DescribeAlarmCommand.d.ts +2 -1
- package/dist-types/commands/DescribeDetectorCommand.d.ts +2 -1
- package/dist-types/commands/ListAlarmsCommand.d.ts +2 -1
- package/dist-types/commands/ListDetectorsCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +181 -181
- package/dist-types/ts3.4/commands/BatchAcknowledgeAlarmCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/BatchDeleteDetectorCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/BatchDisableAlarmCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/BatchEnableAlarmCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/BatchPutMessageCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/BatchResetAlarmCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/BatchSnoozeAlarmCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/BatchUpdateDetectorCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeAlarmCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeDetectorCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListAlarmsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListDetectorsCommand.d.ts +9 -0
- package/package.json +40 -40
|
@@ -1,40 +1,40 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { IoTEventsDataServiceException as __BaseException } from "./IoTEventsDataServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>Contains the configuration information of an acknowledge action.</p>
|
|
5
|
+
* @public
|
|
6
6
|
*/
|
|
7
7
|
export interface AcknowledgeActionConfiguration {
|
|
8
8
|
/**
|
|
9
|
-
* @public
|
|
10
9
|
* <p>The note that you can leave when you acknowledge the alarm.</p>
|
|
10
|
+
* @public
|
|
11
11
|
*/
|
|
12
12
|
note?: string;
|
|
13
13
|
}
|
|
14
14
|
/**
|
|
15
|
-
* @public
|
|
16
15
|
* <p>Information needed to acknowledge the alarm.</p>
|
|
16
|
+
* @public
|
|
17
17
|
*/
|
|
18
18
|
export interface AcknowledgeAlarmActionRequest {
|
|
19
19
|
/**
|
|
20
|
-
* @public
|
|
21
20
|
* <p>The request ID. Each ID must be unique within each batch.</p>
|
|
21
|
+
* @public
|
|
22
22
|
*/
|
|
23
23
|
requestId: string | undefined;
|
|
24
24
|
/**
|
|
25
|
-
* @public
|
|
26
25
|
* <p>The name of the alarm model.</p>
|
|
26
|
+
* @public
|
|
27
27
|
*/
|
|
28
28
|
alarmModelName: string | undefined;
|
|
29
29
|
/**
|
|
30
|
-
* @public
|
|
31
30
|
* <p>The value of the key used as a filter to select only the alarms associated with the
|
|
32
31
|
* <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key">key</a>.</p>
|
|
32
|
+
* @public
|
|
33
33
|
*/
|
|
34
34
|
keyValue?: string;
|
|
35
35
|
/**
|
|
36
|
-
* @public
|
|
37
36
|
* <p>The note that you can leave when you acknowledge the alarm.</p>
|
|
37
|
+
* @public
|
|
38
38
|
*/
|
|
39
39
|
note?: string;
|
|
40
40
|
}
|
|
@@ -54,61 +54,60 @@ export declare const CustomerActionName: {
|
|
|
54
54
|
*/
|
|
55
55
|
export type CustomerActionName = (typeof CustomerActionName)[keyof typeof CustomerActionName];
|
|
56
56
|
/**
|
|
57
|
-
* @public
|
|
58
57
|
* <p>Contains the configuration information of a disable action.</p>
|
|
58
|
+
* @public
|
|
59
59
|
*/
|
|
60
60
|
export interface DisableActionConfiguration {
|
|
61
61
|
/**
|
|
62
|
-
* @public
|
|
63
62
|
* <p>The note that you can leave when you disable the alarm.</p>
|
|
63
|
+
* @public
|
|
64
64
|
*/
|
|
65
65
|
note?: string;
|
|
66
66
|
}
|
|
67
67
|
/**
|
|
68
|
-
* @public
|
|
69
68
|
* <p>Contains the configuration information of an enable action.</p>
|
|
69
|
+
* @public
|
|
70
70
|
*/
|
|
71
71
|
export interface EnableActionConfiguration {
|
|
72
72
|
/**
|
|
73
|
-
* @public
|
|
74
73
|
* <p>The note that you can leave when you enable the alarm.</p>
|
|
74
|
+
* @public
|
|
75
75
|
*/
|
|
76
76
|
note?: string;
|
|
77
77
|
}
|
|
78
78
|
/**
|
|
79
|
-
* @public
|
|
80
79
|
* <p>Contains the configuration information of a reset action.</p>
|
|
80
|
+
* @public
|
|
81
81
|
*/
|
|
82
82
|
export interface ResetActionConfiguration {
|
|
83
83
|
/**
|
|
84
|
-
* @public
|
|
85
84
|
* <p>The note that you can leave when you reset the alarm.</p>
|
|
85
|
+
* @public
|
|
86
86
|
*/
|
|
87
87
|
note?: string;
|
|
88
88
|
}
|
|
89
89
|
/**
|
|
90
|
-
* @public
|
|
91
90
|
* <p>Contains the configuration information of a snooze action.</p>
|
|
91
|
+
* @public
|
|
92
92
|
*/
|
|
93
93
|
export interface SnoozeActionConfiguration {
|
|
94
94
|
/**
|
|
95
|
-
* @public
|
|
96
95
|
* <p>The snooze time in seconds. The alarm automatically changes to the <code>NORMAL</code> state after this duration.</p>
|
|
96
|
+
* @public
|
|
97
97
|
*/
|
|
98
98
|
snoozeDuration?: number;
|
|
99
99
|
/**
|
|
100
|
-
* @public
|
|
101
100
|
* <p>The note that you can leave when you snooze the alarm.</p>
|
|
101
|
+
* @public
|
|
102
102
|
*/
|
|
103
103
|
note?: string;
|
|
104
104
|
}
|
|
105
105
|
/**
|
|
106
|
-
* @public
|
|
107
106
|
* <p>Contains information about the action that you can take to respond to the alarm.</p>
|
|
107
|
+
* @public
|
|
108
108
|
*/
|
|
109
109
|
export interface CustomerAction {
|
|
110
110
|
/**
|
|
111
|
-
* @public
|
|
112
111
|
* <p>The name of the action. The action name can be one of the following values:</p>
|
|
113
112
|
* <ul>
|
|
114
113
|
* <li>
|
|
@@ -133,31 +132,32 @@ export interface CustomerAction {
|
|
|
133
132
|
* </li>
|
|
134
133
|
* </ul>
|
|
135
134
|
* <p>For more information, see the <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_AlarmState.html">AlarmState</a> API.</p>
|
|
135
|
+
* @public
|
|
136
136
|
*/
|
|
137
137
|
actionName?: CustomerActionName;
|
|
138
138
|
/**
|
|
139
|
-
* @public
|
|
140
139
|
* <p>Contains the configuration information of a snooze action.</p>
|
|
140
|
+
* @public
|
|
141
141
|
*/
|
|
142
142
|
snoozeActionConfiguration?: SnoozeActionConfiguration;
|
|
143
143
|
/**
|
|
144
|
-
* @public
|
|
145
144
|
* <p>Contains the configuration information of an enable action.</p>
|
|
145
|
+
* @public
|
|
146
146
|
*/
|
|
147
147
|
enableActionConfiguration?: EnableActionConfiguration;
|
|
148
148
|
/**
|
|
149
|
-
* @public
|
|
150
149
|
* <p>Contains the configuration information of a disable action.</p>
|
|
150
|
+
* @public
|
|
151
151
|
*/
|
|
152
152
|
disableActionConfiguration?: DisableActionConfiguration;
|
|
153
153
|
/**
|
|
154
|
-
* @public
|
|
155
154
|
* <p>Contains the configuration information of an acknowledge action.</p>
|
|
155
|
+
* @public
|
|
156
156
|
*/
|
|
157
157
|
acknowledgeActionConfiguration?: AcknowledgeActionConfiguration;
|
|
158
158
|
/**
|
|
159
|
-
* @public
|
|
160
159
|
* <p>Contains the configuration information of a reset action.</p>
|
|
160
|
+
* @public
|
|
161
161
|
*/
|
|
162
162
|
resetActionConfiguration?: ResetActionConfiguration;
|
|
163
163
|
}
|
|
@@ -178,34 +178,34 @@ export declare const ComparisonOperator: {
|
|
|
178
178
|
*/
|
|
179
179
|
export type ComparisonOperator = (typeof ComparisonOperator)[keyof typeof ComparisonOperator];
|
|
180
180
|
/**
|
|
181
|
-
* @public
|
|
182
181
|
* <p>Information needed to compare two values with a comparison operator.</p>
|
|
182
|
+
* @public
|
|
183
183
|
*/
|
|
184
184
|
export interface SimpleRuleEvaluation {
|
|
185
185
|
/**
|
|
186
|
-
* @public
|
|
187
186
|
* <p>The value of the input property, on the left side of the comparison operator.</p>
|
|
187
|
+
* @public
|
|
188
188
|
*/
|
|
189
189
|
inputPropertyValue?: string;
|
|
190
190
|
/**
|
|
191
|
-
* @public
|
|
192
191
|
* <p>The comparison operator.</p>
|
|
192
|
+
* @public
|
|
193
193
|
*/
|
|
194
194
|
operator?: ComparisonOperator;
|
|
195
195
|
/**
|
|
196
|
-
* @public
|
|
197
196
|
* <p>The threshold value, on the right side of the comparison operator.</p>
|
|
197
|
+
* @public
|
|
198
198
|
*/
|
|
199
199
|
thresholdValue?: string;
|
|
200
200
|
}
|
|
201
201
|
/**
|
|
202
|
-
* @public
|
|
203
202
|
* <p>Information needed to evaluate data.</p>
|
|
203
|
+
* @public
|
|
204
204
|
*/
|
|
205
205
|
export interface RuleEvaluation {
|
|
206
206
|
/**
|
|
207
|
-
* @public
|
|
208
207
|
* <p>Information needed to compare two values with a comparison operator.</p>
|
|
208
|
+
* @public
|
|
209
209
|
*/
|
|
210
210
|
simpleRuleEvaluation?: SimpleRuleEvaluation;
|
|
211
211
|
}
|
|
@@ -248,41 +248,40 @@ export declare const TriggerType: {
|
|
|
248
248
|
*/
|
|
249
249
|
export type TriggerType = (typeof TriggerType)[keyof typeof TriggerType];
|
|
250
250
|
/**
|
|
251
|
-
* @public
|
|
252
251
|
* <p>Contains the configuration information of alarm state changes.</p>
|
|
252
|
+
* @public
|
|
253
253
|
*/
|
|
254
254
|
export interface StateChangeConfiguration {
|
|
255
255
|
/**
|
|
256
|
-
* @public
|
|
257
256
|
* <p>The trigger type. If the value is <code>SNOOZE_TIMEOUT</code>, the snooze duration ends
|
|
258
257
|
* and the alarm automatically changes to the <code>NORMAL</code> state.</p>
|
|
258
|
+
* @public
|
|
259
259
|
*/
|
|
260
260
|
triggerType?: TriggerType;
|
|
261
261
|
}
|
|
262
262
|
/**
|
|
263
|
-
* @public
|
|
264
263
|
* <p>Contains information about alarm state changes.</p>
|
|
264
|
+
* @public
|
|
265
265
|
*/
|
|
266
266
|
export interface SystemEvent {
|
|
267
267
|
/**
|
|
268
|
-
* @public
|
|
269
268
|
* <p>The event type. If the value is <code>STATE_CHANGE</code>, the event contains information
|
|
270
269
|
* about alarm state changes.</p>
|
|
270
|
+
* @public
|
|
271
271
|
*/
|
|
272
272
|
eventType?: EventType;
|
|
273
273
|
/**
|
|
274
|
-
* @public
|
|
275
274
|
* <p>Contains the configuration information of alarm state changes.</p>
|
|
275
|
+
* @public
|
|
276
276
|
*/
|
|
277
277
|
stateChangeConfiguration?: StateChangeConfiguration;
|
|
278
278
|
}
|
|
279
279
|
/**
|
|
280
|
-
* @public
|
|
281
280
|
* <p>Contains information about the current state of the alarm.</p>
|
|
281
|
+
* @public
|
|
282
282
|
*/
|
|
283
283
|
export interface AlarmState {
|
|
284
284
|
/**
|
|
285
|
-
* @public
|
|
286
285
|
* <p>The name of the alarm state. The state name can be one of the following values:</p>
|
|
287
286
|
* <ul>
|
|
288
287
|
* <li>
|
|
@@ -319,89 +318,89 @@ export interface AlarmState {
|
|
|
319
318
|
* To change the alarm to the <code>NORMAL</code> state, you must acknowledge the alarm.</p>
|
|
320
319
|
* </li>
|
|
321
320
|
* </ul>
|
|
321
|
+
* @public
|
|
322
322
|
*/
|
|
323
323
|
stateName?: AlarmStateName;
|
|
324
324
|
/**
|
|
325
|
-
* @public
|
|
326
325
|
* <p>Information needed to evaluate data.</p>
|
|
326
|
+
* @public
|
|
327
327
|
*/
|
|
328
328
|
ruleEvaluation?: RuleEvaluation;
|
|
329
329
|
/**
|
|
330
|
-
* @public
|
|
331
330
|
* <p>Contains information about the action that you can take to respond to the alarm.</p>
|
|
331
|
+
* @public
|
|
332
332
|
*/
|
|
333
333
|
customerAction?: CustomerAction;
|
|
334
334
|
/**
|
|
335
|
-
* @public
|
|
336
335
|
* <p>Contains information about alarm state changes.</p>
|
|
336
|
+
* @public
|
|
337
337
|
*/
|
|
338
338
|
systemEvent?: SystemEvent;
|
|
339
339
|
}
|
|
340
340
|
/**
|
|
341
|
-
* @public
|
|
342
341
|
* <p>Contains information about an alarm.</p>
|
|
342
|
+
* @public
|
|
343
343
|
*/
|
|
344
344
|
export interface Alarm {
|
|
345
345
|
/**
|
|
346
|
-
* @public
|
|
347
346
|
* <p>The name of the alarm model.</p>
|
|
347
|
+
* @public
|
|
348
348
|
*/
|
|
349
349
|
alarmModelName?: string;
|
|
350
350
|
/**
|
|
351
|
-
* @public
|
|
352
351
|
* <p>The version of the alarm model.</p>
|
|
352
|
+
* @public
|
|
353
353
|
*/
|
|
354
354
|
alarmModelVersion?: string;
|
|
355
355
|
/**
|
|
356
|
-
* @public
|
|
357
356
|
* <p>The value of the key used as a filter to select only the alarms associated with the
|
|
358
357
|
* <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key">key</a>.</p>
|
|
358
|
+
* @public
|
|
359
359
|
*/
|
|
360
360
|
keyValue?: string;
|
|
361
361
|
/**
|
|
362
|
-
* @public
|
|
363
362
|
* <p>Contains information about the current state of the alarm.</p>
|
|
363
|
+
* @public
|
|
364
364
|
*/
|
|
365
365
|
alarmState?: AlarmState;
|
|
366
366
|
/**
|
|
367
|
-
* @public
|
|
368
367
|
* <p>A non-negative integer that reflects the severity level of the alarm.</p>
|
|
368
|
+
* @public
|
|
369
369
|
*/
|
|
370
370
|
severity?: number;
|
|
371
371
|
/**
|
|
372
|
-
* @public
|
|
373
372
|
* <p>The time the alarm was created, in the Unix epoch format.</p>
|
|
373
|
+
* @public
|
|
374
374
|
*/
|
|
375
375
|
creationTime?: Date;
|
|
376
376
|
/**
|
|
377
|
-
* @public
|
|
378
377
|
* <p>The time the alarm was last updated, in the Unix epoch format.</p>
|
|
378
|
+
* @public
|
|
379
379
|
*/
|
|
380
380
|
lastUpdateTime?: Date;
|
|
381
381
|
}
|
|
382
382
|
/**
|
|
383
|
-
* @public
|
|
384
383
|
* <p>Contains a summary of an alarm.</p>
|
|
384
|
+
* @public
|
|
385
385
|
*/
|
|
386
386
|
export interface AlarmSummary {
|
|
387
387
|
/**
|
|
388
|
-
* @public
|
|
389
388
|
* <p>The name of the alarm model.</p>
|
|
389
|
+
* @public
|
|
390
390
|
*/
|
|
391
391
|
alarmModelName?: string;
|
|
392
392
|
/**
|
|
393
|
-
* @public
|
|
394
393
|
* <p>The version of the alarm model.</p>
|
|
394
|
+
* @public
|
|
395
395
|
*/
|
|
396
396
|
alarmModelVersion?: string;
|
|
397
397
|
/**
|
|
398
|
-
* @public
|
|
399
398
|
* <p>The value of the key used as a filter to select only the alarms associated with the
|
|
400
399
|
* <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key">key</a>.</p>
|
|
400
|
+
* @public
|
|
401
401
|
*/
|
|
402
402
|
keyValue?: string;
|
|
403
403
|
/**
|
|
404
|
-
* @public
|
|
405
404
|
* <p>The name of the alarm state. The state name can be one of the following values:</p>
|
|
406
405
|
* <ul>
|
|
407
406
|
* <li>
|
|
@@ -438,16 +437,17 @@ export interface AlarmSummary {
|
|
|
438
437
|
* To change the alarm to the <code>NORMAL</code> state, you must acknowledge the alarm.</p>
|
|
439
438
|
* </li>
|
|
440
439
|
* </ul>
|
|
440
|
+
* @public
|
|
441
441
|
*/
|
|
442
442
|
stateName?: AlarmStateName;
|
|
443
443
|
/**
|
|
444
|
-
* @public
|
|
445
444
|
* <p>The time the alarm was created, in the Unix epoch format.</p>
|
|
445
|
+
* @public
|
|
446
446
|
*/
|
|
447
447
|
creationTime?: Date;
|
|
448
448
|
/**
|
|
449
|
-
* @public
|
|
450
449
|
* <p>The time the alarm was last updated, in the Unix epoch format.</p>
|
|
450
|
+
* @public
|
|
451
451
|
*/
|
|
452
452
|
lastUpdateTime?: Date;
|
|
453
453
|
}
|
|
@@ -456,8 +456,8 @@ export interface AlarmSummary {
|
|
|
456
456
|
*/
|
|
457
457
|
export interface BatchAcknowledgeAlarmRequest {
|
|
458
458
|
/**
|
|
459
|
-
* @public
|
|
460
459
|
* <p>The list of acknowledge action requests. You can specify up to 10 requests per operation.</p>
|
|
460
|
+
* @public
|
|
461
461
|
*/
|
|
462
462
|
acknowledgeActionRequests: AcknowledgeAlarmActionRequest[] | undefined;
|
|
463
463
|
}
|
|
@@ -477,7 +477,6 @@ export declare const ErrorCode: {
|
|
|
477
477
|
*/
|
|
478
478
|
export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
|
|
479
479
|
/**
|
|
480
|
-
* @public
|
|
481
480
|
* <p>Contains error messages associated with one of the following requests:</p>
|
|
482
481
|
* <ul>
|
|
483
482
|
* <li>
|
|
@@ -506,21 +505,22 @@ export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
|
|
|
506
505
|
* </p>
|
|
507
506
|
* </li>
|
|
508
507
|
* </ul>
|
|
508
|
+
* @public
|
|
509
509
|
*/
|
|
510
510
|
export interface BatchAlarmActionErrorEntry {
|
|
511
511
|
/**
|
|
512
|
-
* @public
|
|
513
512
|
* <p>The request ID. Each ID must be unique within each batch.</p>
|
|
513
|
+
* @public
|
|
514
514
|
*/
|
|
515
515
|
requestId?: string;
|
|
516
516
|
/**
|
|
517
|
-
* @public
|
|
518
517
|
* <p>The error code.</p>
|
|
518
|
+
* @public
|
|
519
519
|
*/
|
|
520
520
|
errorCode?: ErrorCode;
|
|
521
521
|
/**
|
|
522
|
-
* @public
|
|
523
522
|
* <p>A message that describes the error.</p>
|
|
523
|
+
* @public
|
|
524
524
|
*/
|
|
525
525
|
errorMessage?: string;
|
|
526
526
|
}
|
|
@@ -529,15 +529,15 @@ export interface BatchAlarmActionErrorEntry {
|
|
|
529
529
|
*/
|
|
530
530
|
export interface BatchAcknowledgeAlarmResponse {
|
|
531
531
|
/**
|
|
532
|
-
* @public
|
|
533
532
|
* <p>A list of errors associated with the request, or <code>null</code> if there are no errors.
|
|
534
533
|
* Each error entry contains an entry ID that helps you identify the entry that failed.</p>
|
|
534
|
+
* @public
|
|
535
535
|
*/
|
|
536
536
|
errorEntries?: BatchAlarmActionErrorEntry[];
|
|
537
537
|
}
|
|
538
538
|
/**
|
|
539
|
-
* @public
|
|
540
539
|
* <p>An internal failure occurred.</p>
|
|
540
|
+
* @public
|
|
541
541
|
*/
|
|
542
542
|
export declare class InternalFailureException extends __BaseException {
|
|
543
543
|
readonly name: "InternalFailureException";
|
|
@@ -548,8 +548,8 @@ export declare class InternalFailureException extends __BaseException {
|
|
|
548
548
|
constructor(opts: __ExceptionOptionType<InternalFailureException, __BaseException>);
|
|
549
549
|
}
|
|
550
550
|
/**
|
|
551
|
-
* @public
|
|
552
551
|
* <p>The request was invalid.</p>
|
|
552
|
+
* @public
|
|
553
553
|
*/
|
|
554
554
|
export declare class InvalidRequestException extends __BaseException {
|
|
555
555
|
readonly name: "InvalidRequestException";
|
|
@@ -560,8 +560,8 @@ export declare class InvalidRequestException extends __BaseException {
|
|
|
560
560
|
constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
|
|
561
561
|
}
|
|
562
562
|
/**
|
|
563
|
-
* @public
|
|
564
563
|
* <p>The service is currently unavailable.</p>
|
|
564
|
+
* @public
|
|
565
565
|
*/
|
|
566
566
|
export declare class ServiceUnavailableException extends __BaseException {
|
|
567
567
|
readonly name: "ServiceUnavailableException";
|
|
@@ -572,8 +572,8 @@ export declare class ServiceUnavailableException extends __BaseException {
|
|
|
572
572
|
constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
|
|
573
573
|
}
|
|
574
574
|
/**
|
|
575
|
-
* @public
|
|
576
575
|
* <p>The request could not be completed due to throttling.</p>
|
|
576
|
+
* @public
|
|
577
577
|
*/
|
|
578
578
|
export declare class ThrottlingException extends __BaseException {
|
|
579
579
|
readonly name: "ThrottlingException";
|
|
@@ -584,23 +584,23 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
584
584
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
585
585
|
}
|
|
586
586
|
/**
|
|
587
|
-
* @public
|
|
588
587
|
* <p>Information used to delete the detector model.</p>
|
|
588
|
+
* @public
|
|
589
589
|
*/
|
|
590
590
|
export interface DeleteDetectorRequest {
|
|
591
591
|
/**
|
|
592
|
-
* @public
|
|
593
592
|
* <p>The ID to assign to the <code>DeleteDetectorRequest</code>. Each <code>"messageId"</code> must be unique within each batch sent.</p>
|
|
593
|
+
* @public
|
|
594
594
|
*/
|
|
595
595
|
messageId: string | undefined;
|
|
596
596
|
/**
|
|
597
|
-
* @public
|
|
598
597
|
* <p>The name of the detector model that was used to create the detector instance.</p>
|
|
598
|
+
* @public
|
|
599
599
|
*/
|
|
600
600
|
detectorModelName: string | undefined;
|
|
601
601
|
/**
|
|
602
|
-
* @public
|
|
603
602
|
* <p>The value of the <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateDetectorModel.html#iotevents-CreateDetectorModel-request-key">key</a> used to identify the detector. </p>
|
|
603
|
+
* @public
|
|
604
604
|
*/
|
|
605
605
|
keyValue?: string;
|
|
606
606
|
}
|
|
@@ -609,29 +609,29 @@ export interface DeleteDetectorRequest {
|
|
|
609
609
|
*/
|
|
610
610
|
export interface BatchDeleteDetectorRequest {
|
|
611
611
|
/**
|
|
612
|
-
* @public
|
|
613
612
|
* <p>The list of one or more detectors to be deleted.</p>
|
|
613
|
+
* @public
|
|
614
614
|
*/
|
|
615
615
|
detectors: DeleteDetectorRequest[] | undefined;
|
|
616
616
|
}
|
|
617
617
|
/**
|
|
618
|
-
* @public
|
|
619
618
|
* <p>Contains error messages associated with the deletion request.</p>
|
|
619
|
+
* @public
|
|
620
620
|
*/
|
|
621
621
|
export interface BatchDeleteDetectorErrorEntry {
|
|
622
622
|
/**
|
|
623
|
-
* @public
|
|
624
623
|
* <p>The ID of the message that caused the error. (See the value of the <code>"messageId"</code> in the <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchDeleteDetector.html#iotevents-iotevents-data_BatchDeleteDetector-request-detectors">detectors</a> object of the <code>DeleteDetectorRequest</code>.)</p>
|
|
624
|
+
* @public
|
|
625
625
|
*/
|
|
626
626
|
messageId?: string;
|
|
627
627
|
/**
|
|
628
|
-
* @public
|
|
629
628
|
* <p>The error code.</p>
|
|
629
|
+
* @public
|
|
630
630
|
*/
|
|
631
631
|
errorCode?: ErrorCode;
|
|
632
632
|
/**
|
|
633
|
-
* @public
|
|
634
633
|
* <p>A message that describes the error.</p>
|
|
634
|
+
* @public
|
|
635
635
|
*/
|
|
636
636
|
errorMessage?: string;
|
|
637
637
|
}
|
|
@@ -640,35 +640,35 @@ export interface BatchDeleteDetectorErrorEntry {
|
|
|
640
640
|
*/
|
|
641
641
|
export interface BatchDeleteDetectorResponse {
|
|
642
642
|
/**
|
|
643
|
-
* @public
|
|
644
643
|
* <p>A list of errors associated with the request, or an empty array (<code>[]</code>) if there are no errors. Each error entry contains a <code>messageId</code> that helps you identify the entry that failed.</p>
|
|
644
|
+
* @public
|
|
645
645
|
*/
|
|
646
646
|
batchDeleteDetectorErrorEntries?: BatchDeleteDetectorErrorEntry[];
|
|
647
647
|
}
|
|
648
648
|
/**
|
|
649
|
-
* @public
|
|
650
649
|
* <p>Information used to disable the alarm.</p>
|
|
650
|
+
* @public
|
|
651
651
|
*/
|
|
652
652
|
export interface DisableAlarmActionRequest {
|
|
653
653
|
/**
|
|
654
|
-
* @public
|
|
655
654
|
* <p>The request ID. Each ID must be unique within each batch.</p>
|
|
655
|
+
* @public
|
|
656
656
|
*/
|
|
657
657
|
requestId: string | undefined;
|
|
658
658
|
/**
|
|
659
|
-
* @public
|
|
660
659
|
* <p>The name of the alarm model.</p>
|
|
660
|
+
* @public
|
|
661
661
|
*/
|
|
662
662
|
alarmModelName: string | undefined;
|
|
663
663
|
/**
|
|
664
|
-
* @public
|
|
665
664
|
* <p>The value of the key used as a filter to select only the alarms associated with the
|
|
666
665
|
* <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key">key</a>.</p>
|
|
666
|
+
* @public
|
|
667
667
|
*/
|
|
668
668
|
keyValue?: string;
|
|
669
669
|
/**
|
|
670
|
-
* @public
|
|
671
670
|
* <p>The note that you can leave when you disable the alarm.</p>
|
|
671
|
+
* @public
|
|
672
672
|
*/
|
|
673
673
|
note?: string;
|
|
674
674
|
}
|
|
@@ -677,8 +677,8 @@ export interface DisableAlarmActionRequest {
|
|
|
677
677
|
*/
|
|
678
678
|
export interface BatchDisableAlarmRequest {
|
|
679
679
|
/**
|
|
680
|
-
* @public
|
|
681
680
|
* <p>The list of disable action requests. You can specify up to 10 requests per operation.</p>
|
|
681
|
+
* @public
|
|
682
682
|
*/
|
|
683
683
|
disableActionRequests: DisableAlarmActionRequest[] | undefined;
|
|
684
684
|
}
|
|
@@ -687,36 +687,36 @@ export interface BatchDisableAlarmRequest {
|
|
|
687
687
|
*/
|
|
688
688
|
export interface BatchDisableAlarmResponse {
|
|
689
689
|
/**
|
|
690
|
-
* @public
|
|
691
690
|
* <p>A list of errors associated with the request, or <code>null</code> if there are no errors.
|
|
692
691
|
* Each error entry contains an entry ID that helps you identify the entry that failed.</p>
|
|
692
|
+
* @public
|
|
693
693
|
*/
|
|
694
694
|
errorEntries?: BatchAlarmActionErrorEntry[];
|
|
695
695
|
}
|
|
696
696
|
/**
|
|
697
|
-
* @public
|
|
698
697
|
* <p>Information needed to enable the alarm.</p>
|
|
698
|
+
* @public
|
|
699
699
|
*/
|
|
700
700
|
export interface EnableAlarmActionRequest {
|
|
701
701
|
/**
|
|
702
|
-
* @public
|
|
703
702
|
* <p>The request ID. Each ID must be unique within each batch.</p>
|
|
703
|
+
* @public
|
|
704
704
|
*/
|
|
705
705
|
requestId: string | undefined;
|
|
706
706
|
/**
|
|
707
|
-
* @public
|
|
708
707
|
* <p>The name of the alarm model.</p>
|
|
708
|
+
* @public
|
|
709
709
|
*/
|
|
710
710
|
alarmModelName: string | undefined;
|
|
711
711
|
/**
|
|
712
|
-
* @public
|
|
713
712
|
* <p>The value of the key used as a filter to select only the alarms associated with the
|
|
714
713
|
* <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key">key</a>.</p>
|
|
714
|
+
* @public
|
|
715
715
|
*/
|
|
716
716
|
keyValue?: string;
|
|
717
717
|
/**
|
|
718
|
-
* @public
|
|
719
718
|
* <p>The note that you can leave when you enable the alarm.</p>
|
|
719
|
+
* @public
|
|
720
720
|
*/
|
|
721
721
|
note?: string;
|
|
722
722
|
}
|
|
@@ -725,8 +725,8 @@ export interface EnableAlarmActionRequest {
|
|
|
725
725
|
*/
|
|
726
726
|
export interface BatchEnableAlarmRequest {
|
|
727
727
|
/**
|
|
728
|
-
* @public
|
|
729
728
|
* <p>The list of enable action requests. You can specify up to 10 requests per operation.</p>
|
|
729
|
+
* @public
|
|
730
730
|
*/
|
|
731
731
|
enableActionRequests: EnableAlarmActionRequest[] | undefined;
|
|
732
732
|
}
|
|
@@ -735,48 +735,48 @@ export interface BatchEnableAlarmRequest {
|
|
|
735
735
|
*/
|
|
736
736
|
export interface BatchEnableAlarmResponse {
|
|
737
737
|
/**
|
|
738
|
-
* @public
|
|
739
738
|
* <p>A list of errors associated with the request, or <code>null</code> if there are no errors.
|
|
740
739
|
* Each error entry contains an entry ID that helps you identify the entry that failed.</p>
|
|
740
|
+
* @public
|
|
741
741
|
*/
|
|
742
742
|
errorEntries?: BatchAlarmActionErrorEntry[];
|
|
743
743
|
}
|
|
744
744
|
/**
|
|
745
|
-
* @public
|
|
746
745
|
* <p>Contains information about a timestamp.</p>
|
|
746
|
+
* @public
|
|
747
747
|
*/
|
|
748
748
|
export interface TimestampValue {
|
|
749
749
|
/**
|
|
750
|
-
* @public
|
|
751
750
|
* <p>The value of the timestamp, in the Unix epoch format.</p>
|
|
751
|
+
* @public
|
|
752
752
|
*/
|
|
753
753
|
timeInMillis?: number;
|
|
754
754
|
}
|
|
755
755
|
/**
|
|
756
|
-
* @public
|
|
757
756
|
* <p>Information about a message.</p>
|
|
757
|
+
* @public
|
|
758
758
|
*/
|
|
759
759
|
export interface Message {
|
|
760
760
|
/**
|
|
761
|
-
* @public
|
|
762
761
|
* <p>The ID to assign to the message. Within each batch sent, each <code>"messageId"</code>
|
|
763
762
|
* must be unique.</p>
|
|
763
|
+
* @public
|
|
764
764
|
*/
|
|
765
765
|
messageId: string | undefined;
|
|
766
766
|
/**
|
|
767
|
-
* @public
|
|
768
767
|
* <p>The name of the input into which the message payload is transformed.</p>
|
|
768
|
+
* @public
|
|
769
769
|
*/
|
|
770
770
|
inputName: string | undefined;
|
|
771
771
|
/**
|
|
772
|
-
* @public
|
|
773
772
|
* <p>The payload of the message. This can be a JSON string or a Base-64-encoded string
|
|
774
773
|
* representing binary data (in which case you must decode it).</p>
|
|
774
|
+
* @public
|
|
775
775
|
*/
|
|
776
776
|
payload: Uint8Array | undefined;
|
|
777
777
|
/**
|
|
778
|
-
* @public
|
|
779
778
|
* <p>The timestamp associated with the message.</p>
|
|
779
|
+
* @public
|
|
780
780
|
*/
|
|
781
781
|
timestamp?: TimestampValue;
|
|
782
782
|
}
|
|
@@ -785,32 +785,32 @@ export interface Message {
|
|
|
785
785
|
*/
|
|
786
786
|
export interface BatchPutMessageRequest {
|
|
787
787
|
/**
|
|
788
|
-
* @public
|
|
789
788
|
* <p>The list of messages to send. Each message has the following format: <code>'\{ "messageId":
|
|
790
789
|
* "string", "inputName": "string", "payload": "string"\}'</code>
|
|
791
790
|
* </p>
|
|
791
|
+
* @public
|
|
792
792
|
*/
|
|
793
793
|
messages: Message[] | undefined;
|
|
794
794
|
}
|
|
795
795
|
/**
|
|
796
|
-
* @public
|
|
797
796
|
* <p>Contains information about the errors encountered.</p>
|
|
797
|
+
* @public
|
|
798
798
|
*/
|
|
799
799
|
export interface BatchPutMessageErrorEntry {
|
|
800
800
|
/**
|
|
801
|
-
* @public
|
|
802
801
|
* <p>The ID of the message that caused the error. (See the value corresponding to the
|
|
803
802
|
* <code>"messageId"</code> key in the <code>"message"</code> object.)</p>
|
|
803
|
+
* @public
|
|
804
804
|
*/
|
|
805
805
|
messageId?: string;
|
|
806
806
|
/**
|
|
807
|
-
* @public
|
|
808
807
|
* <p>The error code.</p>
|
|
808
|
+
* @public
|
|
809
809
|
*/
|
|
810
810
|
errorCode?: ErrorCode;
|
|
811
811
|
/**
|
|
812
|
-
* @public
|
|
813
812
|
* <p>A message that describes the error.</p>
|
|
813
|
+
* @public
|
|
814
814
|
*/
|
|
815
815
|
errorMessage?: string;
|
|
816
816
|
}
|
|
@@ -819,35 +819,35 @@ export interface BatchPutMessageErrorEntry {
|
|
|
819
819
|
*/
|
|
820
820
|
export interface BatchPutMessageResponse {
|
|
821
821
|
/**
|
|
822
|
-
* @public
|
|
823
822
|
* <p>A list of any errors encountered when sending the messages.</p>
|
|
823
|
+
* @public
|
|
824
824
|
*/
|
|
825
825
|
BatchPutMessageErrorEntries?: BatchPutMessageErrorEntry[];
|
|
826
826
|
}
|
|
827
827
|
/**
|
|
828
|
-
* @public
|
|
829
828
|
* <p>Information needed to reset the alarm.</p>
|
|
829
|
+
* @public
|
|
830
830
|
*/
|
|
831
831
|
export interface ResetAlarmActionRequest {
|
|
832
832
|
/**
|
|
833
|
-
* @public
|
|
834
833
|
* <p>The request ID. Each ID must be unique within each batch.</p>
|
|
834
|
+
* @public
|
|
835
835
|
*/
|
|
836
836
|
requestId: string | undefined;
|
|
837
837
|
/**
|
|
838
|
-
* @public
|
|
839
838
|
* <p>The name of the alarm model.</p>
|
|
839
|
+
* @public
|
|
840
840
|
*/
|
|
841
841
|
alarmModelName: string | undefined;
|
|
842
842
|
/**
|
|
843
|
-
* @public
|
|
844
843
|
* <p>The value of the key used as a filter to select only the alarms associated with the
|
|
845
844
|
* <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key">key</a>.</p>
|
|
845
|
+
* @public
|
|
846
846
|
*/
|
|
847
847
|
keyValue?: string;
|
|
848
848
|
/**
|
|
849
|
-
* @public
|
|
850
849
|
* <p>The note that you can leave when you reset the alarm.</p>
|
|
850
|
+
* @public
|
|
851
851
|
*/
|
|
852
852
|
note?: string;
|
|
853
853
|
}
|
|
@@ -856,8 +856,8 @@ export interface ResetAlarmActionRequest {
|
|
|
856
856
|
*/
|
|
857
857
|
export interface BatchResetAlarmRequest {
|
|
858
858
|
/**
|
|
859
|
-
* @public
|
|
860
859
|
* <p>The list of reset action requests. You can specify up to 10 requests per operation.</p>
|
|
860
|
+
* @public
|
|
861
861
|
*/
|
|
862
862
|
resetActionRequests: ResetAlarmActionRequest[] | undefined;
|
|
863
863
|
}
|
|
@@ -866,41 +866,41 @@ export interface BatchResetAlarmRequest {
|
|
|
866
866
|
*/
|
|
867
867
|
export interface BatchResetAlarmResponse {
|
|
868
868
|
/**
|
|
869
|
-
* @public
|
|
870
869
|
* <p>A list of errors associated with the request, or <code>null</code> if there are no errors.
|
|
871
870
|
* Each error entry contains an entry ID that helps you identify the entry that failed.</p>
|
|
871
|
+
* @public
|
|
872
872
|
*/
|
|
873
873
|
errorEntries?: BatchAlarmActionErrorEntry[];
|
|
874
874
|
}
|
|
875
875
|
/**
|
|
876
|
-
* @public
|
|
877
876
|
* <p>Information needed to snooze the alarm.</p>
|
|
877
|
+
* @public
|
|
878
878
|
*/
|
|
879
879
|
export interface SnoozeAlarmActionRequest {
|
|
880
880
|
/**
|
|
881
|
-
* @public
|
|
882
881
|
* <p>The request ID. Each ID must be unique within each batch.</p>
|
|
882
|
+
* @public
|
|
883
883
|
*/
|
|
884
884
|
requestId: string | undefined;
|
|
885
885
|
/**
|
|
886
|
-
* @public
|
|
887
886
|
* <p>The name of the alarm model.</p>
|
|
887
|
+
* @public
|
|
888
888
|
*/
|
|
889
889
|
alarmModelName: string | undefined;
|
|
890
890
|
/**
|
|
891
|
-
* @public
|
|
892
891
|
* <p>The value of the key used as a filter to select only the alarms associated with the
|
|
893
892
|
* <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key">key</a>.</p>
|
|
893
|
+
* @public
|
|
894
894
|
*/
|
|
895
895
|
keyValue?: string;
|
|
896
896
|
/**
|
|
897
|
-
* @public
|
|
898
897
|
* <p>The note that you can leave when you snooze the alarm.</p>
|
|
898
|
+
* @public
|
|
899
899
|
*/
|
|
900
900
|
note?: string;
|
|
901
901
|
/**
|
|
902
|
-
* @public
|
|
903
902
|
* <p>The snooze time in seconds. The alarm automatically changes to the <code>NORMAL</code> state after this duration.</p>
|
|
903
|
+
* @public
|
|
904
904
|
*/
|
|
905
905
|
snoozeDuration: number | undefined;
|
|
906
906
|
}
|
|
@@ -909,8 +909,8 @@ export interface SnoozeAlarmActionRequest {
|
|
|
909
909
|
*/
|
|
910
910
|
export interface BatchSnoozeAlarmRequest {
|
|
911
911
|
/**
|
|
912
|
-
* @public
|
|
913
912
|
* <p>The list of snooze action requests. You can specify up to 10 requests per operation.</p>
|
|
913
|
+
* @public
|
|
914
914
|
*/
|
|
915
915
|
snoozeActionRequests: SnoozeAlarmActionRequest[] | undefined;
|
|
916
916
|
}
|
|
@@ -919,92 +919,92 @@ export interface BatchSnoozeAlarmRequest {
|
|
|
919
919
|
*/
|
|
920
920
|
export interface BatchSnoozeAlarmResponse {
|
|
921
921
|
/**
|
|
922
|
-
* @public
|
|
923
922
|
* <p>A list of errors associated with the request, or <code>null</code> if there are no errors.
|
|
924
923
|
* Each error entry contains an entry ID that helps you identify the entry that failed.</p>
|
|
924
|
+
* @public
|
|
925
925
|
*/
|
|
926
926
|
errorEntries?: BatchAlarmActionErrorEntry[];
|
|
927
927
|
}
|
|
928
928
|
/**
|
|
929
|
-
* @public
|
|
930
929
|
* <p>The new setting of a timer.</p>
|
|
930
|
+
* @public
|
|
931
931
|
*/
|
|
932
932
|
export interface TimerDefinition {
|
|
933
933
|
/**
|
|
934
|
-
* @public
|
|
935
934
|
* <p>The name of the timer.</p>
|
|
935
|
+
* @public
|
|
936
936
|
*/
|
|
937
937
|
name: string | undefined;
|
|
938
938
|
/**
|
|
939
|
-
* @public
|
|
940
939
|
* <p>The new setting of the timer (the number of seconds before the timer elapses).</p>
|
|
940
|
+
* @public
|
|
941
941
|
*/
|
|
942
942
|
seconds: number | undefined;
|
|
943
943
|
}
|
|
944
944
|
/**
|
|
945
|
-
* @public
|
|
946
945
|
* <p>The new value of the variable.</p>
|
|
946
|
+
* @public
|
|
947
947
|
*/
|
|
948
948
|
export interface VariableDefinition {
|
|
949
949
|
/**
|
|
950
|
-
* @public
|
|
951
950
|
* <p>The name of the variable.</p>
|
|
951
|
+
* @public
|
|
952
952
|
*/
|
|
953
953
|
name: string | undefined;
|
|
954
954
|
/**
|
|
955
|
-
* @public
|
|
956
955
|
* <p>The new value of the variable.</p>
|
|
956
|
+
* @public
|
|
957
957
|
*/
|
|
958
958
|
value: string | undefined;
|
|
959
959
|
}
|
|
960
960
|
/**
|
|
961
|
-
* @public
|
|
962
961
|
* <p>The new state, variable values, and timer settings of the detector (instance).</p>
|
|
962
|
+
* @public
|
|
963
963
|
*/
|
|
964
964
|
export interface DetectorStateDefinition {
|
|
965
965
|
/**
|
|
966
|
-
* @public
|
|
967
966
|
* <p>The name of the new state of the detector (instance).</p>
|
|
967
|
+
* @public
|
|
968
968
|
*/
|
|
969
969
|
stateName: string | undefined;
|
|
970
970
|
/**
|
|
971
|
-
* @public
|
|
972
971
|
* <p>The new values of the detector's variables. Any variable whose value isn't specified is
|
|
973
972
|
* cleared.</p>
|
|
973
|
+
* @public
|
|
974
974
|
*/
|
|
975
975
|
variables: VariableDefinition[] | undefined;
|
|
976
976
|
/**
|
|
977
|
-
* @public
|
|
978
977
|
* <p>The new values of the detector's timers. Any timer whose value isn't specified is cleared,
|
|
979
978
|
* and its timeout event won't occur.</p>
|
|
979
|
+
* @public
|
|
980
980
|
*/
|
|
981
981
|
timers: TimerDefinition[] | undefined;
|
|
982
982
|
}
|
|
983
983
|
/**
|
|
984
|
-
* @public
|
|
985
984
|
* <p>Information used to update the detector (instance).</p>
|
|
985
|
+
* @public
|
|
986
986
|
*/
|
|
987
987
|
export interface UpdateDetectorRequest {
|
|
988
988
|
/**
|
|
989
|
-
* @public
|
|
990
989
|
* <p>The ID to assign to the detector update <code>"message"</code>. Each
|
|
991
990
|
* <code>"messageId"</code> must be unique within each batch sent.</p>
|
|
991
|
+
* @public
|
|
992
992
|
*/
|
|
993
993
|
messageId: string | undefined;
|
|
994
994
|
/**
|
|
995
|
-
* @public
|
|
996
995
|
* <p>The name of the detector model that created the detectors (instances).</p>
|
|
996
|
+
* @public
|
|
997
997
|
*/
|
|
998
998
|
detectorModelName: string | undefined;
|
|
999
999
|
/**
|
|
1000
|
-
* @public
|
|
1001
1000
|
* <p>The value of the input key attribute (identifying the device or system) that caused the
|
|
1002
1001
|
* creation of this detector (instance).</p>
|
|
1002
|
+
* @public
|
|
1003
1003
|
*/
|
|
1004
1004
|
keyValue?: string;
|
|
1005
1005
|
/**
|
|
1006
|
-
* @public
|
|
1007
1006
|
* <p>The new state, variable values, and timer settings of the detector (instance).</p>
|
|
1007
|
+
* @public
|
|
1008
1008
|
*/
|
|
1009
1009
|
state: DetectorStateDefinition | undefined;
|
|
1010
1010
|
}
|
|
@@ -1013,30 +1013,30 @@ export interface UpdateDetectorRequest {
|
|
|
1013
1013
|
*/
|
|
1014
1014
|
export interface BatchUpdateDetectorRequest {
|
|
1015
1015
|
/**
|
|
1016
|
-
* @public
|
|
1017
1016
|
* <p>The list of detectors (instances) to update, along with the values to update.</p>
|
|
1017
|
+
* @public
|
|
1018
1018
|
*/
|
|
1019
1019
|
detectors: UpdateDetectorRequest[] | undefined;
|
|
1020
1020
|
}
|
|
1021
1021
|
/**
|
|
1022
|
-
* @public
|
|
1023
1022
|
* <p>Information about the error that occurred when attempting to update a detector.</p>
|
|
1023
|
+
* @public
|
|
1024
1024
|
*/
|
|
1025
1025
|
export interface BatchUpdateDetectorErrorEntry {
|
|
1026
1026
|
/**
|
|
1027
|
-
* @public
|
|
1028
1027
|
* <p>The <code>"messageId"</code> of the update request that caused the error. (The value of
|
|
1029
1028
|
* the <code>"messageId"</code> in the update request <code>"Detector"</code> object.)</p>
|
|
1029
|
+
* @public
|
|
1030
1030
|
*/
|
|
1031
1031
|
messageId?: string;
|
|
1032
1032
|
/**
|
|
1033
|
-
* @public
|
|
1034
1033
|
* <p>The error code.</p>
|
|
1034
|
+
* @public
|
|
1035
1035
|
*/
|
|
1036
1036
|
errorCode?: ErrorCode;
|
|
1037
1037
|
/**
|
|
1038
|
-
* @public
|
|
1039
1038
|
* <p>A message that describes the error.</p>
|
|
1039
|
+
* @public
|
|
1040
1040
|
*/
|
|
1041
1041
|
errorMessage?: string;
|
|
1042
1042
|
}
|
|
@@ -1045,9 +1045,9 @@ export interface BatchUpdateDetectorErrorEntry {
|
|
|
1045
1045
|
*/
|
|
1046
1046
|
export interface BatchUpdateDetectorResponse {
|
|
1047
1047
|
/**
|
|
1048
|
-
* @public
|
|
1049
1048
|
* <p>A list of those detector updates that resulted in errors. (If an error is listed here, the
|
|
1050
1049
|
* specific update did not occur.)</p>
|
|
1050
|
+
* @public
|
|
1051
1051
|
*/
|
|
1052
1052
|
batchUpdateDetectorErrorEntries?: BatchUpdateDetectorErrorEntry[];
|
|
1053
1053
|
}
|
|
@@ -1056,14 +1056,14 @@ export interface BatchUpdateDetectorResponse {
|
|
|
1056
1056
|
*/
|
|
1057
1057
|
export interface DescribeAlarmRequest {
|
|
1058
1058
|
/**
|
|
1059
|
-
* @public
|
|
1060
1059
|
* <p>The name of the alarm model.</p>
|
|
1060
|
+
* @public
|
|
1061
1061
|
*/
|
|
1062
1062
|
alarmModelName: string | undefined;
|
|
1063
1063
|
/**
|
|
1064
|
-
* @public
|
|
1065
1064
|
* <p>The value of the key used as a filter to select only the alarms associated with the
|
|
1066
1065
|
* <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key">key</a>.</p>
|
|
1066
|
+
* @public
|
|
1067
1067
|
*/
|
|
1068
1068
|
keyValue?: string;
|
|
1069
1069
|
}
|
|
@@ -1072,14 +1072,14 @@ export interface DescribeAlarmRequest {
|
|
|
1072
1072
|
*/
|
|
1073
1073
|
export interface DescribeAlarmResponse {
|
|
1074
1074
|
/**
|
|
1075
|
-
* @public
|
|
1076
1075
|
* <p>Contains information about an alarm.</p>
|
|
1076
|
+
* @public
|
|
1077
1077
|
*/
|
|
1078
1078
|
alarm?: Alarm;
|
|
1079
1079
|
}
|
|
1080
1080
|
/**
|
|
1081
|
-
* @public
|
|
1082
1081
|
* <p>The resource was not found.</p>
|
|
1082
|
+
* @public
|
|
1083
1083
|
*/
|
|
1084
1084
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
1085
1085
|
readonly name: "ResourceNotFoundException";
|
|
@@ -1094,105 +1094,105 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
1094
1094
|
*/
|
|
1095
1095
|
export interface DescribeDetectorRequest {
|
|
1096
1096
|
/**
|
|
1097
|
-
* @public
|
|
1098
1097
|
* <p>The name of the detector model whose detectors (instances) you want information
|
|
1099
1098
|
* about.</p>
|
|
1099
|
+
* @public
|
|
1100
1100
|
*/
|
|
1101
1101
|
detectorModelName: string | undefined;
|
|
1102
1102
|
/**
|
|
1103
|
-
* @public
|
|
1104
1103
|
* <p>A filter used to limit results to detectors (instances) created because of the given key
|
|
1105
1104
|
* ID.</p>
|
|
1105
|
+
* @public
|
|
1106
1106
|
*/
|
|
1107
1107
|
keyValue?: string;
|
|
1108
1108
|
}
|
|
1109
1109
|
/**
|
|
1110
|
-
* @public
|
|
1111
1110
|
* <p>The current state of a timer.</p>
|
|
1111
|
+
* @public
|
|
1112
1112
|
*/
|
|
1113
1113
|
export interface Timer {
|
|
1114
1114
|
/**
|
|
1115
|
-
* @public
|
|
1116
1115
|
* <p>The name of the timer.</p>
|
|
1116
|
+
* @public
|
|
1117
1117
|
*/
|
|
1118
1118
|
name: string | undefined;
|
|
1119
1119
|
/**
|
|
1120
|
-
* @public
|
|
1121
1120
|
* <p>The expiration time for the timer.</p>
|
|
1121
|
+
* @public
|
|
1122
1122
|
*/
|
|
1123
1123
|
timestamp: Date | undefined;
|
|
1124
1124
|
}
|
|
1125
1125
|
/**
|
|
1126
|
-
* @public
|
|
1127
1126
|
* <p>The current state of the variable.</p>
|
|
1127
|
+
* @public
|
|
1128
1128
|
*/
|
|
1129
1129
|
export interface Variable {
|
|
1130
1130
|
/**
|
|
1131
|
-
* @public
|
|
1132
1131
|
* <p>The name of the variable.</p>
|
|
1132
|
+
* @public
|
|
1133
1133
|
*/
|
|
1134
1134
|
name: string | undefined;
|
|
1135
1135
|
/**
|
|
1136
|
-
* @public
|
|
1137
1136
|
* <p>The current value of the variable.</p>
|
|
1137
|
+
* @public
|
|
1138
1138
|
*/
|
|
1139
1139
|
value: string | undefined;
|
|
1140
1140
|
}
|
|
1141
1141
|
/**
|
|
1142
|
-
* @public
|
|
1143
1142
|
* <p>Information about the current state of the detector instance.</p>
|
|
1143
|
+
* @public
|
|
1144
1144
|
*/
|
|
1145
1145
|
export interface DetectorState {
|
|
1146
1146
|
/**
|
|
1147
|
-
* @public
|
|
1148
1147
|
* <p>The name of the state.</p>
|
|
1148
|
+
* @public
|
|
1149
1149
|
*/
|
|
1150
1150
|
stateName: string | undefined;
|
|
1151
1151
|
/**
|
|
1152
|
-
* @public
|
|
1153
1152
|
* <p>The current values of the detector's variables.</p>
|
|
1153
|
+
* @public
|
|
1154
1154
|
*/
|
|
1155
1155
|
variables: Variable[] | undefined;
|
|
1156
1156
|
/**
|
|
1157
|
-
* @public
|
|
1158
1157
|
* <p>The current state of the detector's timers.</p>
|
|
1158
|
+
* @public
|
|
1159
1159
|
*/
|
|
1160
1160
|
timers: Timer[] | undefined;
|
|
1161
1161
|
}
|
|
1162
1162
|
/**
|
|
1163
|
-
* @public
|
|
1164
1163
|
* <p>Information about the detector (instance).</p>
|
|
1164
|
+
* @public
|
|
1165
1165
|
*/
|
|
1166
1166
|
export interface Detector {
|
|
1167
1167
|
/**
|
|
1168
|
-
* @public
|
|
1169
1168
|
* <p>The name of the detector model that created this detector (instance).</p>
|
|
1169
|
+
* @public
|
|
1170
1170
|
*/
|
|
1171
1171
|
detectorModelName?: string;
|
|
1172
1172
|
/**
|
|
1173
|
-
* @public
|
|
1174
1173
|
* <p>The value of the key (identifying the device or system) that caused the creation of this
|
|
1175
1174
|
* detector (instance).</p>
|
|
1175
|
+
* @public
|
|
1176
1176
|
*/
|
|
1177
1177
|
keyValue?: string;
|
|
1178
1178
|
/**
|
|
1179
|
-
* @public
|
|
1180
1179
|
* <p>The version of the detector model that created this detector (instance).</p>
|
|
1180
|
+
* @public
|
|
1181
1181
|
*/
|
|
1182
1182
|
detectorModelVersion?: string;
|
|
1183
1183
|
/**
|
|
1184
|
-
* @public
|
|
1185
1184
|
* <p>The current state of the detector (instance).</p>
|
|
1185
|
+
* @public
|
|
1186
1186
|
*/
|
|
1187
1187
|
state?: DetectorState;
|
|
1188
1188
|
/**
|
|
1189
|
-
* @public
|
|
1190
1189
|
* <p>The time the detector (instance) was created.</p>
|
|
1190
|
+
* @public
|
|
1191
1191
|
*/
|
|
1192
1192
|
creationTime?: Date;
|
|
1193
1193
|
/**
|
|
1194
|
-
* @public
|
|
1195
1194
|
* <p>The time the detector (instance) was last updated.</p>
|
|
1195
|
+
* @public
|
|
1196
1196
|
*/
|
|
1197
1197
|
lastUpdateTime?: Date;
|
|
1198
1198
|
}
|
|
@@ -1201,56 +1201,56 @@ export interface Detector {
|
|
|
1201
1201
|
*/
|
|
1202
1202
|
export interface DescribeDetectorResponse {
|
|
1203
1203
|
/**
|
|
1204
|
-
* @public
|
|
1205
1204
|
* <p>Information about the detector (instance).</p>
|
|
1205
|
+
* @public
|
|
1206
1206
|
*/
|
|
1207
1207
|
detector?: Detector;
|
|
1208
1208
|
}
|
|
1209
1209
|
/**
|
|
1210
|
-
* @public
|
|
1211
1210
|
* <p>Information about the detector state.</p>
|
|
1211
|
+
* @public
|
|
1212
1212
|
*/
|
|
1213
1213
|
export interface DetectorStateSummary {
|
|
1214
1214
|
/**
|
|
1215
|
-
* @public
|
|
1216
1215
|
* <p>The name of the state.</p>
|
|
1216
|
+
* @public
|
|
1217
1217
|
*/
|
|
1218
1218
|
stateName?: string;
|
|
1219
1219
|
}
|
|
1220
1220
|
/**
|
|
1221
|
-
* @public
|
|
1222
1221
|
* <p>Information about the detector (instance).</p>
|
|
1222
|
+
* @public
|
|
1223
1223
|
*/
|
|
1224
1224
|
export interface DetectorSummary {
|
|
1225
1225
|
/**
|
|
1226
|
-
* @public
|
|
1227
1226
|
* <p>The name of the detector model that created this detector (instance).</p>
|
|
1227
|
+
* @public
|
|
1228
1228
|
*/
|
|
1229
1229
|
detectorModelName?: string;
|
|
1230
1230
|
/**
|
|
1231
|
-
* @public
|
|
1232
1231
|
* <p>The value of the key (identifying the device or system) that caused the creation of this
|
|
1233
1232
|
* detector (instance).</p>
|
|
1233
|
+
* @public
|
|
1234
1234
|
*/
|
|
1235
1235
|
keyValue?: string;
|
|
1236
1236
|
/**
|
|
1237
|
-
* @public
|
|
1238
1237
|
* <p>The version of the detector model that created this detector (instance).</p>
|
|
1238
|
+
* @public
|
|
1239
1239
|
*/
|
|
1240
1240
|
detectorModelVersion?: string;
|
|
1241
1241
|
/**
|
|
1242
|
-
* @public
|
|
1243
1242
|
* <p>The current state of the detector (instance).</p>
|
|
1243
|
+
* @public
|
|
1244
1244
|
*/
|
|
1245
1245
|
state?: DetectorStateSummary;
|
|
1246
1246
|
/**
|
|
1247
|
-
* @public
|
|
1248
1247
|
* <p>The time the detector (instance) was created.</p>
|
|
1248
|
+
* @public
|
|
1249
1249
|
*/
|
|
1250
1250
|
creationTime?: Date;
|
|
1251
1251
|
/**
|
|
1252
|
-
* @public
|
|
1253
1252
|
* <p>The time the detector (instance) was last updated.</p>
|
|
1253
|
+
* @public
|
|
1254
1254
|
*/
|
|
1255
1255
|
lastUpdateTime?: Date;
|
|
1256
1256
|
}
|
|
@@ -1259,18 +1259,18 @@ export interface DetectorSummary {
|
|
|
1259
1259
|
*/
|
|
1260
1260
|
export interface ListAlarmsRequest {
|
|
1261
1261
|
/**
|
|
1262
|
-
* @public
|
|
1263
1262
|
* <p>The name of the alarm model.</p>
|
|
1263
|
+
* @public
|
|
1264
1264
|
*/
|
|
1265
1265
|
alarmModelName: string | undefined;
|
|
1266
1266
|
/**
|
|
1267
|
-
* @public
|
|
1268
1267
|
* <p>The token that you can use to return the next set of results.</p>
|
|
1268
|
+
* @public
|
|
1269
1269
|
*/
|
|
1270
1270
|
nextToken?: string;
|
|
1271
1271
|
/**
|
|
1272
|
-
* @public
|
|
1273
1272
|
* <p>The maximum number of results to be returned per request.</p>
|
|
1273
|
+
* @public
|
|
1274
1274
|
*/
|
|
1275
1275
|
maxResults?: number;
|
|
1276
1276
|
}
|
|
@@ -1279,14 +1279,14 @@ export interface ListAlarmsRequest {
|
|
|
1279
1279
|
*/
|
|
1280
1280
|
export interface ListAlarmsResponse {
|
|
1281
1281
|
/**
|
|
1282
|
-
* @public
|
|
1283
1282
|
* <p>A list that summarizes each alarm.</p>
|
|
1283
|
+
* @public
|
|
1284
1284
|
*/
|
|
1285
1285
|
alarmSummaries?: AlarmSummary[];
|
|
1286
1286
|
/**
|
|
1287
|
-
* @public
|
|
1288
1287
|
* <p>The token that you can use to return the next set of results,
|
|
1289
1288
|
* or <code>null</code> if there are no more results.</p>
|
|
1289
|
+
* @public
|
|
1290
1290
|
*/
|
|
1291
1291
|
nextToken?: string;
|
|
1292
1292
|
}
|
|
@@ -1295,23 +1295,23 @@ export interface ListAlarmsResponse {
|
|
|
1295
1295
|
*/
|
|
1296
1296
|
export interface ListDetectorsRequest {
|
|
1297
1297
|
/**
|
|
1298
|
-
* @public
|
|
1299
1298
|
* <p>The name of the detector model whose detectors (instances) are listed.</p>
|
|
1299
|
+
* @public
|
|
1300
1300
|
*/
|
|
1301
1301
|
detectorModelName: string | undefined;
|
|
1302
1302
|
/**
|
|
1303
|
-
* @public
|
|
1304
1303
|
* <p>A filter that limits results to those detectors (instances) in the given state.</p>
|
|
1304
|
+
* @public
|
|
1305
1305
|
*/
|
|
1306
1306
|
stateName?: string;
|
|
1307
1307
|
/**
|
|
1308
|
-
* @public
|
|
1309
1308
|
* <p>The token that you can use to return the next set of results.</p>
|
|
1309
|
+
* @public
|
|
1310
1310
|
*/
|
|
1311
1311
|
nextToken?: string;
|
|
1312
1312
|
/**
|
|
1313
|
-
* @public
|
|
1314
1313
|
* <p>The maximum number of results to be returned per request.</p>
|
|
1314
|
+
* @public
|
|
1315
1315
|
*/
|
|
1316
1316
|
maxResults?: number;
|
|
1317
1317
|
}
|
|
@@ -1320,14 +1320,14 @@ export interface ListDetectorsRequest {
|
|
|
1320
1320
|
*/
|
|
1321
1321
|
export interface ListDetectorsResponse {
|
|
1322
1322
|
/**
|
|
1323
|
-
* @public
|
|
1324
1323
|
* <p>A list of summary information about the detectors (instances).</p>
|
|
1324
|
+
* @public
|
|
1325
1325
|
*/
|
|
1326
1326
|
detectorSummaries?: DetectorSummary[];
|
|
1327
1327
|
/**
|
|
1328
|
-
* @public
|
|
1329
1328
|
* <p>The token that you can use to return the next set of results,
|
|
1330
1329
|
* or <code>null</code> if there are no more results.</p>
|
|
1330
|
+
* @public
|
|
1331
1331
|
*/
|
|
1332
1332
|
nextToken?: string;
|
|
1333
1333
|
}
|