@aws-sdk/client-iot-events 3.533.0 → 3.540.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/endpoint/endpointResolver.js +4 -2
- package/dist-cjs/index.js +0 -3
- package/dist-es/endpoint/endpointResolver.js +3 -1
- package/dist-es/index.js +0 -1
- package/dist-types/IoTEvents.d.ts +5 -1
- package/dist-types/IoTEventsClient.d.ts +1 -1
- package/dist-types/commands/CreateAlarmModelCommand.d.ts +2 -1
- package/dist-types/commands/CreateDetectorModelCommand.d.ts +2 -1
- package/dist-types/commands/CreateInputCommand.d.ts +2 -1
- package/dist-types/commands/DeleteAlarmModelCommand.d.ts +2 -1
- package/dist-types/commands/DeleteDetectorModelCommand.d.ts +2 -1
- package/dist-types/commands/DeleteInputCommand.d.ts +2 -1
- package/dist-types/commands/DescribeAlarmModelCommand.d.ts +2 -1
- package/dist-types/commands/DescribeDetectorModelAnalysisCommand.d.ts +2 -1
- package/dist-types/commands/DescribeDetectorModelCommand.d.ts +2 -1
- package/dist-types/commands/DescribeInputCommand.d.ts +2 -1
- package/dist-types/commands/DescribeLoggingOptionsCommand.d.ts +2 -1
- package/dist-types/commands/GetDetectorModelAnalysisResultsCommand.d.ts +2 -1
- package/dist-types/commands/ListAlarmModelVersionsCommand.d.ts +2 -1
- package/dist-types/commands/ListAlarmModelsCommand.d.ts +2 -1
- package/dist-types/commands/ListDetectorModelVersionsCommand.d.ts +2 -1
- package/dist-types/commands/ListDetectorModelsCommand.d.ts +2 -1
- package/dist-types/commands/ListInputRoutingsCommand.d.ts +2 -1
- package/dist-types/commands/ListInputsCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/PutLoggingOptionsCommand.d.ts +2 -1
- package/dist-types/commands/StartDetectorModelAnalysisCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateAlarmModelCommand.d.ts +2 -1
- package/dist-types/commands/UpdateDetectorModelCommand.d.ts +2 -1
- package/dist-types/commands/UpdateInputCommand.d.ts +2 -1
- package/dist-types/index.d.ts +0 -1
- package/dist-types/models/models_0.d.ts +378 -378
- package/dist-types/ts3.4/IoTEvents.d.ts +4 -0
- package/dist-types/ts3.4/commands/CreateAlarmModelCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateDetectorModelCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateInputCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteAlarmModelCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteDetectorModelCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteInputCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeAlarmModelCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeDetectorModelAnalysisCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeDetectorModelCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeInputCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeLoggingOptionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetDetectorModelAnalysisResultsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListAlarmModelVersionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListAlarmModelsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListDetectorModelVersionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListDetectorModelsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListInputRoutingsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListInputsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutLoggingOptionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartDetectorModelAnalysisCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateAlarmModelCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateDetectorModelCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateInputCommand.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +0 -1
- package/package.json +40 -40
|
@@ -1,28 +1,28 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { IoTEventsServiceException as __BaseException } from "./IoTEventsServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>Specifies whether to get notified for alarm state changes.</p>
|
|
5
|
+
* @public
|
|
6
6
|
*/
|
|
7
7
|
export interface AcknowledgeFlow {
|
|
8
8
|
/**
|
|
9
|
-
* @public
|
|
10
9
|
* <p>The value must be <code>TRUE</code> or <code>FALSE</code>. If <code>TRUE</code>, you
|
|
11
10
|
* receive a notification when the alarm state changes. You must choose to acknowledge the
|
|
12
11
|
* notification before the alarm state can return to <code>NORMAL</code>. If <code>FALSE</code>,
|
|
13
12
|
* you won't receive notifications. The alarm automatically changes to the <code>NORMAL</code>
|
|
14
13
|
* state when the input property value returns to the specified range.</p>
|
|
14
|
+
* @public
|
|
15
15
|
*/
|
|
16
16
|
enabled: boolean | undefined;
|
|
17
17
|
}
|
|
18
18
|
/**
|
|
19
|
-
* @public
|
|
20
19
|
* <p>Information needed to clear the timer.</p>
|
|
20
|
+
* @public
|
|
21
21
|
*/
|
|
22
22
|
export interface ClearTimerAction {
|
|
23
23
|
/**
|
|
24
|
-
* @public
|
|
25
24
|
* <p>The name of the timer to clear.</p>
|
|
25
|
+
* @public
|
|
26
26
|
*/
|
|
27
27
|
timerName: string | undefined;
|
|
28
28
|
}
|
|
@@ -39,32 +39,31 @@ export declare const PayloadType: {
|
|
|
39
39
|
*/
|
|
40
40
|
export type PayloadType = (typeof PayloadType)[keyof typeof PayloadType];
|
|
41
41
|
/**
|
|
42
|
-
* @public
|
|
43
42
|
* <p>Information needed to configure the payload.</p>
|
|
44
43
|
* <p>By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload
|
|
45
44
|
* contains all attribute-value pairs that have the information about the detector model instance
|
|
46
45
|
* and the event triggered the action. To configure the action payload, you can use
|
|
47
46
|
* <code>contentExpression</code>.</p>
|
|
47
|
+
* @public
|
|
48
48
|
*/
|
|
49
49
|
export interface Payload {
|
|
50
50
|
/**
|
|
51
|
-
* @public
|
|
52
51
|
* <p>The content of the payload. You can use a string expression that includes quoted strings
|
|
53
52
|
* (<code>'<string>'</code>), variables (<code>$variable.<variable-name></code>),
|
|
54
53
|
* input values (<code>$input.<input-name>.<path-to-datum></code>), string
|
|
55
54
|
* concatenations, and quoted strings that contain <code>$\{\}</code> as the content. The
|
|
56
55
|
* recommended maximum size of a content expression is 1 KB.</p>
|
|
56
|
+
* @public
|
|
57
57
|
*/
|
|
58
58
|
contentExpression: string | undefined;
|
|
59
59
|
/**
|
|
60
|
-
* @public
|
|
61
60
|
* <p>The value of the payload type can be either <code>STRING</code> or
|
|
62
61
|
* <code>JSON</code>.</p>
|
|
62
|
+
* @public
|
|
63
63
|
*/
|
|
64
64
|
type: PayloadType | undefined;
|
|
65
65
|
}
|
|
66
66
|
/**
|
|
67
|
-
* @public
|
|
68
67
|
* <p>Defines an action to write to the Amazon DynamoDB table that you created. The standard action
|
|
69
68
|
* payload contains all the information about the detector model instance and the event that
|
|
70
69
|
* triggered the action. You can customize the <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html">payload</a>. One column of the
|
|
@@ -112,10 +111,10 @@ export interface Payload {
|
|
|
112
111
|
* the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text.
|
|
113
112
|
* The value for the <code>payloadField</code> parameter is
|
|
114
113
|
* <code><payload-field>_raw</code>.</p>
|
|
114
|
+
* @public
|
|
115
115
|
*/
|
|
116
116
|
export interface DynamoDBAction {
|
|
117
117
|
/**
|
|
118
|
-
* @public
|
|
119
118
|
* <p>The data type for the hash key (also called the partition key). You can specify the
|
|
120
119
|
* following values:</p>
|
|
121
120
|
* <ul>
|
|
@@ -130,21 +129,21 @@ export interface DynamoDBAction {
|
|
|
130
129
|
* </ul>
|
|
131
130
|
* <p>If you don't specify <code>hashKeyType</code>, the default value is
|
|
132
131
|
* <code>'STRING'</code>.</p>
|
|
132
|
+
* @public
|
|
133
133
|
*/
|
|
134
134
|
hashKeyType?: string;
|
|
135
135
|
/**
|
|
136
|
-
* @public
|
|
137
136
|
* <p>The name of the hash key (also called the partition key). The <code>hashKeyField</code>
|
|
138
137
|
* value must match the partition key of the target DynamoDB table.</p>
|
|
138
|
+
* @public
|
|
139
139
|
*/
|
|
140
140
|
hashKeyField: string | undefined;
|
|
141
141
|
/**
|
|
142
|
-
* @public
|
|
143
142
|
* <p>The value of the hash key (also called the partition key).</p>
|
|
143
|
+
* @public
|
|
144
144
|
*/
|
|
145
145
|
hashKeyValue: string | undefined;
|
|
146
146
|
/**
|
|
147
|
-
* @public
|
|
148
147
|
* <p>The data type for the range key (also called the sort key), You can specify the following
|
|
149
148
|
* values:</p>
|
|
150
149
|
* <ul>
|
|
@@ -159,21 +158,21 @@ export interface DynamoDBAction {
|
|
|
159
158
|
* </ul>
|
|
160
159
|
* <p>If you don't specify <code>rangeKeyField</code>, the default value is
|
|
161
160
|
* <code>'STRING'</code>.</p>
|
|
161
|
+
* @public
|
|
162
162
|
*/
|
|
163
163
|
rangeKeyType?: string;
|
|
164
164
|
/**
|
|
165
|
-
* @public
|
|
166
165
|
* <p>The name of the range key (also called the sort key). The <code>rangeKeyField</code> value
|
|
167
166
|
* must match the sort key of the target DynamoDB table. </p>
|
|
167
|
+
* @public
|
|
168
168
|
*/
|
|
169
169
|
rangeKeyField?: string;
|
|
170
170
|
/**
|
|
171
|
-
* @public
|
|
172
171
|
* <p>The value of the range key (also called the sort key).</p>
|
|
172
|
+
* @public
|
|
173
173
|
*/
|
|
174
174
|
rangeKeyValue?: string;
|
|
175
175
|
/**
|
|
176
|
-
* @public
|
|
177
176
|
* <p>The type of operation to perform. You can specify the following values: </p>
|
|
178
177
|
* <ul>
|
|
179
178
|
* <li>
|
|
@@ -197,33 +196,33 @@ export interface DynamoDBAction {
|
|
|
197
196
|
* </ul>
|
|
198
197
|
* <p>If you don't specify this parameter, AWS IoT Events triggers the <code>'INSERT'</code>
|
|
199
198
|
* operation.</p>
|
|
199
|
+
* @public
|
|
200
200
|
*/
|
|
201
201
|
operation?: string;
|
|
202
202
|
/**
|
|
203
|
-
* @public
|
|
204
203
|
* <p>The name of the DynamoDB column that receives the action payload.</p>
|
|
205
204
|
* <p>If you don't specify this parameter, the name of the DynamoDB column is
|
|
206
205
|
* <code>payload</code>.</p>
|
|
206
|
+
* @public
|
|
207
207
|
*/
|
|
208
208
|
payloadField?: string;
|
|
209
209
|
/**
|
|
210
|
-
* @public
|
|
211
210
|
* <p>The name of the DynamoDB table. The <code>tableName</code> value must match the table name of
|
|
212
211
|
* the target DynamoDB table. </p>
|
|
212
|
+
* @public
|
|
213
213
|
*/
|
|
214
214
|
tableName: string | undefined;
|
|
215
215
|
/**
|
|
216
|
-
* @public
|
|
217
216
|
* <p>Information needed to configure the payload.</p>
|
|
218
217
|
* <p>By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload
|
|
219
218
|
* contains all attribute-value pairs that have the information about the detector model instance
|
|
220
219
|
* and the event triggered the action. To configure the action payload, you can use
|
|
221
220
|
* <code>contentExpression</code>.</p>
|
|
221
|
+
* @public
|
|
222
222
|
*/
|
|
223
223
|
payload?: Payload;
|
|
224
224
|
}
|
|
225
225
|
/**
|
|
226
|
-
* @public
|
|
227
226
|
* <p>Defines an action to write to the Amazon DynamoDB table that you created. The default action
|
|
228
227
|
* payload contains all the information about the detector model instance and the event that
|
|
229
228
|
* triggered the action. You can customize the <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html">payload</a>. A separate column of
|
|
@@ -271,67 +270,67 @@ export interface DynamoDBAction {
|
|
|
271
270
|
* in the <i>AWS IoT Events Developer Guide</i>.</p>
|
|
272
271
|
* <p>The value for the <code>type</code> parameter in <code>Payload</code> must be
|
|
273
272
|
* <code>JSON</code>.</p>
|
|
273
|
+
* @public
|
|
274
274
|
*/
|
|
275
275
|
export interface DynamoDBv2Action {
|
|
276
276
|
/**
|
|
277
|
-
* @public
|
|
278
277
|
* <p>The name of the DynamoDB table.</p>
|
|
278
|
+
* @public
|
|
279
279
|
*/
|
|
280
280
|
tableName: string | undefined;
|
|
281
281
|
/**
|
|
282
|
-
* @public
|
|
283
282
|
* <p>Information needed to configure the payload.</p>
|
|
284
283
|
* <p>By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload
|
|
285
284
|
* contains all attribute-value pairs that have the information about the detector model instance
|
|
286
285
|
* and the event triggered the action. To configure the action payload, you can use
|
|
287
286
|
* <code>contentExpression</code>.</p>
|
|
287
|
+
* @public
|
|
288
288
|
*/
|
|
289
289
|
payload?: Payload;
|
|
290
290
|
}
|
|
291
291
|
/**
|
|
292
|
-
* @public
|
|
293
292
|
* <p>Sends information about the detector model instance and the event that triggered the
|
|
294
293
|
* action to an Amazon Kinesis Data Firehose delivery stream.</p>
|
|
294
|
+
* @public
|
|
295
295
|
*/
|
|
296
296
|
export interface FirehoseAction {
|
|
297
297
|
/**
|
|
298
|
-
* @public
|
|
299
298
|
* <p>The name of the Kinesis Data Firehose delivery stream where the data is written.</p>
|
|
299
|
+
* @public
|
|
300
300
|
*/
|
|
301
301
|
deliveryStreamName: string | undefined;
|
|
302
302
|
/**
|
|
303
|
-
* @public
|
|
304
303
|
* <p>A character separator that is used to separate records written to the Kinesis Data
|
|
305
304
|
* Firehose delivery stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows
|
|
306
305
|
* newline), ',' (comma).</p>
|
|
306
|
+
* @public
|
|
307
307
|
*/
|
|
308
308
|
separator?: string;
|
|
309
309
|
/**
|
|
310
|
-
* @public
|
|
311
310
|
* <p>You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery
|
|
312
311
|
* stream.</p>
|
|
312
|
+
* @public
|
|
313
313
|
*/
|
|
314
314
|
payload?: Payload;
|
|
315
315
|
}
|
|
316
316
|
/**
|
|
317
|
-
* @public
|
|
318
317
|
* <p>Sends an AWS IoT Events input, passing in information about the detector model instance and the
|
|
319
318
|
* event that triggered the action.</p>
|
|
319
|
+
* @public
|
|
320
320
|
*/
|
|
321
321
|
export interface IotEventsAction {
|
|
322
322
|
/**
|
|
323
|
-
* @public
|
|
324
323
|
* <p>The name of the AWS IoT Events input where the data is sent.</p>
|
|
324
|
+
* @public
|
|
325
325
|
*/
|
|
326
326
|
inputName: string | undefined;
|
|
327
327
|
/**
|
|
328
|
-
* @public
|
|
329
328
|
* <p>You can configure the action payload when you send a message to an AWS IoT Events input.</p>
|
|
329
|
+
* @public
|
|
330
330
|
*/
|
|
331
331
|
payload?: Payload;
|
|
332
332
|
}
|
|
333
333
|
/**
|
|
334
|
-
* @public
|
|
335
334
|
* <p>A structure that contains timestamp information. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html">TimeInNanos</a> in the <i>AWS IoT SiteWise API Reference</i>.</p>
|
|
336
335
|
* <p>You must use expressions for all parameters in <code>AssetPropertyTimestamp</code>. The
|
|
337
336
|
* expressions accept literals, operators, functions, references, and substitution
|
|
@@ -363,23 +362,23 @@ export interface IotEventsAction {
|
|
|
363
362
|
* <p>For more information,
|
|
364
363
|
* see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html">Expressions</a>
|
|
365
364
|
* in the <i>AWS IoT Events Developer Guide</i>.</p>
|
|
365
|
+
* @public
|
|
366
366
|
*/
|
|
367
367
|
export interface AssetPropertyTimestamp {
|
|
368
368
|
/**
|
|
369
|
-
* @public
|
|
370
369
|
* <p>The timestamp, in seconds, in the Unix epoch format. The valid range is between
|
|
371
370
|
* 1-31556889864403199.</p>
|
|
371
|
+
* @public
|
|
372
372
|
*/
|
|
373
373
|
timeInSeconds: string | undefined;
|
|
374
374
|
/**
|
|
375
|
-
* @public
|
|
376
375
|
* <p>The nanosecond offset converted from <code>timeInSeconds</code>. The valid range is
|
|
377
376
|
* between 0-999999999.</p>
|
|
377
|
+
* @public
|
|
378
378
|
*/
|
|
379
379
|
offsetInNanos?: string;
|
|
380
380
|
}
|
|
381
381
|
/**
|
|
382
|
-
* @public
|
|
383
382
|
* <p>A structure that contains an asset property value. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html">Variant</a>
|
|
384
383
|
* in the <i>AWS IoT SiteWise API Reference</i>.</p>
|
|
385
384
|
* <p>You must use expressions for all parameters in <code>AssetPropertyVariant</code>. The
|
|
@@ -415,36 +414,36 @@ export interface AssetPropertyTimestamp {
|
|
|
415
414
|
* <p>You must specify one of the following value types, depending on the <code>dataType</code>
|
|
416
415
|
* of the specified asset property. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetProperty.html">AssetProperty</a> in the
|
|
417
416
|
* <i>AWS IoT SiteWise API Reference</i>.</p>
|
|
417
|
+
* @public
|
|
418
418
|
*/
|
|
419
419
|
export interface AssetPropertyVariant {
|
|
420
420
|
/**
|
|
421
|
-
* @public
|
|
422
421
|
* <p>The asset property value is a string. You must use an expression, and the evaluated result
|
|
423
422
|
* should be a string.</p>
|
|
423
|
+
* @public
|
|
424
424
|
*/
|
|
425
425
|
stringValue?: string;
|
|
426
426
|
/**
|
|
427
|
-
* @public
|
|
428
427
|
* <p>The asset property value is an integer. You must use an expression, and the evaluated
|
|
429
428
|
* result should be an integer.</p>
|
|
429
|
+
* @public
|
|
430
430
|
*/
|
|
431
431
|
integerValue?: string;
|
|
432
432
|
/**
|
|
433
|
-
* @public
|
|
434
433
|
* <p>The asset property value is a double. You must use an expression, and the evaluated result
|
|
435
434
|
* should be a double.</p>
|
|
435
|
+
* @public
|
|
436
436
|
*/
|
|
437
437
|
doubleValue?: string;
|
|
438
438
|
/**
|
|
439
|
-
* @public
|
|
440
439
|
* <p>The asset property value is a Boolean value that must be <code>'TRUE'</code> or
|
|
441
440
|
* <code>'FALSE'</code>. You must use an expression, and the evaluated result should be a
|
|
442
441
|
* Boolean value.</p>
|
|
442
|
+
* @public
|
|
443
443
|
*/
|
|
444
444
|
booleanValue?: string;
|
|
445
445
|
}
|
|
446
446
|
/**
|
|
447
|
-
* @public
|
|
448
447
|
* <p>A structure that contains value information. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html">AssetPropertyValue</a> in the <i>AWS IoT SiteWise API Reference</i>.</p>
|
|
449
448
|
* <p>You must use expressions for all parameters in <code>AssetPropertyValue</code>. The
|
|
450
449
|
* expressions accept literals, operators, functions, references, and substitution
|
|
@@ -466,28 +465,28 @@ export interface AssetPropertyVariant {
|
|
|
466
465
|
* <p>For more information,
|
|
467
466
|
* see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html">Expressions</a>
|
|
468
467
|
* in the <i>AWS IoT Events Developer Guide</i>.</p>
|
|
468
|
+
* @public
|
|
469
469
|
*/
|
|
470
470
|
export interface AssetPropertyValue {
|
|
471
471
|
/**
|
|
472
|
-
* @public
|
|
473
472
|
* <p>The value to send to an asset property.</p>
|
|
473
|
+
* @public
|
|
474
474
|
*/
|
|
475
475
|
value?: AssetPropertyVariant;
|
|
476
476
|
/**
|
|
477
|
-
* @public
|
|
478
477
|
* <p>The timestamp associated with the asset property value. The default is the current event
|
|
479
478
|
* time.</p>
|
|
479
|
+
* @public
|
|
480
480
|
*/
|
|
481
481
|
timestamp?: AssetPropertyTimestamp;
|
|
482
482
|
/**
|
|
483
|
-
* @public
|
|
484
483
|
* <p>The quality of the asset property value. The value must be <code>'GOOD'</code>,
|
|
485
484
|
* <code>'BAD'</code>, or <code>'UNCERTAIN'</code>.</p>
|
|
485
|
+
* @public
|
|
486
486
|
*/
|
|
487
487
|
quality?: string;
|
|
488
488
|
}
|
|
489
489
|
/**
|
|
490
|
-
* @public
|
|
491
490
|
* <p>Sends information about the detector model instance and the event that triggered the
|
|
492
491
|
* action to a specified asset property in AWS IoT SiteWise.</p>
|
|
493
492
|
* <p>You must use expressions for all parameters in <code>IotSiteWiseAction</code>. The
|
|
@@ -524,298 +523,298 @@ export interface AssetPropertyValue {
|
|
|
524
523
|
* <p>For more information,
|
|
525
524
|
* see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html">Expressions</a>
|
|
526
525
|
* in the <i>AWS IoT Events Developer Guide</i>.</p>
|
|
526
|
+
* @public
|
|
527
527
|
*/
|
|
528
528
|
export interface IotSiteWiseAction {
|
|
529
529
|
/**
|
|
530
|
-
* @public
|
|
531
530
|
* <p>A unique identifier for this entry. You can use the entry ID to track which data entry
|
|
532
531
|
* causes an error in case of failure. The default is a new unique identifier.</p>
|
|
532
|
+
* @public
|
|
533
533
|
*/
|
|
534
534
|
entryId?: string;
|
|
535
535
|
/**
|
|
536
|
-
* @public
|
|
537
536
|
* <p>The ID of the asset that has the specified property.</p>
|
|
537
|
+
* @public
|
|
538
538
|
*/
|
|
539
539
|
assetId?: string;
|
|
540
540
|
/**
|
|
541
|
-
* @public
|
|
542
541
|
* <p>The ID of the asset property.</p>
|
|
542
|
+
* @public
|
|
543
543
|
*/
|
|
544
544
|
propertyId?: string;
|
|
545
545
|
/**
|
|
546
|
-
* @public
|
|
547
546
|
* <p>The alias of the asset property.</p>
|
|
547
|
+
* @public
|
|
548
548
|
*/
|
|
549
549
|
propertyAlias?: string;
|
|
550
550
|
/**
|
|
551
|
-
* @public
|
|
552
551
|
* <p>The value to send to the asset property. This value contains timestamp, quality, and value
|
|
553
552
|
* (TQV) information. </p>
|
|
553
|
+
* @public
|
|
554
554
|
*/
|
|
555
555
|
propertyValue?: AssetPropertyValue;
|
|
556
556
|
}
|
|
557
557
|
/**
|
|
558
|
-
* @public
|
|
559
558
|
* <p>Information required to publish the MQTT message through the AWS IoT message broker.</p>
|
|
559
|
+
* @public
|
|
560
560
|
*/
|
|
561
561
|
export interface IotTopicPublishAction {
|
|
562
562
|
/**
|
|
563
|
-
* @public
|
|
564
563
|
* <p>The MQTT topic of the message. You can use a string expression that includes variables
|
|
565
564
|
* (<code>$variable.<variable-name></code>) and input values
|
|
566
565
|
* (<code>$input.<input-name>.<path-to-datum></code>) as the topic string.</p>
|
|
566
|
+
* @public
|
|
567
567
|
*/
|
|
568
568
|
mqttTopic: string | undefined;
|
|
569
569
|
/**
|
|
570
|
-
* @public
|
|
571
570
|
* <p>You can configure the action payload when you publish a message to an AWS IoT Core
|
|
572
571
|
* topic.</p>
|
|
572
|
+
* @public
|
|
573
573
|
*/
|
|
574
574
|
payload?: Payload;
|
|
575
575
|
}
|
|
576
576
|
/**
|
|
577
|
-
* @public
|
|
578
577
|
* <p>Calls a Lambda function, passing in information about the detector model instance and the
|
|
579
578
|
* event that triggered the action.</p>
|
|
579
|
+
* @public
|
|
580
580
|
*/
|
|
581
581
|
export interface LambdaAction {
|
|
582
582
|
/**
|
|
583
|
-
* @public
|
|
584
583
|
* <p>The ARN of the Lambda function that is executed.</p>
|
|
584
|
+
* @public
|
|
585
585
|
*/
|
|
586
586
|
functionArn: string | undefined;
|
|
587
587
|
/**
|
|
588
|
-
* @public
|
|
589
588
|
* <p>You can configure the action payload when you send a message to a Lambda function.</p>
|
|
589
|
+
* @public
|
|
590
590
|
*/
|
|
591
591
|
payload?: Payload;
|
|
592
592
|
}
|
|
593
593
|
/**
|
|
594
|
-
* @public
|
|
595
594
|
* <p>Information required to reset the timer. The timer is reset to the previously evaluated
|
|
596
595
|
* result of the duration. The duration expression isn't reevaluated when you reset the
|
|
597
596
|
* timer.</p>
|
|
597
|
+
* @public
|
|
598
598
|
*/
|
|
599
599
|
export interface ResetTimerAction {
|
|
600
600
|
/**
|
|
601
|
-
* @public
|
|
602
601
|
* <p>The name of the timer to reset.</p>
|
|
602
|
+
* @public
|
|
603
603
|
*/
|
|
604
604
|
timerName: string | undefined;
|
|
605
605
|
}
|
|
606
606
|
/**
|
|
607
|
-
* @public
|
|
608
607
|
* <p>Information needed to set the timer.</p>
|
|
608
|
+
* @public
|
|
609
609
|
*/
|
|
610
610
|
export interface SetTimerAction {
|
|
611
611
|
/**
|
|
612
|
-
* @public
|
|
613
612
|
* <p>The name of the timer.</p>
|
|
613
|
+
* @public
|
|
614
614
|
*/
|
|
615
615
|
timerName: string | undefined;
|
|
616
616
|
/**
|
|
617
|
-
* @public
|
|
618
617
|
* @deprecated
|
|
619
618
|
*
|
|
620
619
|
* <p>The number of seconds until the timer expires. The minimum value is 60 seconds to ensure
|
|
621
620
|
* accuracy. The maximum value is 31622400 seconds. </p>
|
|
621
|
+
* @public
|
|
622
622
|
*/
|
|
623
623
|
seconds?: number;
|
|
624
624
|
/**
|
|
625
|
-
* @public
|
|
626
625
|
* <p>The duration of the timer, in seconds. You can use a string expression that includes
|
|
627
626
|
* numbers, variables (<code>$variable.<variable-name></code>), and input values
|
|
628
627
|
* (<code>$input.<input-name>.<path-to-datum></code>) as the duration. The range of
|
|
629
628
|
* the duration is 1-31622400 seconds. To ensure accuracy, the minimum duration is 60 seconds.
|
|
630
629
|
* The evaluated result of the duration is rounded down to the nearest whole number. </p>
|
|
630
|
+
* @public
|
|
631
631
|
*/
|
|
632
632
|
durationExpression?: string;
|
|
633
633
|
}
|
|
634
634
|
/**
|
|
635
|
-
* @public
|
|
636
635
|
* <p>Information about the variable and its new value.</p>
|
|
636
|
+
* @public
|
|
637
637
|
*/
|
|
638
638
|
export interface SetVariableAction {
|
|
639
639
|
/**
|
|
640
|
-
* @public
|
|
641
640
|
* <p>The name of the variable.</p>
|
|
641
|
+
* @public
|
|
642
642
|
*/
|
|
643
643
|
variableName: string | undefined;
|
|
644
644
|
/**
|
|
645
|
-
* @public
|
|
646
645
|
* <p>The new value of the variable.</p>
|
|
646
|
+
* @public
|
|
647
647
|
*/
|
|
648
648
|
value: string | undefined;
|
|
649
649
|
}
|
|
650
650
|
/**
|
|
651
|
-
* @public
|
|
652
651
|
* <p>Information required to publish the Amazon SNS message.</p>
|
|
652
|
+
* @public
|
|
653
653
|
*/
|
|
654
654
|
export interface SNSTopicPublishAction {
|
|
655
655
|
/**
|
|
656
|
-
* @public
|
|
657
656
|
* <p>The ARN of the Amazon SNS target where the message is sent.</p>
|
|
657
|
+
* @public
|
|
658
658
|
*/
|
|
659
659
|
targetArn: string | undefined;
|
|
660
660
|
/**
|
|
661
|
-
* @public
|
|
662
661
|
* <p>You can configure the action payload when you send a message as an Amazon SNS push
|
|
663
662
|
* notification.</p>
|
|
663
|
+
* @public
|
|
664
664
|
*/
|
|
665
665
|
payload?: Payload;
|
|
666
666
|
}
|
|
667
667
|
/**
|
|
668
|
-
* @public
|
|
669
668
|
* <p>Sends information about the detector model instance and the event that triggered the
|
|
670
669
|
* action to an Amazon SQS queue.</p>
|
|
670
|
+
* @public
|
|
671
671
|
*/
|
|
672
672
|
export interface SqsAction {
|
|
673
673
|
/**
|
|
674
|
-
* @public
|
|
675
674
|
* <p>The URL of the SQS queue where the data is written.</p>
|
|
675
|
+
* @public
|
|
676
676
|
*/
|
|
677
677
|
queueUrl: string | undefined;
|
|
678
678
|
/**
|
|
679
|
-
* @public
|
|
680
679
|
* <p>Set this to TRUE if you want the data to be base-64 encoded before it is written to the
|
|
681
680
|
* queue. Otherwise, set this to FALSE.</p>
|
|
681
|
+
* @public
|
|
682
682
|
*/
|
|
683
683
|
useBase64?: boolean;
|
|
684
684
|
/**
|
|
685
|
-
* @public
|
|
686
685
|
* <p>You can configure the action payload when you send a message to an Amazon SQS
|
|
687
686
|
* queue.</p>
|
|
687
|
+
* @public
|
|
688
688
|
*/
|
|
689
689
|
payload?: Payload;
|
|
690
690
|
}
|
|
691
691
|
/**
|
|
692
|
-
* @public
|
|
693
692
|
* <p>An action to be performed when the <code>condition</code> is TRUE.</p>
|
|
693
|
+
* @public
|
|
694
694
|
*/
|
|
695
695
|
export interface Action {
|
|
696
696
|
/**
|
|
697
|
-
* @public
|
|
698
697
|
* <p>Sets a variable to a specified value.</p>
|
|
698
|
+
* @public
|
|
699
699
|
*/
|
|
700
700
|
setVariable?: SetVariableAction;
|
|
701
701
|
/**
|
|
702
|
-
* @public
|
|
703
702
|
* <p>Sends an Amazon SNS message.</p>
|
|
703
|
+
* @public
|
|
704
704
|
*/
|
|
705
705
|
sns?: SNSTopicPublishAction;
|
|
706
706
|
/**
|
|
707
|
-
* @public
|
|
708
707
|
* <p>Publishes an MQTT message with the given topic to the AWS IoT message broker.</p>
|
|
708
|
+
* @public
|
|
709
709
|
*/
|
|
710
710
|
iotTopicPublish?: IotTopicPublishAction;
|
|
711
711
|
/**
|
|
712
|
-
* @public
|
|
713
712
|
* <p>Information needed to set the timer.</p>
|
|
713
|
+
* @public
|
|
714
714
|
*/
|
|
715
715
|
setTimer?: SetTimerAction;
|
|
716
716
|
/**
|
|
717
|
-
* @public
|
|
718
717
|
* <p>Information needed to clear the timer.</p>
|
|
718
|
+
* @public
|
|
719
719
|
*/
|
|
720
720
|
clearTimer?: ClearTimerAction;
|
|
721
721
|
/**
|
|
722
|
-
* @public
|
|
723
722
|
* <p>Information needed to reset the timer.</p>
|
|
723
|
+
* @public
|
|
724
724
|
*/
|
|
725
725
|
resetTimer?: ResetTimerAction;
|
|
726
726
|
/**
|
|
727
|
-
* @public
|
|
728
727
|
* <p>Calls a Lambda function, passing in information about the detector model instance and the
|
|
729
728
|
* event that triggered the action.</p>
|
|
729
|
+
* @public
|
|
730
730
|
*/
|
|
731
731
|
lambda?: LambdaAction;
|
|
732
732
|
/**
|
|
733
|
-
* @public
|
|
734
733
|
* <p>Sends AWS IoT Events input, which passes information about the detector model instance and the
|
|
735
734
|
* event that triggered the action.</p>
|
|
735
|
+
* @public
|
|
736
736
|
*/
|
|
737
737
|
iotEvents?: IotEventsAction;
|
|
738
738
|
/**
|
|
739
|
-
* @public
|
|
740
739
|
* <p>Sends information about the detector model instance and the event that triggered the
|
|
741
740
|
* action to an Amazon SQS queue.</p>
|
|
741
|
+
* @public
|
|
742
742
|
*/
|
|
743
743
|
sqs?: SqsAction;
|
|
744
744
|
/**
|
|
745
|
-
* @public
|
|
746
745
|
* <p>Sends information about the detector model instance and the event that triggered the
|
|
747
746
|
* action to an Amazon Kinesis Data Firehose delivery stream.</p>
|
|
747
|
+
* @public
|
|
748
748
|
*/
|
|
749
749
|
firehose?: FirehoseAction;
|
|
750
750
|
/**
|
|
751
|
-
* @public
|
|
752
751
|
* <p>Writes to the DynamoDB table that you created. The default action payload contains all
|
|
753
752
|
* attribute-value pairs that have the information about the detector model instance and the
|
|
754
753
|
* event that triggered the action. You can customize the <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html">payload</a>. One column of the
|
|
755
754
|
* DynamoDB table receives all attribute-value pairs in the payload that you specify. For more
|
|
756
755
|
* information, see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html">Actions</a> in
|
|
757
756
|
* <i>AWS IoT Events Developer Guide</i>.</p>
|
|
757
|
+
* @public
|
|
758
758
|
*/
|
|
759
759
|
dynamoDB?: DynamoDBAction;
|
|
760
760
|
/**
|
|
761
|
-
* @public
|
|
762
761
|
* <p>Writes to the DynamoDB table that you created. The default action payload contains all
|
|
763
762
|
* attribute-value pairs that have the information about the detector model instance and the
|
|
764
763
|
* event that triggered the action. You can customize the <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html">payload</a>. A separate column of
|
|
765
764
|
* the DynamoDB table receives one attribute-value pair in the payload that you specify. For more
|
|
766
765
|
* information, see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html">Actions</a> in
|
|
767
766
|
* <i>AWS IoT Events Developer Guide</i>.</p>
|
|
767
|
+
* @public
|
|
768
768
|
*/
|
|
769
769
|
dynamoDBv2?: DynamoDBv2Action;
|
|
770
770
|
/**
|
|
771
|
-
* @public
|
|
772
771
|
* <p>Sends information about the detector model instance and the event that triggered the
|
|
773
772
|
* action to an asset property in AWS IoT SiteWise .</p>
|
|
773
|
+
* @public
|
|
774
774
|
*/
|
|
775
775
|
iotSiteWise?: IotSiteWiseAction;
|
|
776
776
|
}
|
|
777
777
|
/**
|
|
778
|
-
* @public
|
|
779
778
|
* <p>Specifies one of the following actions to receive notifications when the alarm state
|
|
780
779
|
* changes.</p>
|
|
780
|
+
* @public
|
|
781
781
|
*/
|
|
782
782
|
export interface AlarmAction {
|
|
783
783
|
/**
|
|
784
|
-
* @public
|
|
785
784
|
* <p>Information required to publish the Amazon SNS message.</p>
|
|
785
|
+
* @public
|
|
786
786
|
*/
|
|
787
787
|
sns?: SNSTopicPublishAction;
|
|
788
788
|
/**
|
|
789
|
-
* @public
|
|
790
789
|
* <p>Information required to publish the MQTT message through the AWS IoT message broker.</p>
|
|
790
|
+
* @public
|
|
791
791
|
*/
|
|
792
792
|
iotTopicPublish?: IotTopicPublishAction;
|
|
793
793
|
/**
|
|
794
|
-
* @public
|
|
795
794
|
* <p>Calls a Lambda function, passing in information about the detector model instance and the
|
|
796
795
|
* event that triggered the action.</p>
|
|
796
|
+
* @public
|
|
797
797
|
*/
|
|
798
798
|
lambda?: LambdaAction;
|
|
799
799
|
/**
|
|
800
|
-
* @public
|
|
801
800
|
* <p>Sends an AWS IoT Events input, passing in information about the detector model instance and the
|
|
802
801
|
* event that triggered the action.</p>
|
|
802
|
+
* @public
|
|
803
803
|
*/
|
|
804
804
|
iotEvents?: IotEventsAction;
|
|
805
805
|
/**
|
|
806
|
-
* @public
|
|
807
806
|
* <p>Sends information about the detector model instance and the event that triggered the
|
|
808
807
|
* action to an Amazon SQS queue.</p>
|
|
808
|
+
* @public
|
|
809
809
|
*/
|
|
810
810
|
sqs?: SqsAction;
|
|
811
811
|
/**
|
|
812
|
-
* @public
|
|
813
812
|
* <p>Sends information about the detector model instance and the event that triggered the
|
|
814
813
|
* action to an Amazon Kinesis Data Firehose delivery stream.</p>
|
|
814
|
+
* @public
|
|
815
815
|
*/
|
|
816
816
|
firehose?: FirehoseAction;
|
|
817
817
|
/**
|
|
818
|
-
* @public
|
|
819
818
|
* <p>Defines an action to write to the Amazon DynamoDB table that you created. The standard action
|
|
820
819
|
* payload contains all the information about the detector model instance and the event that
|
|
821
820
|
* triggered the action. You can customize the <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html">payload</a>. One column of the
|
|
@@ -863,10 +862,10 @@ export interface AlarmAction {
|
|
|
863
862
|
* the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text.
|
|
864
863
|
* The value for the <code>payloadField</code> parameter is
|
|
865
864
|
* <code><payload-field>_raw</code>.</p>
|
|
865
|
+
* @public
|
|
866
866
|
*/
|
|
867
867
|
dynamoDB?: DynamoDBAction;
|
|
868
868
|
/**
|
|
869
|
-
* @public
|
|
870
869
|
* <p>Defines an action to write to the Amazon DynamoDB table that you created. The default action
|
|
871
870
|
* payload contains all the information about the detector model instance and the event that
|
|
872
871
|
* triggered the action. You can customize the <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html">payload</a>. A separate column of
|
|
@@ -914,10 +913,10 @@ export interface AlarmAction {
|
|
|
914
913
|
* in the <i>AWS IoT Events Developer Guide</i>.</p>
|
|
915
914
|
* <p>The value for the <code>type</code> parameter in <code>Payload</code> must be
|
|
916
915
|
* <code>JSON</code>.</p>
|
|
916
|
+
* @public
|
|
917
917
|
*/
|
|
918
918
|
dynamoDBv2?: DynamoDBv2Action;
|
|
919
919
|
/**
|
|
920
|
-
* @public
|
|
921
920
|
* <p>Sends information about the detector model instance and the event that triggered the
|
|
922
921
|
* action to a specified asset property in AWS IoT SiteWise.</p>
|
|
923
922
|
* <p>You must use expressions for all parameters in <code>IotSiteWiseAction</code>. The
|
|
@@ -954,70 +953,71 @@ export interface AlarmAction {
|
|
|
954
953
|
* <p>For more information,
|
|
955
954
|
* see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html">Expressions</a>
|
|
956
955
|
* in the <i>AWS IoT Events Developer Guide</i>.</p>
|
|
956
|
+
* @public
|
|
957
957
|
*/
|
|
958
958
|
iotSiteWise?: IotSiteWiseAction;
|
|
959
959
|
}
|
|
960
960
|
/**
|
|
961
|
-
* @public
|
|
962
961
|
* <p>Specifies the default alarm state.
|
|
963
962
|
* The configuration applies to all alarms that were created based on this alarm model.</p>
|
|
963
|
+
* @public
|
|
964
964
|
*/
|
|
965
965
|
export interface InitializationConfiguration {
|
|
966
966
|
/**
|
|
967
|
-
* @public
|
|
968
967
|
* <p>The value must be <code>TRUE</code> or <code>FALSE</code>. If <code>FALSE</code>, all
|
|
969
968
|
* alarm instances created based on the alarm model are activated. The default value is
|
|
970
969
|
* <code>TRUE</code>.</p>
|
|
970
|
+
* @public
|
|
971
971
|
*/
|
|
972
972
|
disabledOnInitialization: boolean | undefined;
|
|
973
973
|
}
|
|
974
974
|
/**
|
|
975
|
-
* @public
|
|
976
975
|
* <p>Contains the configuration information of alarm state changes.</p>
|
|
976
|
+
* @public
|
|
977
977
|
*/
|
|
978
978
|
export interface AlarmCapabilities {
|
|
979
979
|
/**
|
|
980
|
-
* @public
|
|
981
980
|
* <p>Specifies the default alarm state.
|
|
982
981
|
* The configuration applies to all alarms that were created based on this alarm model.</p>
|
|
982
|
+
* @public
|
|
983
983
|
*/
|
|
984
984
|
initializationConfiguration?: InitializationConfiguration;
|
|
985
985
|
/**
|
|
986
|
-
* @public
|
|
987
986
|
* <p>Specifies whether to get notified for alarm state changes.</p>
|
|
987
|
+
* @public
|
|
988
988
|
*/
|
|
989
989
|
acknowledgeFlow?: AcknowledgeFlow;
|
|
990
990
|
}
|
|
991
991
|
/**
|
|
992
|
-
* @public
|
|
993
992
|
* <p>Contains information about one or more alarm actions.</p>
|
|
993
|
+
* @public
|
|
994
994
|
*/
|
|
995
995
|
export interface AlarmEventActions {
|
|
996
996
|
/**
|
|
997
|
-
* @public
|
|
998
997
|
* <p>Specifies one or more supported actions to receive notifications when the alarm state
|
|
999
998
|
* changes.</p>
|
|
999
|
+
* @public
|
|
1000
1000
|
*/
|
|
1001
1001
|
alarmActions?: AlarmAction[];
|
|
1002
1002
|
}
|
|
1003
1003
|
/**
|
|
1004
|
-
* @public
|
|
1005
1004
|
* <p>Contains a summary of an alarm model.</p>
|
|
1005
|
+
* @public
|
|
1006
1006
|
*/
|
|
1007
1007
|
export interface AlarmModelSummary {
|
|
1008
1008
|
/**
|
|
1009
|
-
* @public
|
|
1010
1009
|
* <p>The time the alarm model was created, in the Unix epoch format.</p>
|
|
1010
|
+
* @public
|
|
1011
1011
|
*/
|
|
1012
1012
|
creationTime?: Date;
|
|
1013
1013
|
/**
|
|
1014
|
-
* @public
|
|
1015
1014
|
* <p>The description of the alarm model.</p>
|
|
1015
|
+
* @public
|
|
1016
1016
|
*/
|
|
1017
1017
|
alarmModelDescription?: string;
|
|
1018
1018
|
/**
|
|
1019
|
-
* @public
|
|
1020
1019
|
* <p>The name of the alarm model.</p>
|
|
1020
|
+
* @public
|
|
1021
1021
|
*/
|
|
1022
1022
|
alarmModelName?: string;
|
|
1023
1023
|
}
|
|
@@ -1036,42 +1036,41 @@ export declare const AlarmModelVersionStatus: {
|
|
|
1036
1036
|
*/
|
|
1037
1037
|
export type AlarmModelVersionStatus = (typeof AlarmModelVersionStatus)[keyof typeof AlarmModelVersionStatus];
|
|
1038
1038
|
/**
|
|
1039
|
-
* @public
|
|
1040
1039
|
* <p>Contains a summary of an alarm model version.</p>
|
|
1040
|
+
* @public
|
|
1041
1041
|
*/
|
|
1042
1042
|
export interface AlarmModelVersionSummary {
|
|
1043
1043
|
/**
|
|
1044
|
-
* @public
|
|
1045
1044
|
* <p>The name of the alarm model.</p>
|
|
1045
|
+
* @public
|
|
1046
1046
|
*/
|
|
1047
1047
|
alarmModelName?: string;
|
|
1048
1048
|
/**
|
|
1049
|
-
* @public
|
|
1050
1049
|
* <p>The ARN of the alarm model. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>
|
|
1050
|
+
* @public
|
|
1051
1051
|
*/
|
|
1052
1052
|
alarmModelArn?: string;
|
|
1053
1053
|
/**
|
|
1054
|
-
* @public
|
|
1055
1054
|
* <p>The version of the alarm model.</p>
|
|
1055
|
+
* @public
|
|
1056
1056
|
*/
|
|
1057
1057
|
alarmModelVersion?: string;
|
|
1058
1058
|
/**
|
|
1059
|
-
* @public
|
|
1060
1059
|
* <p>The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>
|
|
1060
|
+
* @public
|
|
1061
1061
|
*/
|
|
1062
1062
|
roleArn?: string;
|
|
1063
1063
|
/**
|
|
1064
|
-
* @public
|
|
1065
1064
|
* <p>The time the alarm model was created, in the Unix epoch format.</p>
|
|
1065
|
+
* @public
|
|
1066
1066
|
*/
|
|
1067
1067
|
creationTime?: Date;
|
|
1068
1068
|
/**
|
|
1069
|
-
* @public
|
|
1070
1069
|
* <p>The time the alarm model was last updated, in the Unix epoch format.</p>
|
|
1070
|
+
* @public
|
|
1071
1071
|
*/
|
|
1072
1072
|
lastUpdateTime?: Date;
|
|
1073
1073
|
/**
|
|
1074
|
-
* @public
|
|
1075
1074
|
* <p>The status of the alarm model. The status can be one of the following values:</p>
|
|
1076
1075
|
* <ul>
|
|
1077
1076
|
* <li>
|
|
@@ -1094,172 +1093,173 @@ export interface AlarmModelVersionSummary {
|
|
|
1094
1093
|
* and try again.</p>
|
|
1095
1094
|
* </li>
|
|
1096
1095
|
* </ul>
|
|
1096
|
+
* @public
|
|
1097
1097
|
*/
|
|
1098
1098
|
status?: AlarmModelVersionStatus;
|
|
1099
1099
|
/**
|
|
1100
|
-
* @public
|
|
1101
1100
|
* <p>
|
|
1102
1101
|
* Contains information about the status of the alarm model version.
|
|
1103
1102
|
* </p>
|
|
1103
|
+
* @public
|
|
1104
1104
|
*/
|
|
1105
1105
|
statusMessage?: string;
|
|
1106
1106
|
}
|
|
1107
1107
|
/**
|
|
1108
|
-
* @public
|
|
1109
1108
|
* <p>Specifies an AWS Lambda function to manage alarm notifications.
|
|
1110
1109
|
* You can create one or use the <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html">AWS Lambda function provided by AWS IoT Events</a>.</p>
|
|
1110
|
+
* @public
|
|
1111
1111
|
*/
|
|
1112
1112
|
export interface NotificationTargetActions {
|
|
1113
1113
|
/**
|
|
1114
|
-
* @public
|
|
1115
1114
|
* <p>Calls a Lambda function, passing in information about the detector model instance and the
|
|
1116
1115
|
* event that triggered the action.</p>
|
|
1116
|
+
* @public
|
|
1117
1117
|
*/
|
|
1118
1118
|
lambdaAction?: LambdaAction;
|
|
1119
1119
|
}
|
|
1120
1120
|
/**
|
|
1121
|
-
* @public
|
|
1122
1121
|
* <p>Contains the subject and message of an email.</p>
|
|
1122
|
+
* @public
|
|
1123
1123
|
*/
|
|
1124
1124
|
export interface EmailContent {
|
|
1125
1125
|
/**
|
|
1126
|
-
* @public
|
|
1127
1126
|
* <p>The subject of the email.</p>
|
|
1127
|
+
* @public
|
|
1128
1128
|
*/
|
|
1129
1129
|
subject?: string;
|
|
1130
1130
|
/**
|
|
1131
|
-
* @public
|
|
1132
1131
|
* <p>The message that you want to send. The message can be up to 200 characters.</p>
|
|
1132
|
+
* @public
|
|
1133
1133
|
*/
|
|
1134
1134
|
additionalMessage?: string;
|
|
1135
1135
|
}
|
|
1136
1136
|
/**
|
|
1137
|
-
* @public
|
|
1138
1137
|
* <p>Contains information about your identity source in AWS Single Sign-On. For more information, see
|
|
1139
1138
|
* the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">AWS Single Sign-On
|
|
1140
1139
|
* User Guide</a>.</p>
|
|
1140
|
+
* @public
|
|
1141
1141
|
*/
|
|
1142
1142
|
export interface SSOIdentity {
|
|
1143
1143
|
/**
|
|
1144
|
-
* @public
|
|
1145
1144
|
* <p>The ID of the AWS SSO identity store.</p>
|
|
1145
|
+
* @public
|
|
1146
1146
|
*/
|
|
1147
1147
|
identityStoreId: string | undefined;
|
|
1148
1148
|
/**
|
|
1149
|
-
* @public
|
|
1150
1149
|
* <p>The user ID.</p>
|
|
1150
|
+
* @public
|
|
1151
1151
|
*/
|
|
1152
1152
|
userId?: string;
|
|
1153
1153
|
}
|
|
1154
1154
|
/**
|
|
1155
|
-
* @public
|
|
1156
1155
|
* <p>The information that identifies the recipient.</p>
|
|
1156
|
+
* @public
|
|
1157
1157
|
*/
|
|
1158
1158
|
export interface RecipientDetail {
|
|
1159
1159
|
/**
|
|
1160
|
-
* @public
|
|
1161
1160
|
* <p>The AWS Single Sign-On (AWS SSO) authentication information.</p>
|
|
1161
|
+
* @public
|
|
1162
1162
|
*/
|
|
1163
1163
|
ssoIdentity?: SSOIdentity;
|
|
1164
1164
|
}
|
|
1165
1165
|
/**
|
|
1166
|
-
* @public
|
|
1167
1166
|
* <p>Contains the information of one or more recipients who receive the emails.</p>
|
|
1168
1167
|
* <important>
|
|
1169
1168
|
* <p>You must <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/addusers.html">add the users that receive emails to your AWS SSO store</a>.</p>
|
|
1170
1169
|
* </important>
|
|
1170
|
+
* @public
|
|
1171
1171
|
*/
|
|
1172
1172
|
export interface EmailRecipients {
|
|
1173
1173
|
/**
|
|
1174
|
-
* @public
|
|
1175
1174
|
* <p>Specifies one or more recipients who receive the email.</p>
|
|
1175
|
+
* @public
|
|
1176
1176
|
*/
|
|
1177
1177
|
to?: RecipientDetail[];
|
|
1178
1178
|
}
|
|
1179
1179
|
/**
|
|
1180
|
-
* @public
|
|
1181
1180
|
* <p>Contains the configuration information of email notifications.</p>
|
|
1181
|
+
* @public
|
|
1182
1182
|
*/
|
|
1183
1183
|
export interface EmailConfiguration {
|
|
1184
1184
|
/**
|
|
1185
|
-
* @public
|
|
1186
1185
|
* <p>The email address that sends emails.</p>
|
|
1187
1186
|
* <important>
|
|
1188
1187
|
* <p>If you use the AWS IoT Events managed AWS Lambda function to manage your emails, you must <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html">verify
|
|
1189
1188
|
* the email address that sends emails in Amazon SES</a>.</p>
|
|
1190
1189
|
* </important>
|
|
1190
|
+
* @public
|
|
1191
1191
|
*/
|
|
1192
1192
|
from: string | undefined;
|
|
1193
1193
|
/**
|
|
1194
|
-
* @public
|
|
1195
1194
|
* <p>Contains the subject and message of an email.</p>
|
|
1195
|
+
* @public
|
|
1196
1196
|
*/
|
|
1197
1197
|
content?: EmailContent;
|
|
1198
1198
|
/**
|
|
1199
|
-
* @public
|
|
1200
1199
|
* <p>Contains the information of one or more recipients who receive the emails.</p>
|
|
1201
1200
|
* <important>
|
|
1202
1201
|
* <p>You must <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/addusers.html">add the users that receive emails to your AWS SSO store</a>.</p>
|
|
1203
1202
|
* </important>
|
|
1203
|
+
* @public
|
|
1204
1204
|
*/
|
|
1205
1205
|
recipients: EmailRecipients | undefined;
|
|
1206
1206
|
}
|
|
1207
1207
|
/**
|
|
1208
|
-
* @public
|
|
1209
1208
|
* <p>Contains the configuration information of SMS notifications.</p>
|
|
1209
|
+
* @public
|
|
1210
1210
|
*/
|
|
1211
1211
|
export interface SMSConfiguration {
|
|
1212
1212
|
/**
|
|
1213
|
-
* @public
|
|
1214
1213
|
* <p>The sender ID.</p>
|
|
1214
|
+
* @public
|
|
1215
1215
|
*/
|
|
1216
1216
|
senderId?: string;
|
|
1217
1217
|
/**
|
|
1218
|
-
* @public
|
|
1219
1218
|
* <p>The message that you want to send. The message can be up to 200 characters.</p>
|
|
1219
|
+
* @public
|
|
1220
1220
|
*/
|
|
1221
1221
|
additionalMessage?: string;
|
|
1222
1222
|
/**
|
|
1223
|
-
* @public
|
|
1224
1223
|
* <p>Specifies one or more recipients who receive the message.</p>
|
|
1225
1224
|
* <important>
|
|
1226
1225
|
* <p>You must <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/addusers.html">add the users that receive SMS messages to your AWS SSO store</a>.</p>
|
|
1227
1226
|
* </important>
|
|
1227
|
+
* @public
|
|
1228
1228
|
*/
|
|
1229
1229
|
recipients: RecipientDetail[] | undefined;
|
|
1230
1230
|
}
|
|
1231
1231
|
/**
|
|
1232
|
-
* @public
|
|
1233
1232
|
* <p>Contains the notification settings of an alarm model.
|
|
1234
1233
|
* The settings apply to all alarms that were created based on this alarm model.</p>
|
|
1234
|
+
* @public
|
|
1235
1235
|
*/
|
|
1236
1236
|
export interface NotificationAction {
|
|
1237
1237
|
/**
|
|
1238
|
-
* @public
|
|
1239
1238
|
* <p>Specifies an AWS Lambda function to manage alarm notifications.
|
|
1240
1239
|
* You can create one or use the <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html">AWS Lambda function provided by AWS IoT Events</a>.</p>
|
|
1240
|
+
* @public
|
|
1241
1241
|
*/
|
|
1242
1242
|
action: NotificationTargetActions | undefined;
|
|
1243
1243
|
/**
|
|
1244
|
-
* @public
|
|
1245
1244
|
* <p>Contains the configuration information of SMS notifications.</p>
|
|
1245
|
+
* @public
|
|
1246
1246
|
*/
|
|
1247
1247
|
smsConfigurations?: SMSConfiguration[];
|
|
1248
1248
|
/**
|
|
1249
|
-
* @public
|
|
1250
1249
|
* <p>Contains the configuration information of email notifications.</p>
|
|
1250
|
+
* @public
|
|
1251
1251
|
*/
|
|
1252
1252
|
emailConfigurations?: EmailConfiguration[];
|
|
1253
1253
|
}
|
|
1254
1254
|
/**
|
|
1255
|
-
* @public
|
|
1256
1255
|
* <p>Contains information about one or more notification actions.</p>
|
|
1256
|
+
* @public
|
|
1257
1257
|
*/
|
|
1258
1258
|
export interface AlarmNotification {
|
|
1259
1259
|
/**
|
|
1260
|
-
* @public
|
|
1261
1260
|
* <p>Contains the notification settings of an alarm model.
|
|
1262
1261
|
* The settings apply to all alarms that were created based on this alarm model.</p>
|
|
1262
|
+
* @public
|
|
1263
1263
|
*/
|
|
1264
1264
|
notificationActions?: NotificationAction[];
|
|
1265
1265
|
}
|
|
@@ -1280,36 +1280,36 @@ export declare const ComparisonOperator: {
|
|
|
1280
1280
|
*/
|
|
1281
1281
|
export type ComparisonOperator = (typeof ComparisonOperator)[keyof typeof ComparisonOperator];
|
|
1282
1282
|
/**
|
|
1283
|
-
* @public
|
|
1284
1283
|
* <p>A rule that compares an input property value to a threshold value with a comparison operator.</p>
|
|
1284
|
+
* @public
|
|
1285
1285
|
*/
|
|
1286
1286
|
export interface SimpleRule {
|
|
1287
1287
|
/**
|
|
1288
|
-
* @public
|
|
1289
1288
|
* <p>The value on the left side of the comparison operator. You can specify an AWS IoT Events input
|
|
1290
1289
|
* attribute as an input property.</p>
|
|
1290
|
+
* @public
|
|
1291
1291
|
*/
|
|
1292
1292
|
inputProperty: string | undefined;
|
|
1293
1293
|
/**
|
|
1294
|
-
* @public
|
|
1295
1294
|
* <p>The comparison operator.</p>
|
|
1295
|
+
* @public
|
|
1296
1296
|
*/
|
|
1297
1297
|
comparisonOperator: ComparisonOperator | undefined;
|
|
1298
1298
|
/**
|
|
1299
|
-
* @public
|
|
1300
1299
|
* <p>The value on the right side of the comparison operator. You can enter a number or specify
|
|
1301
1300
|
* an AWS IoT Events input attribute.</p>
|
|
1301
|
+
* @public
|
|
1302
1302
|
*/
|
|
1303
1303
|
threshold: string | undefined;
|
|
1304
1304
|
}
|
|
1305
1305
|
/**
|
|
1306
|
-
* @public
|
|
1307
1306
|
* <p>Defines when your alarm is invoked.</p>
|
|
1307
|
+
* @public
|
|
1308
1308
|
*/
|
|
1309
1309
|
export interface AlarmRule {
|
|
1310
1310
|
/**
|
|
1311
|
-
* @public
|
|
1312
1311
|
* <p>A rule that compares an input property value to a threshold value with a comparison operator.</p>
|
|
1312
|
+
* @public
|
|
1313
1313
|
*/
|
|
1314
1314
|
simpleRule?: SimpleRule;
|
|
1315
1315
|
}
|
|
@@ -1327,25 +1327,24 @@ export declare const AnalysisResultLevel: {
|
|
|
1327
1327
|
*/
|
|
1328
1328
|
export type AnalysisResultLevel = (typeof AnalysisResultLevel)[keyof typeof AnalysisResultLevel];
|
|
1329
1329
|
/**
|
|
1330
|
-
* @public
|
|
1331
1330
|
* <p>Contains information that you can use to locate the field in your detector model that the
|
|
1332
1331
|
* analysis result references.</p>
|
|
1332
|
+
* @public
|
|
1333
1333
|
*/
|
|
1334
1334
|
export interface AnalysisResultLocation {
|
|
1335
1335
|
/**
|
|
1336
|
-
* @public
|
|
1337
1336
|
* <p>A <a href="https://github.com/json-path/JsonPath">JsonPath</a> expression that
|
|
1338
1337
|
* identifies the error field in your detector model.</p>
|
|
1338
|
+
* @public
|
|
1339
1339
|
*/
|
|
1340
1340
|
path?: string;
|
|
1341
1341
|
}
|
|
1342
1342
|
/**
|
|
1343
|
-
* @public
|
|
1344
1343
|
* <p>Contains the result of the analysis.</p>
|
|
1344
|
+
* @public
|
|
1345
1345
|
*/
|
|
1346
1346
|
export interface AnalysisResult {
|
|
1347
1347
|
/**
|
|
1348
|
-
* @public
|
|
1349
1348
|
* <p>The type of the analysis result. Analyses fall into the following types based on the
|
|
1350
1349
|
* validators used to generate the analysis result:</p>
|
|
1351
1350
|
* <ul>
|
|
@@ -1388,10 +1387,10 @@ export interface AnalysisResult {
|
|
|
1388
1387
|
* </ul>
|
|
1389
1388
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-analyze-api.html">Running detector model
|
|
1390
1389
|
* analyses</a> in the <i>AWS IoT Events Developer Guide</i>.</p>
|
|
1390
|
+
* @public
|
|
1391
1391
|
*/
|
|
1392
1392
|
type?: string;
|
|
1393
1393
|
/**
|
|
1394
|
-
* @public
|
|
1395
1394
|
* <p>The severity level of the analysis result. Based on the severity level, analysis results
|
|
1396
1395
|
* fall into three general categories:</p>
|
|
1397
1396
|
* <ul>
|
|
@@ -1413,17 +1412,18 @@ export interface AnalysisResult {
|
|
|
1413
1412
|
* detector model. You must fix all errors before you can publish your detector model.</p>
|
|
1414
1413
|
* </li>
|
|
1415
1414
|
* </ul>
|
|
1415
|
+
* @public
|
|
1416
1416
|
*/
|
|
1417
1417
|
level?: AnalysisResultLevel;
|
|
1418
1418
|
/**
|
|
1419
|
-
* @public
|
|
1420
1419
|
* <p>Contains additional information about the analysis result.</p>
|
|
1420
|
+
* @public
|
|
1421
1421
|
*/
|
|
1422
1422
|
message?: string;
|
|
1423
1423
|
/**
|
|
1424
|
-
* @public
|
|
1425
1424
|
* <p>Contains one or more locations that you can use to locate the fields in your detector
|
|
1426
1425
|
* model that the analysis result references.</p>
|
|
1426
|
+
* @public
|
|
1427
1427
|
*/
|
|
1428
1428
|
locations?: AnalysisResultLocation[];
|
|
1429
1429
|
}
|
|
@@ -1441,15 +1441,14 @@ export declare const AnalysisStatus: {
|
|
|
1441
1441
|
*/
|
|
1442
1442
|
export type AnalysisStatus = (typeof AnalysisStatus)[keyof typeof AnalysisStatus];
|
|
1443
1443
|
/**
|
|
1444
|
-
* @public
|
|
1445
1444
|
* <p>The attributes from the JSON payload that are made available by the input. Inputs are
|
|
1446
1445
|
* derived from messages sent to the AWS IoT Events system using <code>BatchPutMessage</code>. Each such
|
|
1447
1446
|
* message contains a JSON payload. Those attributes (and their paired values) specified here are
|
|
1448
1447
|
* available for use in the <code>condition</code> expressions used by detectors. </p>
|
|
1448
|
+
* @public
|
|
1449
1449
|
*/
|
|
1450
1450
|
export interface Attribute {
|
|
1451
1451
|
/**
|
|
1452
|
-
* @public
|
|
1453
1452
|
* <p>An expression that specifies an attribute-value pair in a JSON structure. Use this to
|
|
1454
1453
|
* specify an attribute from the JSON payload that is made available by the input. Inputs are
|
|
1455
1454
|
* derived from messages sent to AWS IoT Events (<code>BatchPutMessage</code>). Each such message contains
|
|
@@ -1457,22 +1456,23 @@ export interface Attribute {
|
|
|
1457
1456
|
* the <code>condition</code> expressions used by detectors. </p>
|
|
1458
1457
|
* <p>Syntax: <code><field-name>.<field-name>...</code>
|
|
1459
1458
|
* </p>
|
|
1459
|
+
* @public
|
|
1460
1460
|
*/
|
|
1461
1461
|
jsonPath: string | undefined;
|
|
1462
1462
|
}
|
|
1463
1463
|
/**
|
|
1464
|
-
* @public
|
|
1465
1464
|
* <p>Metadata that can be used to manage the resource.</p>
|
|
1465
|
+
* @public
|
|
1466
1466
|
*/
|
|
1467
1467
|
export interface Tag {
|
|
1468
1468
|
/**
|
|
1469
|
-
* @public
|
|
1470
1469
|
* <p>The tag's key.</p>
|
|
1470
|
+
* @public
|
|
1471
1471
|
*/
|
|
1472
1472
|
key: string | undefined;
|
|
1473
1473
|
/**
|
|
1474
|
-
* @public
|
|
1475
1474
|
* <p>The tag's value.</p>
|
|
1475
|
+
* @public
|
|
1476
1476
|
*/
|
|
1477
1477
|
value: string | undefined;
|
|
1478
1478
|
}
|
|
@@ -1481,59 +1481,59 @@ export interface Tag {
|
|
|
1481
1481
|
*/
|
|
1482
1482
|
export interface CreateAlarmModelRequest {
|
|
1483
1483
|
/**
|
|
1484
|
-
* @public
|
|
1485
1484
|
* <p>A unique name that helps you identify the alarm model. You can't change this name after
|
|
1486
1485
|
* you create the alarm model.</p>
|
|
1486
|
+
* @public
|
|
1487
1487
|
*/
|
|
1488
1488
|
alarmModelName: string | undefined;
|
|
1489
1489
|
/**
|
|
1490
|
-
* @public
|
|
1491
1490
|
* <p>A description that tells you what the alarm model detects.</p>
|
|
1491
|
+
* @public
|
|
1492
1492
|
*/
|
|
1493
1493
|
alarmModelDescription?: string;
|
|
1494
1494
|
/**
|
|
1495
|
-
* @public
|
|
1496
1495
|
* <p>The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>
|
|
1496
|
+
* @public
|
|
1497
1497
|
*/
|
|
1498
1498
|
roleArn: string | undefined;
|
|
1499
1499
|
/**
|
|
1500
|
-
* @public
|
|
1501
1500
|
* <p>A list of key-value pairs that contain metadata for the alarm model. The tags help you
|
|
1502
1501
|
* manage the alarm model. For more information, see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html">Tagging your AWS IoT Events
|
|
1503
1502
|
* resources</a> in the <i>AWS IoT Events Developer Guide</i>.</p>
|
|
1504
1503
|
* <p>You can create up to 50 tags for one alarm model.</p>
|
|
1504
|
+
* @public
|
|
1505
1505
|
*/
|
|
1506
1506
|
tags?: Tag[];
|
|
1507
1507
|
/**
|
|
1508
|
-
* @public
|
|
1509
1508
|
* <p>An input attribute used as a key to create an alarm.
|
|
1510
1509
|
* AWS IoT Events routes <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html">inputs</a>
|
|
1511
1510
|
* associated with this key to the alarm.</p>
|
|
1511
|
+
* @public
|
|
1512
1512
|
*/
|
|
1513
1513
|
key?: string;
|
|
1514
1514
|
/**
|
|
1515
|
-
* @public
|
|
1516
1515
|
* <p>A non-negative integer that reflects the severity level of the alarm.</p>
|
|
1516
|
+
* @public
|
|
1517
1517
|
*/
|
|
1518
1518
|
severity?: number;
|
|
1519
1519
|
/**
|
|
1520
|
-
* @public
|
|
1521
1520
|
* <p>Defines when your alarm is invoked.</p>
|
|
1521
|
+
* @public
|
|
1522
1522
|
*/
|
|
1523
1523
|
alarmRule: AlarmRule | undefined;
|
|
1524
1524
|
/**
|
|
1525
|
-
* @public
|
|
1526
1525
|
* <p>Contains information about one or more notification actions.</p>
|
|
1526
|
+
* @public
|
|
1527
1527
|
*/
|
|
1528
1528
|
alarmNotification?: AlarmNotification;
|
|
1529
1529
|
/**
|
|
1530
|
-
* @public
|
|
1531
1530
|
* <p>Contains information about one or more alarm actions.</p>
|
|
1531
|
+
* @public
|
|
1532
1532
|
*/
|
|
1533
1533
|
alarmEventActions?: AlarmEventActions;
|
|
1534
1534
|
/**
|
|
1535
|
-
* @public
|
|
1536
1535
|
* <p>Contains the configuration information of alarm state changes.</p>
|
|
1536
|
+
* @public
|
|
1537
1537
|
*/
|
|
1538
1538
|
alarmCapabilities?: AlarmCapabilities;
|
|
1539
1539
|
}
|
|
@@ -1542,27 +1542,26 @@ export interface CreateAlarmModelRequest {
|
|
|
1542
1542
|
*/
|
|
1543
1543
|
export interface CreateAlarmModelResponse {
|
|
1544
1544
|
/**
|
|
1545
|
-
* @public
|
|
1546
1545
|
* <p>The time the alarm model was created, in the Unix epoch format.</p>
|
|
1546
|
+
* @public
|
|
1547
1547
|
*/
|
|
1548
1548
|
creationTime?: Date;
|
|
1549
1549
|
/**
|
|
1550
|
-
* @public
|
|
1551
1550
|
* <p>The ARN of the alarm model. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>
|
|
1551
|
+
* @public
|
|
1552
1552
|
*/
|
|
1553
1553
|
alarmModelArn?: string;
|
|
1554
1554
|
/**
|
|
1555
|
-
* @public
|
|
1556
1555
|
* <p>The version of the alarm model.</p>
|
|
1556
|
+
* @public
|
|
1557
1557
|
*/
|
|
1558
1558
|
alarmModelVersion?: string;
|
|
1559
1559
|
/**
|
|
1560
|
-
* @public
|
|
1561
1560
|
* <p>The time the alarm model was last updated, in the Unix epoch format.</p>
|
|
1561
|
+
* @public
|
|
1562
1562
|
*/
|
|
1563
1563
|
lastUpdateTime?: Date;
|
|
1564
1564
|
/**
|
|
1565
|
-
* @public
|
|
1566
1565
|
* <p>The status of the alarm model. The status can be one of the following values:</p>
|
|
1567
1566
|
* <ul>
|
|
1568
1567
|
* <li>
|
|
@@ -1585,12 +1584,13 @@ export interface CreateAlarmModelResponse {
|
|
|
1585
1584
|
* and try again.</p>
|
|
1586
1585
|
* </li>
|
|
1587
1586
|
* </ul>
|
|
1587
|
+
* @public
|
|
1588
1588
|
*/
|
|
1589
1589
|
status?: AlarmModelVersionStatus;
|
|
1590
1590
|
}
|
|
1591
1591
|
/**
|
|
1592
|
-
* @public
|
|
1593
1592
|
* <p>An internal failure occurred.</p>
|
|
1593
|
+
* @public
|
|
1594
1594
|
*/
|
|
1595
1595
|
export declare class InternalFailureException extends __BaseException {
|
|
1596
1596
|
readonly name: "InternalFailureException";
|
|
@@ -1601,8 +1601,8 @@ export declare class InternalFailureException extends __BaseException {
|
|
|
1601
1601
|
constructor(opts: __ExceptionOptionType<InternalFailureException, __BaseException>);
|
|
1602
1602
|
}
|
|
1603
1603
|
/**
|
|
1604
|
-
* @public
|
|
1605
1604
|
* <p>The request was invalid.</p>
|
|
1605
|
+
* @public
|
|
1606
1606
|
*/
|
|
1607
1607
|
export declare class InvalidRequestException extends __BaseException {
|
|
1608
1608
|
readonly name: "InvalidRequestException";
|
|
@@ -1613,8 +1613,8 @@ export declare class InvalidRequestException extends __BaseException {
|
|
|
1613
1613
|
constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
|
|
1614
1614
|
}
|
|
1615
1615
|
/**
|
|
1616
|
-
* @public
|
|
1617
1616
|
* <p>A limit was exceeded.</p>
|
|
1617
|
+
* @public
|
|
1618
1618
|
*/
|
|
1619
1619
|
export declare class LimitExceededException extends __BaseException {
|
|
1620
1620
|
readonly name: "LimitExceededException";
|
|
@@ -1625,20 +1625,20 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
1625
1625
|
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
1626
1626
|
}
|
|
1627
1627
|
/**
|
|
1628
|
-
* @public
|
|
1629
1628
|
* <p>The resource already exists.</p>
|
|
1629
|
+
* @public
|
|
1630
1630
|
*/
|
|
1631
1631
|
export declare class ResourceAlreadyExistsException extends __BaseException {
|
|
1632
1632
|
readonly name: "ResourceAlreadyExistsException";
|
|
1633
1633
|
readonly $fault: "client";
|
|
1634
1634
|
/**
|
|
1635
|
-
* @public
|
|
1636
1635
|
* <p>The ID of the resource.</p>
|
|
1636
|
+
* @public
|
|
1637
1637
|
*/
|
|
1638
1638
|
resourceId?: string;
|
|
1639
1639
|
/**
|
|
1640
|
-
* @public
|
|
1641
1640
|
* <p>The ARN of the resource.</p>
|
|
1641
|
+
* @public
|
|
1642
1642
|
*/
|
|
1643
1643
|
resourceArn?: string;
|
|
1644
1644
|
/**
|
|
@@ -1647,8 +1647,8 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
|
|
|
1647
1647
|
constructor(opts: __ExceptionOptionType<ResourceAlreadyExistsException, __BaseException>);
|
|
1648
1648
|
}
|
|
1649
1649
|
/**
|
|
1650
|
-
* @public
|
|
1651
1650
|
* <p>The resource is in use.</p>
|
|
1651
|
+
* @public
|
|
1652
1652
|
*/
|
|
1653
1653
|
export declare class ResourceInUseException extends __BaseException {
|
|
1654
1654
|
readonly name: "ResourceInUseException";
|
|
@@ -1659,8 +1659,8 @@ export declare class ResourceInUseException extends __BaseException {
|
|
|
1659
1659
|
constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
|
|
1660
1660
|
}
|
|
1661
1661
|
/**
|
|
1662
|
-
* @public
|
|
1663
1662
|
* <p>The service is currently unavailable.</p>
|
|
1663
|
+
* @public
|
|
1664
1664
|
*/
|
|
1665
1665
|
export declare class ServiceUnavailableException extends __BaseException {
|
|
1666
1666
|
readonly name: "ServiceUnavailableException";
|
|
@@ -1671,8 +1671,8 @@ export declare class ServiceUnavailableException extends __BaseException {
|
|
|
1671
1671
|
constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
|
|
1672
1672
|
}
|
|
1673
1673
|
/**
|
|
1674
|
-
* @public
|
|
1675
1674
|
* <p>The request could not be completed due to throttling.</p>
|
|
1675
|
+
* @public
|
|
1676
1676
|
*/
|
|
1677
1677
|
export declare class ThrottlingException extends __BaseException {
|
|
1678
1678
|
readonly name: "ThrottlingException";
|
|
@@ -1683,142 +1683,142 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
1683
1683
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
1684
1684
|
}
|
|
1685
1685
|
/**
|
|
1686
|
-
* @public
|
|
1687
1686
|
* <p>Specifies the <code>actions</code> to be performed when the <code>condition</code>
|
|
1688
1687
|
* evaluates to TRUE.</p>
|
|
1688
|
+
* @public
|
|
1689
1689
|
*/
|
|
1690
1690
|
export interface Event {
|
|
1691
1691
|
/**
|
|
1692
|
-
* @public
|
|
1693
1692
|
* <p>The name of the event.</p>
|
|
1693
|
+
* @public
|
|
1694
1694
|
*/
|
|
1695
1695
|
eventName: string | undefined;
|
|
1696
1696
|
/**
|
|
1697
|
-
* @public
|
|
1698
1697
|
* <p>Optional. The Boolean expression that, when TRUE, causes the <code>actions</code> to be
|
|
1699
1698
|
* performed. If not present, the actions are performed (=TRUE). If the expression result is not
|
|
1700
1699
|
* a Boolean value, the actions are not performed (=FALSE).</p>
|
|
1700
|
+
* @public
|
|
1701
1701
|
*/
|
|
1702
1702
|
condition?: string;
|
|
1703
1703
|
/**
|
|
1704
|
-
* @public
|
|
1705
1704
|
* <p>The actions to be performed.</p>
|
|
1705
|
+
* @public
|
|
1706
1706
|
*/
|
|
1707
1707
|
actions?: Action[];
|
|
1708
1708
|
}
|
|
1709
1709
|
/**
|
|
1710
|
-
* @public
|
|
1711
1710
|
* <p>When entering this state, perform these <code>actions</code> if the <code>condition</code>
|
|
1712
1711
|
* is TRUE.</p>
|
|
1712
|
+
* @public
|
|
1713
1713
|
*/
|
|
1714
1714
|
export interface OnEnterLifecycle {
|
|
1715
1715
|
/**
|
|
1716
|
-
* @public
|
|
1717
1716
|
* <p>Specifies the actions that are performed when the state is entered and the
|
|
1718
1717
|
* <code>condition</code> is <code>TRUE</code>.</p>
|
|
1718
|
+
* @public
|
|
1719
1719
|
*/
|
|
1720
1720
|
events?: Event[];
|
|
1721
1721
|
}
|
|
1722
1722
|
/**
|
|
1723
|
-
* @public
|
|
1724
1723
|
* <p>When exiting this state, perform these <code>actions</code> if the specified
|
|
1725
1724
|
* <code>condition</code> is <code>TRUE</code>.</p>
|
|
1725
|
+
* @public
|
|
1726
1726
|
*/
|
|
1727
1727
|
export interface OnExitLifecycle {
|
|
1728
1728
|
/**
|
|
1729
|
-
* @public
|
|
1730
1729
|
* <p>Specifies the <code>actions</code> that are performed when the state is exited and the
|
|
1731
1730
|
* <code>condition</code> is <code>TRUE</code>.</p>
|
|
1731
|
+
* @public
|
|
1732
1732
|
*/
|
|
1733
1733
|
events?: Event[];
|
|
1734
1734
|
}
|
|
1735
1735
|
/**
|
|
1736
|
-
* @public
|
|
1737
1736
|
* <p>Specifies the actions performed and the next state entered when a <code>condition</code>
|
|
1738
1737
|
* evaluates to TRUE.</p>
|
|
1738
|
+
* @public
|
|
1739
1739
|
*/
|
|
1740
1740
|
export interface TransitionEvent {
|
|
1741
1741
|
/**
|
|
1742
|
-
* @public
|
|
1743
1742
|
* <p>The name of the transition event.</p>
|
|
1743
|
+
* @public
|
|
1744
1744
|
*/
|
|
1745
1745
|
eventName: string | undefined;
|
|
1746
1746
|
/**
|
|
1747
|
-
* @public
|
|
1748
1747
|
* <p>Required. A Boolean expression that when TRUE causes the actions to be performed and the
|
|
1749
1748
|
* <code>nextState</code> to be entered.</p>
|
|
1749
|
+
* @public
|
|
1750
1750
|
*/
|
|
1751
1751
|
condition: string | undefined;
|
|
1752
1752
|
/**
|
|
1753
|
-
* @public
|
|
1754
1753
|
* <p>The actions to be performed.</p>
|
|
1754
|
+
* @public
|
|
1755
1755
|
*/
|
|
1756
1756
|
actions?: Action[];
|
|
1757
1757
|
/**
|
|
1758
|
-
* @public
|
|
1759
1758
|
* <p>The next state to enter.</p>
|
|
1759
|
+
* @public
|
|
1760
1760
|
*/
|
|
1761
1761
|
nextState: string | undefined;
|
|
1762
1762
|
}
|
|
1763
1763
|
/**
|
|
1764
|
-
* @public
|
|
1765
1764
|
* <p>Specifies the actions performed when the <code>condition</code> evaluates to TRUE.</p>
|
|
1765
|
+
* @public
|
|
1766
1766
|
*/
|
|
1767
1767
|
export interface OnInputLifecycle {
|
|
1768
1768
|
/**
|
|
1769
|
-
* @public
|
|
1770
1769
|
* <p>Specifies the actions performed when the <code>condition</code> evaluates to TRUE.</p>
|
|
1770
|
+
* @public
|
|
1771
1771
|
*/
|
|
1772
1772
|
events?: Event[];
|
|
1773
1773
|
/**
|
|
1774
|
-
* @public
|
|
1775
1774
|
* <p>Specifies the actions performed, and the next state entered, when a <code>condition</code>
|
|
1776
1775
|
* evaluates to TRUE.</p>
|
|
1776
|
+
* @public
|
|
1777
1777
|
*/
|
|
1778
1778
|
transitionEvents?: TransitionEvent[];
|
|
1779
1779
|
}
|
|
1780
1780
|
/**
|
|
1781
|
-
* @public
|
|
1782
1781
|
* <p>Information that defines a state of a detector.</p>
|
|
1782
|
+
* @public
|
|
1783
1783
|
*/
|
|
1784
1784
|
export interface State {
|
|
1785
1785
|
/**
|
|
1786
|
-
* @public
|
|
1787
1786
|
* <p>The name of the state.</p>
|
|
1787
|
+
* @public
|
|
1788
1788
|
*/
|
|
1789
1789
|
stateName: string | undefined;
|
|
1790
1790
|
/**
|
|
1791
|
-
* @public
|
|
1792
1791
|
* <p>When an input is received and the <code>condition</code> is TRUE, perform the specified
|
|
1793
1792
|
* <code>actions</code>.</p>
|
|
1793
|
+
* @public
|
|
1794
1794
|
*/
|
|
1795
1795
|
onInput?: OnInputLifecycle;
|
|
1796
1796
|
/**
|
|
1797
|
-
* @public
|
|
1798
1797
|
* <p>When entering this state, perform these <code>actions</code> if the <code>condition</code>
|
|
1799
1798
|
* is TRUE.</p>
|
|
1799
|
+
* @public
|
|
1800
1800
|
*/
|
|
1801
1801
|
onEnter?: OnEnterLifecycle;
|
|
1802
1802
|
/**
|
|
1803
|
-
* @public
|
|
1804
1803
|
* <p>When exiting this state, perform these <code>actions</code> if the specified
|
|
1805
1804
|
* <code>condition</code> is <code>TRUE</code>.</p>
|
|
1805
|
+
* @public
|
|
1806
1806
|
*/
|
|
1807
1807
|
onExit?: OnExitLifecycle;
|
|
1808
1808
|
}
|
|
1809
1809
|
/**
|
|
1810
|
-
* @public
|
|
1811
1810
|
* <p>Information that defines how a detector operates.</p>
|
|
1811
|
+
* @public
|
|
1812
1812
|
*/
|
|
1813
1813
|
export interface DetectorModelDefinition {
|
|
1814
1814
|
/**
|
|
1815
|
-
* @public
|
|
1816
1815
|
* <p>Information about the states of the detector.</p>
|
|
1816
|
+
* @public
|
|
1817
1817
|
*/
|
|
1818
1818
|
states: State[] | undefined;
|
|
1819
1819
|
/**
|
|
1820
|
-
* @public
|
|
1821
1820
|
* <p>The state that is entered at the creation of each detector (instance).</p>
|
|
1821
|
+
* @public
|
|
1822
1822
|
*/
|
|
1823
1823
|
initialStateName: string | undefined;
|
|
1824
1824
|
}
|
|
@@ -1839,43 +1839,43 @@ export type EvaluationMethod = (typeof EvaluationMethod)[keyof typeof Evaluation
|
|
|
1839
1839
|
*/
|
|
1840
1840
|
export interface CreateDetectorModelRequest {
|
|
1841
1841
|
/**
|
|
1842
|
-
* @public
|
|
1843
1842
|
* <p>The name of the detector model.</p>
|
|
1843
|
+
* @public
|
|
1844
1844
|
*/
|
|
1845
1845
|
detectorModelName: string | undefined;
|
|
1846
1846
|
/**
|
|
1847
|
-
* @public
|
|
1848
1847
|
* <p>Information that defines how the detectors operate.</p>
|
|
1848
|
+
* @public
|
|
1849
1849
|
*/
|
|
1850
1850
|
detectorModelDefinition: DetectorModelDefinition | undefined;
|
|
1851
1851
|
/**
|
|
1852
|
-
* @public
|
|
1853
1852
|
* <p>A brief description of the detector model.</p>
|
|
1853
|
+
* @public
|
|
1854
1854
|
*/
|
|
1855
1855
|
detectorModelDescription?: string;
|
|
1856
1856
|
/**
|
|
1857
|
-
* @public
|
|
1858
1857
|
* <p>The input attribute key used to identify a device or system to create a detector (an
|
|
1859
1858
|
* instance of the detector model) and then to route each input received to the appropriate
|
|
1860
1859
|
* detector (instance). This parameter uses a JSON-path expression in the message payload of each
|
|
1861
1860
|
* input to specify the attribute-value pair that is used to identify the device associated with
|
|
1862
1861
|
* the input.</p>
|
|
1862
|
+
* @public
|
|
1863
1863
|
*/
|
|
1864
1864
|
key?: string;
|
|
1865
1865
|
/**
|
|
1866
|
-
* @public
|
|
1867
1866
|
* <p>The ARN of the role that grants permission to AWS IoT Events to perform its operations.</p>
|
|
1867
|
+
* @public
|
|
1868
1868
|
*/
|
|
1869
1869
|
roleArn: string | undefined;
|
|
1870
1870
|
/**
|
|
1871
|
-
* @public
|
|
1872
1871
|
* <p>Metadata that can be used to manage the detector model.</p>
|
|
1872
|
+
* @public
|
|
1873
1873
|
*/
|
|
1874
1874
|
tags?: Tag[];
|
|
1875
1875
|
/**
|
|
1876
|
-
* @public
|
|
1877
1876
|
* <p>Information about the order in which events are evaluated and how actions are executed.
|
|
1878
1877
|
* </p>
|
|
1878
|
+
* @public
|
|
1879
1879
|
*/
|
|
1880
1880
|
evaluationMethod?: EvaluationMethod;
|
|
1881
1881
|
}
|
|
@@ -1897,52 +1897,51 @@ export declare const DetectorModelVersionStatus: {
|
|
|
1897
1897
|
*/
|
|
1898
1898
|
export type DetectorModelVersionStatus = (typeof DetectorModelVersionStatus)[keyof typeof DetectorModelVersionStatus];
|
|
1899
1899
|
/**
|
|
1900
|
-
* @public
|
|
1901
1900
|
* <p>Information about how the detector model is configured.</p>
|
|
1901
|
+
* @public
|
|
1902
1902
|
*/
|
|
1903
1903
|
export interface DetectorModelConfiguration {
|
|
1904
1904
|
/**
|
|
1905
|
-
* @public
|
|
1906
1905
|
* <p>The name of the detector model.</p>
|
|
1906
|
+
* @public
|
|
1907
1907
|
*/
|
|
1908
1908
|
detectorModelName?: string;
|
|
1909
1909
|
/**
|
|
1910
|
-
* @public
|
|
1911
1910
|
* <p>The version of the detector model.</p>
|
|
1911
|
+
* @public
|
|
1912
1912
|
*/
|
|
1913
1913
|
detectorModelVersion?: string;
|
|
1914
1914
|
/**
|
|
1915
|
-
* @public
|
|
1916
1915
|
* <p>A brief description of the detector model.</p>
|
|
1916
|
+
* @public
|
|
1917
1917
|
*/
|
|
1918
1918
|
detectorModelDescription?: string;
|
|
1919
1919
|
/**
|
|
1920
|
-
* @public
|
|
1921
1920
|
* <p>The ARN of the detector model.</p>
|
|
1921
|
+
* @public
|
|
1922
1922
|
*/
|
|
1923
1923
|
detectorModelArn?: string;
|
|
1924
1924
|
/**
|
|
1925
|
-
* @public
|
|
1926
1925
|
* <p>The ARN of the role that grants permission to AWS IoT Events to perform its operations.</p>
|
|
1926
|
+
* @public
|
|
1927
1927
|
*/
|
|
1928
1928
|
roleArn?: string;
|
|
1929
1929
|
/**
|
|
1930
|
-
* @public
|
|
1931
1930
|
* <p>The time the detector model was created.</p>
|
|
1931
|
+
* @public
|
|
1932
1932
|
*/
|
|
1933
1933
|
creationTime?: Date;
|
|
1934
1934
|
/**
|
|
1935
|
-
* @public
|
|
1936
1935
|
* <p>The time the detector model was last updated.</p>
|
|
1936
|
+
* @public
|
|
1937
1937
|
*/
|
|
1938
1938
|
lastUpdateTime?: Date;
|
|
1939
1939
|
/**
|
|
1940
|
-
* @public
|
|
1941
1940
|
* <p>The status of the detector model.</p>
|
|
1941
|
+
* @public
|
|
1942
1942
|
*/
|
|
1943
1943
|
status?: DetectorModelVersionStatus;
|
|
1944
1944
|
/**
|
|
1945
|
-
* @public
|
|
1946
1945
|
* <p>The value used to identify a detector instance. When a device or system sends input, a new
|
|
1947
1946
|
* detector instance with a unique key value is created. AWS IoT Events can continue to route input to its
|
|
1948
1947
|
* corresponding detector instance based on this identifying information. </p>
|
|
@@ -1950,12 +1949,13 @@ export interface DetectorModelConfiguration {
|
|
|
1950
1949
|
* message payload that is used for identification. To route the message to the correct detector
|
|
1951
1950
|
* instance, the device must send a message payload that contains the same
|
|
1952
1951
|
* attribute-value.</p>
|
|
1952
|
+
* @public
|
|
1953
1953
|
*/
|
|
1954
1954
|
key?: string;
|
|
1955
1955
|
/**
|
|
1956
|
-
* @public
|
|
1957
1956
|
* <p>Information about the order in which events are evaluated and how actions are executed.
|
|
1958
1957
|
* </p>
|
|
1958
|
+
* @public
|
|
1959
1959
|
*/
|
|
1960
1960
|
evaluationMethod?: EvaluationMethod;
|
|
1961
1961
|
}
|
|
@@ -1964,23 +1964,23 @@ export interface DetectorModelConfiguration {
|
|
|
1964
1964
|
*/
|
|
1965
1965
|
export interface CreateDetectorModelResponse {
|
|
1966
1966
|
/**
|
|
1967
|
-
* @public
|
|
1968
1967
|
* <p>Information about how the detector model is configured.</p>
|
|
1968
|
+
* @public
|
|
1969
1969
|
*/
|
|
1970
1970
|
detectorModelConfiguration?: DetectorModelConfiguration;
|
|
1971
1971
|
}
|
|
1972
1972
|
/**
|
|
1973
|
-
* @public
|
|
1974
1973
|
* <p>The definition of the input.</p>
|
|
1974
|
+
* @public
|
|
1975
1975
|
*/
|
|
1976
1976
|
export interface InputDefinition {
|
|
1977
1977
|
/**
|
|
1978
|
-
* @public
|
|
1979
1978
|
* <p>The attributes from the JSON payload that are made available by the input. Inputs are
|
|
1980
1979
|
* derived from messages sent to the AWS IoT Events system using <code>BatchPutMessage</code>. Each such
|
|
1981
1980
|
* message contains a JSON payload, and those attributes (and their paired values) specified here
|
|
1982
1981
|
* are available for use in the <code>condition</code> expressions used by detectors that monitor
|
|
1983
1982
|
* this input. </p>
|
|
1983
|
+
* @public
|
|
1984
1984
|
*/
|
|
1985
1985
|
attributes: Attribute[] | undefined;
|
|
1986
1986
|
}
|
|
@@ -1989,23 +1989,23 @@ export interface InputDefinition {
|
|
|
1989
1989
|
*/
|
|
1990
1990
|
export interface CreateInputRequest {
|
|
1991
1991
|
/**
|
|
1992
|
-
* @public
|
|
1993
1992
|
* <p>The name you want to give to the input.</p>
|
|
1993
|
+
* @public
|
|
1994
1994
|
*/
|
|
1995
1995
|
inputName: string | undefined;
|
|
1996
1996
|
/**
|
|
1997
|
-
* @public
|
|
1998
1997
|
* <p>A brief description of the input.</p>
|
|
1998
|
+
* @public
|
|
1999
1999
|
*/
|
|
2000
2000
|
inputDescription?: string;
|
|
2001
2001
|
/**
|
|
2002
|
-
* @public
|
|
2003
2002
|
* <p>The definition of the input.</p>
|
|
2003
|
+
* @public
|
|
2004
2004
|
*/
|
|
2005
2005
|
inputDefinition: InputDefinition | undefined;
|
|
2006
2006
|
/**
|
|
2007
|
-
* @public
|
|
2008
2007
|
* <p>Metadata that can be used to manage the input.</p>
|
|
2008
|
+
* @public
|
|
2009
2009
|
*/
|
|
2010
2010
|
tags?: Tag[];
|
|
2011
2011
|
}
|
|
@@ -2024,38 +2024,38 @@ export declare const InputStatus: {
|
|
|
2024
2024
|
*/
|
|
2025
2025
|
export type InputStatus = (typeof InputStatus)[keyof typeof InputStatus];
|
|
2026
2026
|
/**
|
|
2027
|
-
* @public
|
|
2028
2027
|
* <p>Information about the configuration of an input.</p>
|
|
2028
|
+
* @public
|
|
2029
2029
|
*/
|
|
2030
2030
|
export interface InputConfiguration {
|
|
2031
2031
|
/**
|
|
2032
|
-
* @public
|
|
2033
2032
|
* <p>The name of the input.</p>
|
|
2033
|
+
* @public
|
|
2034
2034
|
*/
|
|
2035
2035
|
inputName: string | undefined;
|
|
2036
2036
|
/**
|
|
2037
|
-
* @public
|
|
2038
2037
|
* <p>A brief description of the input.</p>
|
|
2038
|
+
* @public
|
|
2039
2039
|
*/
|
|
2040
2040
|
inputDescription?: string;
|
|
2041
2041
|
/**
|
|
2042
|
-
* @public
|
|
2043
2042
|
* <p>The ARN of the input.</p>
|
|
2043
|
+
* @public
|
|
2044
2044
|
*/
|
|
2045
2045
|
inputArn: string | undefined;
|
|
2046
2046
|
/**
|
|
2047
|
-
* @public
|
|
2048
2047
|
* <p>The time the input was created.</p>
|
|
2048
|
+
* @public
|
|
2049
2049
|
*/
|
|
2050
2050
|
creationTime: Date | undefined;
|
|
2051
2051
|
/**
|
|
2052
|
-
* @public
|
|
2053
2052
|
* <p>The last time the input was updated.</p>
|
|
2053
|
+
* @public
|
|
2054
2054
|
*/
|
|
2055
2055
|
lastUpdateTime: Date | undefined;
|
|
2056
2056
|
/**
|
|
2057
|
-
* @public
|
|
2058
2057
|
* <p>The status of the input.</p>
|
|
2058
|
+
* @public
|
|
2059
2059
|
*/
|
|
2060
2060
|
status: InputStatus | undefined;
|
|
2061
2061
|
}
|
|
@@ -2064,8 +2064,8 @@ export interface InputConfiguration {
|
|
|
2064
2064
|
*/
|
|
2065
2065
|
export interface CreateInputResponse {
|
|
2066
2066
|
/**
|
|
2067
|
-
* @public
|
|
2068
2067
|
* <p>Information about the configuration of the input.</p>
|
|
2068
|
+
* @public
|
|
2069
2069
|
*/
|
|
2070
2070
|
inputConfiguration?: InputConfiguration;
|
|
2071
2071
|
}
|
|
@@ -2074,8 +2074,8 @@ export interface CreateInputResponse {
|
|
|
2074
2074
|
*/
|
|
2075
2075
|
export interface DeleteAlarmModelRequest {
|
|
2076
2076
|
/**
|
|
2077
|
-
* @public
|
|
2078
2077
|
* <p>The name of the alarm model.</p>
|
|
2078
|
+
* @public
|
|
2079
2079
|
*/
|
|
2080
2080
|
alarmModelName: string | undefined;
|
|
2081
2081
|
}
|
|
@@ -2085,8 +2085,8 @@ export interface DeleteAlarmModelRequest {
|
|
|
2085
2085
|
export interface DeleteAlarmModelResponse {
|
|
2086
2086
|
}
|
|
2087
2087
|
/**
|
|
2088
|
-
* @public
|
|
2089
2088
|
* <p>The resource was not found.</p>
|
|
2089
|
+
* @public
|
|
2090
2090
|
*/
|
|
2091
2091
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
2092
2092
|
readonly name: "ResourceNotFoundException";
|
|
@@ -2101,8 +2101,8 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
2101
2101
|
*/
|
|
2102
2102
|
export interface DeleteDetectorModelRequest {
|
|
2103
2103
|
/**
|
|
2104
|
-
* @public
|
|
2105
2104
|
* <p>The name of the detector model to be deleted.</p>
|
|
2105
|
+
* @public
|
|
2106
2106
|
*/
|
|
2107
2107
|
detectorModelName: string | undefined;
|
|
2108
2108
|
}
|
|
@@ -2116,8 +2116,8 @@ export interface DeleteDetectorModelResponse {
|
|
|
2116
2116
|
*/
|
|
2117
2117
|
export interface DeleteInputRequest {
|
|
2118
2118
|
/**
|
|
2119
|
-
* @public
|
|
2120
2119
|
* <p>The name of the input to delete.</p>
|
|
2120
|
+
* @public
|
|
2121
2121
|
*/
|
|
2122
2122
|
inputName: string | undefined;
|
|
2123
2123
|
}
|
|
@@ -2131,13 +2131,13 @@ export interface DeleteInputResponse {
|
|
|
2131
2131
|
*/
|
|
2132
2132
|
export interface DescribeAlarmModelRequest {
|
|
2133
2133
|
/**
|
|
2134
|
-
* @public
|
|
2135
2134
|
* <p>The name of the alarm model.</p>
|
|
2135
|
+
* @public
|
|
2136
2136
|
*/
|
|
2137
2137
|
alarmModelName: string | undefined;
|
|
2138
2138
|
/**
|
|
2139
|
-
* @public
|
|
2140
2139
|
* <p>The version of the alarm model.</p>
|
|
2140
|
+
* @public
|
|
2141
2141
|
*/
|
|
2142
2142
|
alarmModelVersion?: string;
|
|
2143
2143
|
}
|
|
@@ -2146,27 +2146,26 @@ export interface DescribeAlarmModelRequest {
|
|
|
2146
2146
|
*/
|
|
2147
2147
|
export interface DescribeAlarmModelResponse {
|
|
2148
2148
|
/**
|
|
2149
|
-
* @public
|
|
2150
2149
|
* <p>The time the alarm model was created, in the Unix epoch format.</p>
|
|
2150
|
+
* @public
|
|
2151
2151
|
*/
|
|
2152
2152
|
creationTime?: Date;
|
|
2153
2153
|
/**
|
|
2154
|
-
* @public
|
|
2155
2154
|
* <p>The ARN of the alarm model. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>
|
|
2155
|
+
* @public
|
|
2156
2156
|
*/
|
|
2157
2157
|
alarmModelArn?: string;
|
|
2158
2158
|
/**
|
|
2159
|
-
* @public
|
|
2160
2159
|
* <p>The version of the alarm model.</p>
|
|
2160
|
+
* @public
|
|
2161
2161
|
*/
|
|
2162
2162
|
alarmModelVersion?: string;
|
|
2163
2163
|
/**
|
|
2164
|
-
* @public
|
|
2165
2164
|
* <p>The time the alarm model was last updated, in the Unix epoch format.</p>
|
|
2165
|
+
* @public
|
|
2166
2166
|
*/
|
|
2167
2167
|
lastUpdateTime?: Date;
|
|
2168
2168
|
/**
|
|
2169
|
-
* @public
|
|
2170
2169
|
* <p>The status of the alarm model. The status can be one of the following values:</p>
|
|
2171
2170
|
* <ul>
|
|
2172
2171
|
* <li>
|
|
@@ -2189,60 +2188,61 @@ export interface DescribeAlarmModelResponse {
|
|
|
2189
2188
|
* and try again.</p>
|
|
2190
2189
|
* </li>
|
|
2191
2190
|
* </ul>
|
|
2191
|
+
* @public
|
|
2192
2192
|
*/
|
|
2193
2193
|
status?: AlarmModelVersionStatus;
|
|
2194
2194
|
/**
|
|
2195
|
-
* @public
|
|
2196
2195
|
* <p>
|
|
2197
2196
|
* Contains information about the status of the alarm model.
|
|
2198
2197
|
* </p>
|
|
2198
|
+
* @public
|
|
2199
2199
|
*/
|
|
2200
2200
|
statusMessage?: string;
|
|
2201
2201
|
/**
|
|
2202
|
-
* @public
|
|
2203
2202
|
* <p>The name of the alarm model.</p>
|
|
2203
|
+
* @public
|
|
2204
2204
|
*/
|
|
2205
2205
|
alarmModelName?: string;
|
|
2206
2206
|
/**
|
|
2207
|
-
* @public
|
|
2208
2207
|
* <p>The description of the alarm model.</p>
|
|
2208
|
+
* @public
|
|
2209
2209
|
*/
|
|
2210
2210
|
alarmModelDescription?: string;
|
|
2211
2211
|
/**
|
|
2212
|
-
* @public
|
|
2213
2212
|
* <p>The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>
|
|
2213
|
+
* @public
|
|
2214
2214
|
*/
|
|
2215
2215
|
roleArn?: string;
|
|
2216
2216
|
/**
|
|
2217
|
-
* @public
|
|
2218
2217
|
* <p>An input attribute used as a key to create an alarm.
|
|
2219
2218
|
* AWS IoT Events routes <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html">inputs</a>
|
|
2220
2219
|
* associated with this key to the alarm.</p>
|
|
2220
|
+
* @public
|
|
2221
2221
|
*/
|
|
2222
2222
|
key?: string;
|
|
2223
2223
|
/**
|
|
2224
|
-
* @public
|
|
2225
2224
|
* <p>A non-negative integer that reflects the severity level of the alarm.</p>
|
|
2225
|
+
* @public
|
|
2226
2226
|
*/
|
|
2227
2227
|
severity?: number;
|
|
2228
2228
|
/**
|
|
2229
|
-
* @public
|
|
2230
2229
|
* <p>Defines when your alarm is invoked.</p>
|
|
2230
|
+
* @public
|
|
2231
2231
|
*/
|
|
2232
2232
|
alarmRule?: AlarmRule;
|
|
2233
2233
|
/**
|
|
2234
|
-
* @public
|
|
2235
2234
|
* <p>Contains information about one or more notification actions.</p>
|
|
2235
|
+
* @public
|
|
2236
2236
|
*/
|
|
2237
2237
|
alarmNotification?: AlarmNotification;
|
|
2238
2238
|
/**
|
|
2239
|
-
* @public
|
|
2240
2239
|
* <p>Contains information about one or more alarm actions.</p>
|
|
2240
|
+
* @public
|
|
2241
2241
|
*/
|
|
2242
2242
|
alarmEventActions?: AlarmEventActions;
|
|
2243
2243
|
/**
|
|
2244
|
-
* @public
|
|
2245
2244
|
* <p>Contains the configuration information of alarm state changes.</p>
|
|
2245
|
+
* @public
|
|
2246
2246
|
*/
|
|
2247
2247
|
alarmCapabilities?: AlarmCapabilities;
|
|
2248
2248
|
}
|
|
@@ -2251,29 +2251,29 @@ export interface DescribeAlarmModelResponse {
|
|
|
2251
2251
|
*/
|
|
2252
2252
|
export interface DescribeDetectorModelRequest {
|
|
2253
2253
|
/**
|
|
2254
|
-
* @public
|
|
2255
2254
|
* <p>The name of the detector model.</p>
|
|
2255
|
+
* @public
|
|
2256
2256
|
*/
|
|
2257
2257
|
detectorModelName: string | undefined;
|
|
2258
2258
|
/**
|
|
2259
|
-
* @public
|
|
2260
2259
|
* <p>The version of the detector model.</p>
|
|
2260
|
+
* @public
|
|
2261
2261
|
*/
|
|
2262
2262
|
detectorModelVersion?: string;
|
|
2263
2263
|
}
|
|
2264
2264
|
/**
|
|
2265
|
-
* @public
|
|
2266
2265
|
* <p>Information about the detector model.</p>
|
|
2266
|
+
* @public
|
|
2267
2267
|
*/
|
|
2268
2268
|
export interface DetectorModel {
|
|
2269
2269
|
/**
|
|
2270
|
-
* @public
|
|
2271
2270
|
* <p>Information that defines how a detector operates.</p>
|
|
2271
|
+
* @public
|
|
2272
2272
|
*/
|
|
2273
2273
|
detectorModelDefinition?: DetectorModelDefinition;
|
|
2274
2274
|
/**
|
|
2275
|
-
* @public
|
|
2276
2275
|
* <p>Information about how the detector is configured.</p>
|
|
2276
|
+
* @public
|
|
2277
2277
|
*/
|
|
2278
2278
|
detectorModelConfiguration?: DetectorModelConfiguration;
|
|
2279
2279
|
}
|
|
@@ -2282,8 +2282,8 @@ export interface DetectorModel {
|
|
|
2282
2282
|
*/
|
|
2283
2283
|
export interface DescribeDetectorModelResponse {
|
|
2284
2284
|
/**
|
|
2285
|
-
* @public
|
|
2286
2285
|
* <p>Information about the detector model.</p>
|
|
2286
|
+
* @public
|
|
2287
2287
|
*/
|
|
2288
2288
|
detectorModel?: DetectorModel;
|
|
2289
2289
|
}
|
|
@@ -2292,8 +2292,8 @@ export interface DescribeDetectorModelResponse {
|
|
|
2292
2292
|
*/
|
|
2293
2293
|
export interface DescribeDetectorModelAnalysisRequest {
|
|
2294
2294
|
/**
|
|
2295
|
-
* @public
|
|
2296
2295
|
* <p>The ID of the analysis result that you want to retrieve.</p>
|
|
2296
|
+
* @public
|
|
2297
2297
|
*/
|
|
2298
2298
|
analysisId: string | undefined;
|
|
2299
2299
|
}
|
|
@@ -2302,7 +2302,6 @@ export interface DescribeDetectorModelAnalysisRequest {
|
|
|
2302
2302
|
*/
|
|
2303
2303
|
export interface DescribeDetectorModelAnalysisResponse {
|
|
2304
2304
|
/**
|
|
2305
|
-
* @public
|
|
2306
2305
|
* <p>The status of the analysis activity. The status can be one of the following values:</p>
|
|
2307
2306
|
* <ul>
|
|
2308
2307
|
* <li>
|
|
@@ -2320,6 +2319,7 @@ export interface DescribeDetectorModelAnalysisResponse {
|
|
|
2320
2319
|
* later.</p>
|
|
2321
2320
|
* </li>
|
|
2322
2321
|
* </ul>
|
|
2322
|
+
* @public
|
|
2323
2323
|
*/
|
|
2324
2324
|
status?: AnalysisStatus;
|
|
2325
2325
|
}
|
|
@@ -2328,24 +2328,24 @@ export interface DescribeDetectorModelAnalysisResponse {
|
|
|
2328
2328
|
*/
|
|
2329
2329
|
export interface DescribeInputRequest {
|
|
2330
2330
|
/**
|
|
2331
|
-
* @public
|
|
2332
2331
|
* <p>The name of the input.</p>
|
|
2332
|
+
* @public
|
|
2333
2333
|
*/
|
|
2334
2334
|
inputName: string | undefined;
|
|
2335
2335
|
}
|
|
2336
2336
|
/**
|
|
2337
|
-
* @public
|
|
2338
2337
|
* <p>Information about the input.</p>
|
|
2338
|
+
* @public
|
|
2339
2339
|
*/
|
|
2340
2340
|
export interface Input {
|
|
2341
2341
|
/**
|
|
2342
|
-
* @public
|
|
2343
2342
|
* <p>Information about the configuration of an input.</p>
|
|
2343
|
+
* @public
|
|
2344
2344
|
*/
|
|
2345
2345
|
inputConfiguration?: InputConfiguration;
|
|
2346
2346
|
/**
|
|
2347
|
-
* @public
|
|
2348
2347
|
* <p>The definition of the input.</p>
|
|
2348
|
+
* @public
|
|
2349
2349
|
*/
|
|
2350
2350
|
inputDefinition?: InputDefinition;
|
|
2351
2351
|
}
|
|
@@ -2354,8 +2354,8 @@ export interface Input {
|
|
|
2354
2354
|
*/
|
|
2355
2355
|
export interface DescribeInputResponse {
|
|
2356
2356
|
/**
|
|
2357
|
-
* @public
|
|
2358
2357
|
* <p>Information about the input.</p>
|
|
2358
|
+
* @public
|
|
2359
2359
|
*/
|
|
2360
2360
|
input?: Input;
|
|
2361
2361
|
}
|
|
@@ -2365,20 +2365,20 @@ export interface DescribeInputResponse {
|
|
|
2365
2365
|
export interface DescribeLoggingOptionsRequest {
|
|
2366
2366
|
}
|
|
2367
2367
|
/**
|
|
2368
|
-
* @public
|
|
2369
2368
|
* <p>The detector model and the specific detectors (instances) for which the logging level is
|
|
2370
2369
|
* given.</p>
|
|
2370
|
+
* @public
|
|
2371
2371
|
*/
|
|
2372
2372
|
export interface DetectorDebugOption {
|
|
2373
2373
|
/**
|
|
2374
|
-
* @public
|
|
2375
2374
|
* <p>The name of the detector model.</p>
|
|
2375
|
+
* @public
|
|
2376
2376
|
*/
|
|
2377
2377
|
detectorModelName: string | undefined;
|
|
2378
2378
|
/**
|
|
2379
|
-
* @public
|
|
2380
2379
|
* <p>The value of the input attribute key used to create the detector (the instance of the
|
|
2381
2380
|
* detector model).</p>
|
|
2381
|
+
* @public
|
|
2382
2382
|
*/
|
|
2383
2383
|
keyValue?: string;
|
|
2384
2384
|
}
|
|
@@ -2396,29 +2396,29 @@ export declare const LoggingLevel: {
|
|
|
2396
2396
|
*/
|
|
2397
2397
|
export type LoggingLevel = (typeof LoggingLevel)[keyof typeof LoggingLevel];
|
|
2398
2398
|
/**
|
|
2399
|
-
* @public
|
|
2400
2399
|
* <p>The values of the AWS IoT Events logging options.</p>
|
|
2400
|
+
* @public
|
|
2401
2401
|
*/
|
|
2402
2402
|
export interface LoggingOptions {
|
|
2403
2403
|
/**
|
|
2404
|
-
* @public
|
|
2405
2404
|
* <p>The ARN of the role that grants permission to AWS IoT Events to perform logging.</p>
|
|
2405
|
+
* @public
|
|
2406
2406
|
*/
|
|
2407
2407
|
roleArn: string | undefined;
|
|
2408
2408
|
/**
|
|
2409
|
-
* @public
|
|
2410
2409
|
* <p>The logging level.</p>
|
|
2410
|
+
* @public
|
|
2411
2411
|
*/
|
|
2412
2412
|
level: LoggingLevel | undefined;
|
|
2413
2413
|
/**
|
|
2414
|
-
* @public
|
|
2415
2414
|
* <p>If TRUE, logging is enabled for AWS IoT Events.</p>
|
|
2415
|
+
* @public
|
|
2416
2416
|
*/
|
|
2417
2417
|
enabled: boolean | undefined;
|
|
2418
2418
|
/**
|
|
2419
|
-
* @public
|
|
2420
2419
|
* <p>Information that identifies those detector models and their detectors (instances) for
|
|
2421
2420
|
* which the logging level is given.</p>
|
|
2421
|
+
* @public
|
|
2422
2422
|
*/
|
|
2423
2423
|
detectorDebugOptions?: DetectorDebugOption[];
|
|
2424
2424
|
}
|
|
@@ -2427,14 +2427,14 @@ export interface LoggingOptions {
|
|
|
2427
2427
|
*/
|
|
2428
2428
|
export interface DescribeLoggingOptionsResponse {
|
|
2429
2429
|
/**
|
|
2430
|
-
* @public
|
|
2431
2430
|
* <p>The current settings of the AWS IoT Events logging options.</p>
|
|
2431
|
+
* @public
|
|
2432
2432
|
*/
|
|
2433
2433
|
loggingOptions?: LoggingOptions;
|
|
2434
2434
|
}
|
|
2435
2435
|
/**
|
|
2436
|
-
* @public
|
|
2437
2436
|
* <p>The requested operation is not supported.</p>
|
|
2437
|
+
* @public
|
|
2438
2438
|
*/
|
|
2439
2439
|
export declare class UnsupportedOperationException extends __BaseException {
|
|
2440
2440
|
readonly name: "UnsupportedOperationException";
|
|
@@ -2445,70 +2445,70 @@ export declare class UnsupportedOperationException extends __BaseException {
|
|
|
2445
2445
|
constructor(opts: __ExceptionOptionType<UnsupportedOperationException, __BaseException>);
|
|
2446
2446
|
}
|
|
2447
2447
|
/**
|
|
2448
|
-
* @public
|
|
2449
2448
|
* <p>Information about the detector model.</p>
|
|
2449
|
+
* @public
|
|
2450
2450
|
*/
|
|
2451
2451
|
export interface DetectorModelSummary {
|
|
2452
2452
|
/**
|
|
2453
|
-
* @public
|
|
2454
2453
|
* <p>The name of the detector model.</p>
|
|
2454
|
+
* @public
|
|
2455
2455
|
*/
|
|
2456
2456
|
detectorModelName?: string;
|
|
2457
2457
|
/**
|
|
2458
|
-
* @public
|
|
2459
2458
|
* <p>A brief description of the detector model.</p>
|
|
2459
|
+
* @public
|
|
2460
2460
|
*/
|
|
2461
2461
|
detectorModelDescription?: string;
|
|
2462
2462
|
/**
|
|
2463
|
-
* @public
|
|
2464
2463
|
* <p>The time the detector model was created.</p>
|
|
2464
|
+
* @public
|
|
2465
2465
|
*/
|
|
2466
2466
|
creationTime?: Date;
|
|
2467
2467
|
}
|
|
2468
2468
|
/**
|
|
2469
|
-
* @public
|
|
2470
2469
|
* <p>Information about the detector model version.</p>
|
|
2470
|
+
* @public
|
|
2471
2471
|
*/
|
|
2472
2472
|
export interface DetectorModelVersionSummary {
|
|
2473
2473
|
/**
|
|
2474
|
-
* @public
|
|
2475
2474
|
* <p>The name of the detector model.</p>
|
|
2475
|
+
* @public
|
|
2476
2476
|
*/
|
|
2477
2477
|
detectorModelName?: string;
|
|
2478
2478
|
/**
|
|
2479
|
-
* @public
|
|
2480
2479
|
* <p>The ID of the detector model version.</p>
|
|
2480
|
+
* @public
|
|
2481
2481
|
*/
|
|
2482
2482
|
detectorModelVersion?: string;
|
|
2483
2483
|
/**
|
|
2484
|
-
* @public
|
|
2485
2484
|
* <p>The ARN of the detector model version.</p>
|
|
2485
|
+
* @public
|
|
2486
2486
|
*/
|
|
2487
2487
|
detectorModelArn?: string;
|
|
2488
2488
|
/**
|
|
2489
|
-
* @public
|
|
2490
2489
|
* <p>The ARN of the role that grants the detector model permission to perform its tasks.</p>
|
|
2490
|
+
* @public
|
|
2491
2491
|
*/
|
|
2492
2492
|
roleArn?: string;
|
|
2493
2493
|
/**
|
|
2494
|
-
* @public
|
|
2495
2494
|
* <p>The time the detector model version was created.</p>
|
|
2495
|
+
* @public
|
|
2496
2496
|
*/
|
|
2497
2497
|
creationTime?: Date;
|
|
2498
2498
|
/**
|
|
2499
|
-
* @public
|
|
2500
2499
|
* <p>The last time the detector model version was updated.</p>
|
|
2500
|
+
* @public
|
|
2501
2501
|
*/
|
|
2502
2502
|
lastUpdateTime?: Date;
|
|
2503
2503
|
/**
|
|
2504
|
-
* @public
|
|
2505
2504
|
* <p>The status of the detector model version.</p>
|
|
2505
|
+
* @public
|
|
2506
2506
|
*/
|
|
2507
2507
|
status?: DetectorModelVersionStatus;
|
|
2508
2508
|
/**
|
|
2509
|
-
* @public
|
|
2510
2509
|
* <p>Information about the order in which events are evaluated and how actions are executed.
|
|
2511
2510
|
* </p>
|
|
2511
|
+
* @public
|
|
2512
2512
|
*/
|
|
2513
2513
|
evaluationMethod?: EvaluationMethod;
|
|
2514
2514
|
}
|
|
@@ -2517,18 +2517,18 @@ export interface DetectorModelVersionSummary {
|
|
|
2517
2517
|
*/
|
|
2518
2518
|
export interface GetDetectorModelAnalysisResultsRequest {
|
|
2519
2519
|
/**
|
|
2520
|
-
* @public
|
|
2521
2520
|
* <p>The ID of the analysis result that you want to retrieve.</p>
|
|
2521
|
+
* @public
|
|
2522
2522
|
*/
|
|
2523
2523
|
analysisId: string | undefined;
|
|
2524
2524
|
/**
|
|
2525
|
-
* @public
|
|
2526
2525
|
* <p>The token that you can use to return the next set of results.</p>
|
|
2526
|
+
* @public
|
|
2527
2527
|
*/
|
|
2528
2528
|
nextToken?: string;
|
|
2529
2529
|
/**
|
|
2530
|
-
* @public
|
|
2531
2530
|
* <p>The maximum number of results to be returned per request.</p>
|
|
2531
|
+
* @public
|
|
2532
2532
|
*/
|
|
2533
2533
|
maxResults?: number;
|
|
2534
2534
|
}
|
|
@@ -2537,124 +2537,124 @@ export interface GetDetectorModelAnalysisResultsRequest {
|
|
|
2537
2537
|
*/
|
|
2538
2538
|
export interface GetDetectorModelAnalysisResultsResponse {
|
|
2539
2539
|
/**
|
|
2540
|
-
* @public
|
|
2541
2540
|
* <p>Contains information about one or more analysis results.</p>
|
|
2541
|
+
* @public
|
|
2542
2542
|
*/
|
|
2543
2543
|
analysisResults?: AnalysisResult[];
|
|
2544
2544
|
/**
|
|
2545
|
-
* @public
|
|
2546
2545
|
* <p>The token that you can use to return the next set of results,
|
|
2547
2546
|
* or <code>null</code> if there are no more results.</p>
|
|
2547
|
+
* @public
|
|
2548
2548
|
*/
|
|
2549
2549
|
nextToken?: string;
|
|
2550
2550
|
}
|
|
2551
2551
|
/**
|
|
2552
|
-
* @public
|
|
2553
2552
|
* <p>
|
|
2554
2553
|
* The identifier of the input routed to AWS IoT Events.
|
|
2555
2554
|
* </p>
|
|
2555
|
+
* @public
|
|
2556
2556
|
*/
|
|
2557
2557
|
export interface IotEventsInputIdentifier {
|
|
2558
2558
|
/**
|
|
2559
|
-
* @public
|
|
2560
2559
|
* <p>
|
|
2561
2560
|
* The name of the input routed to AWS IoT Events.
|
|
2562
2561
|
* </p>
|
|
2562
|
+
* @public
|
|
2563
2563
|
*/
|
|
2564
2564
|
inputName: string | undefined;
|
|
2565
2565
|
}
|
|
2566
2566
|
/**
|
|
2567
|
-
* @public
|
|
2568
2567
|
* <p>
|
|
2569
2568
|
* The asset model property identifer of the input routed from AWS IoT SiteWise.
|
|
2570
2569
|
* </p>
|
|
2570
|
+
* @public
|
|
2571
2571
|
*/
|
|
2572
2572
|
export interface IotSiteWiseAssetModelPropertyIdentifier {
|
|
2573
2573
|
/**
|
|
2574
|
-
* @public
|
|
2575
2574
|
* <p>
|
|
2576
2575
|
* The ID of the AWS IoT SiteWise asset model.
|
|
2577
2576
|
* </p>
|
|
2577
|
+
* @public
|
|
2578
2578
|
*/
|
|
2579
2579
|
assetModelId: string | undefined;
|
|
2580
2580
|
/**
|
|
2581
|
-
* @public
|
|
2582
2581
|
* <p>
|
|
2583
2582
|
* The ID of the AWS IoT SiteWise asset property.
|
|
2584
2583
|
* </p>
|
|
2584
|
+
* @public
|
|
2585
2585
|
*/
|
|
2586
2586
|
propertyId: string | undefined;
|
|
2587
2587
|
}
|
|
2588
2588
|
/**
|
|
2589
|
-
* @public
|
|
2590
2589
|
* <p>
|
|
2591
2590
|
* The identifer of the input routed from AWS IoT SiteWise.
|
|
2592
2591
|
* </p>
|
|
2592
|
+
* @public
|
|
2593
2593
|
*/
|
|
2594
2594
|
export interface IotSiteWiseInputIdentifier {
|
|
2595
2595
|
/**
|
|
2596
|
-
* @public
|
|
2597
2596
|
* <p>
|
|
2598
2597
|
* The identifier of the AWS IoT SiteWise asset model property.
|
|
2599
2598
|
* </p>
|
|
2599
|
+
* @public
|
|
2600
2600
|
*/
|
|
2601
2601
|
iotSiteWiseAssetModelPropertyIdentifier?: IotSiteWiseAssetModelPropertyIdentifier;
|
|
2602
2602
|
}
|
|
2603
2603
|
/**
|
|
2604
|
-
* @public
|
|
2605
2604
|
* <p>
|
|
2606
2605
|
* The identifer of the input.
|
|
2607
2606
|
* </p>
|
|
2607
|
+
* @public
|
|
2608
2608
|
*/
|
|
2609
2609
|
export interface InputIdentifier {
|
|
2610
2610
|
/**
|
|
2611
|
-
* @public
|
|
2612
2611
|
* <p>
|
|
2613
2612
|
* The identifier of the input routed to AWS IoT Events.
|
|
2614
2613
|
* </p>
|
|
2614
|
+
* @public
|
|
2615
2615
|
*/
|
|
2616
2616
|
iotEventsInputIdentifier?: IotEventsInputIdentifier;
|
|
2617
2617
|
/**
|
|
2618
|
-
* @public
|
|
2619
2618
|
* <p>
|
|
2620
2619
|
* The identifer of the input routed from AWS IoT SiteWise.
|
|
2621
2620
|
* </p>
|
|
2621
|
+
* @public
|
|
2622
2622
|
*/
|
|
2623
2623
|
iotSiteWiseInputIdentifier?: IotSiteWiseInputIdentifier;
|
|
2624
2624
|
}
|
|
2625
2625
|
/**
|
|
2626
|
-
* @public
|
|
2627
2626
|
* <p>Information about the input.</p>
|
|
2627
|
+
* @public
|
|
2628
2628
|
*/
|
|
2629
2629
|
export interface InputSummary {
|
|
2630
2630
|
/**
|
|
2631
|
-
* @public
|
|
2632
2631
|
* <p>The name of the input.</p>
|
|
2632
|
+
* @public
|
|
2633
2633
|
*/
|
|
2634
2634
|
inputName?: string;
|
|
2635
2635
|
/**
|
|
2636
|
-
* @public
|
|
2637
2636
|
* <p>A brief description of the input.</p>
|
|
2637
|
+
* @public
|
|
2638
2638
|
*/
|
|
2639
2639
|
inputDescription?: string;
|
|
2640
2640
|
/**
|
|
2641
|
-
* @public
|
|
2642
2641
|
* <p>The ARN of the input.</p>
|
|
2642
|
+
* @public
|
|
2643
2643
|
*/
|
|
2644
2644
|
inputArn?: string;
|
|
2645
2645
|
/**
|
|
2646
|
-
* @public
|
|
2647
2646
|
* <p>The time the input was created.</p>
|
|
2647
|
+
* @public
|
|
2648
2648
|
*/
|
|
2649
2649
|
creationTime?: Date;
|
|
2650
2650
|
/**
|
|
2651
|
-
* @public
|
|
2652
2651
|
* <p>The last time the input was updated.</p>
|
|
2652
|
+
* @public
|
|
2653
2653
|
*/
|
|
2654
2654
|
lastUpdateTime?: Date;
|
|
2655
2655
|
/**
|
|
2656
|
-
* @public
|
|
2657
2656
|
* <p>The status of the input.</p>
|
|
2657
|
+
* @public
|
|
2658
2658
|
*/
|
|
2659
2659
|
status?: InputStatus;
|
|
2660
2660
|
}
|
|
@@ -2663,13 +2663,13 @@ export interface InputSummary {
|
|
|
2663
2663
|
*/
|
|
2664
2664
|
export interface ListAlarmModelsRequest {
|
|
2665
2665
|
/**
|
|
2666
|
-
* @public
|
|
2667
2666
|
* <p>The token that you can use to return the next set of results.</p>
|
|
2667
|
+
* @public
|
|
2668
2668
|
*/
|
|
2669
2669
|
nextToken?: string;
|
|
2670
2670
|
/**
|
|
2671
|
-
* @public
|
|
2672
2671
|
* <p>The maximum number of results to be returned per request.</p>
|
|
2672
|
+
* @public
|
|
2673
2673
|
*/
|
|
2674
2674
|
maxResults?: number;
|
|
2675
2675
|
}
|
|
@@ -2678,14 +2678,14 @@ export interface ListAlarmModelsRequest {
|
|
|
2678
2678
|
*/
|
|
2679
2679
|
export interface ListAlarmModelsResponse {
|
|
2680
2680
|
/**
|
|
2681
|
-
* @public
|
|
2682
2681
|
* <p>A list that summarizes each alarm model.</p>
|
|
2682
|
+
* @public
|
|
2683
2683
|
*/
|
|
2684
2684
|
alarmModelSummaries?: AlarmModelSummary[];
|
|
2685
2685
|
/**
|
|
2686
|
-
* @public
|
|
2687
2686
|
* <p>The token that you can use to return the next set of results,
|
|
2688
2687
|
* or <code>null</code> if there are no more results.</p>
|
|
2688
|
+
* @public
|
|
2689
2689
|
*/
|
|
2690
2690
|
nextToken?: string;
|
|
2691
2691
|
}
|
|
@@ -2694,18 +2694,18 @@ export interface ListAlarmModelsResponse {
|
|
|
2694
2694
|
*/
|
|
2695
2695
|
export interface ListAlarmModelVersionsRequest {
|
|
2696
2696
|
/**
|
|
2697
|
-
* @public
|
|
2698
2697
|
* <p>The name of the alarm model.</p>
|
|
2698
|
+
* @public
|
|
2699
2699
|
*/
|
|
2700
2700
|
alarmModelName: string | undefined;
|
|
2701
2701
|
/**
|
|
2702
|
-
* @public
|
|
2703
2702
|
* <p>The token that you can use to return the next set of results.</p>
|
|
2703
|
+
* @public
|
|
2704
2704
|
*/
|
|
2705
2705
|
nextToken?: string;
|
|
2706
2706
|
/**
|
|
2707
|
-
* @public
|
|
2708
2707
|
* <p>The maximum number of results to be returned per request.</p>
|
|
2708
|
+
* @public
|
|
2709
2709
|
*/
|
|
2710
2710
|
maxResults?: number;
|
|
2711
2711
|
}
|
|
@@ -2714,14 +2714,14 @@ export interface ListAlarmModelVersionsRequest {
|
|
|
2714
2714
|
*/
|
|
2715
2715
|
export interface ListAlarmModelVersionsResponse {
|
|
2716
2716
|
/**
|
|
2717
|
-
* @public
|
|
2718
2717
|
* <p>A list that summarizes each alarm model version.</p>
|
|
2718
|
+
* @public
|
|
2719
2719
|
*/
|
|
2720
2720
|
alarmModelVersionSummaries?: AlarmModelVersionSummary[];
|
|
2721
2721
|
/**
|
|
2722
|
-
* @public
|
|
2723
2722
|
* <p>The token that you can use to return the next set of results,
|
|
2724
2723
|
* or <code>null</code> if there are no more results.</p>
|
|
2724
|
+
* @public
|
|
2725
2725
|
*/
|
|
2726
2726
|
nextToken?: string;
|
|
2727
2727
|
}
|
|
@@ -2730,13 +2730,13 @@ export interface ListAlarmModelVersionsResponse {
|
|
|
2730
2730
|
*/
|
|
2731
2731
|
export interface ListDetectorModelsRequest {
|
|
2732
2732
|
/**
|
|
2733
|
-
* @public
|
|
2734
2733
|
* <p>The token that you can use to return the next set of results.</p>
|
|
2734
|
+
* @public
|
|
2735
2735
|
*/
|
|
2736
2736
|
nextToken?: string;
|
|
2737
2737
|
/**
|
|
2738
|
-
* @public
|
|
2739
2738
|
* <p>The maximum number of results to be returned per request.</p>
|
|
2739
|
+
* @public
|
|
2740
2740
|
*/
|
|
2741
2741
|
maxResults?: number;
|
|
2742
2742
|
}
|
|
@@ -2745,14 +2745,14 @@ export interface ListDetectorModelsRequest {
|
|
|
2745
2745
|
*/
|
|
2746
2746
|
export interface ListDetectorModelsResponse {
|
|
2747
2747
|
/**
|
|
2748
|
-
* @public
|
|
2749
2748
|
* <p>Summary information about the detector models.</p>
|
|
2749
|
+
* @public
|
|
2750
2750
|
*/
|
|
2751
2751
|
detectorModelSummaries?: DetectorModelSummary[];
|
|
2752
2752
|
/**
|
|
2753
|
-
* @public
|
|
2754
2753
|
* <p>The token that you can use to return the next set of results,
|
|
2755
2754
|
* or <code>null</code> if there are no more results.</p>
|
|
2755
|
+
* @public
|
|
2756
2756
|
*/
|
|
2757
2757
|
nextToken?: string;
|
|
2758
2758
|
}
|
|
@@ -2761,18 +2761,18 @@ export interface ListDetectorModelsResponse {
|
|
|
2761
2761
|
*/
|
|
2762
2762
|
export interface ListDetectorModelVersionsRequest {
|
|
2763
2763
|
/**
|
|
2764
|
-
* @public
|
|
2765
2764
|
* <p>The name of the detector model whose versions are returned.</p>
|
|
2765
|
+
* @public
|
|
2766
2766
|
*/
|
|
2767
2767
|
detectorModelName: string | undefined;
|
|
2768
2768
|
/**
|
|
2769
|
-
* @public
|
|
2770
2769
|
* <p>The token that you can use to return the next set of results.</p>
|
|
2770
|
+
* @public
|
|
2771
2771
|
*/
|
|
2772
2772
|
nextToken?: string;
|
|
2773
2773
|
/**
|
|
2774
|
-
* @public
|
|
2775
2774
|
* <p>The maximum number of results to be returned per request.</p>
|
|
2775
|
+
* @public
|
|
2776
2776
|
*/
|
|
2777
2777
|
maxResults?: number;
|
|
2778
2778
|
}
|
|
@@ -2781,14 +2781,14 @@ export interface ListDetectorModelVersionsRequest {
|
|
|
2781
2781
|
*/
|
|
2782
2782
|
export interface ListDetectorModelVersionsResponse {
|
|
2783
2783
|
/**
|
|
2784
|
-
* @public
|
|
2785
2784
|
* <p>Summary information about the detector model versions.</p>
|
|
2785
|
+
* @public
|
|
2786
2786
|
*/
|
|
2787
2787
|
detectorModelVersionSummaries?: DetectorModelVersionSummary[];
|
|
2788
2788
|
/**
|
|
2789
|
-
* @public
|
|
2790
2789
|
* <p>The token that you can use to return the next set of results,
|
|
2791
2790
|
* or <code>null</code> if there are no more results.</p>
|
|
2791
|
+
* @public
|
|
2792
2792
|
*/
|
|
2793
2793
|
nextToken?: string;
|
|
2794
2794
|
}
|
|
@@ -2797,46 +2797,46 @@ export interface ListDetectorModelVersionsResponse {
|
|
|
2797
2797
|
*/
|
|
2798
2798
|
export interface ListInputRoutingsRequest {
|
|
2799
2799
|
/**
|
|
2800
|
-
* @public
|
|
2801
2800
|
* <p>
|
|
2802
2801
|
* The identifer of the routed input.
|
|
2803
2802
|
* </p>
|
|
2803
|
+
* @public
|
|
2804
2804
|
*/
|
|
2805
2805
|
inputIdentifier: InputIdentifier | undefined;
|
|
2806
2806
|
/**
|
|
2807
|
-
* @public
|
|
2808
2807
|
* <p>
|
|
2809
2808
|
* The maximum number of results to be returned per request.
|
|
2810
2809
|
* </p>
|
|
2810
|
+
* @public
|
|
2811
2811
|
*/
|
|
2812
2812
|
maxResults?: number;
|
|
2813
2813
|
/**
|
|
2814
|
-
* @public
|
|
2815
2814
|
* <p>
|
|
2816
2815
|
* The token that you can use to return the next set of results.
|
|
2817
2816
|
* </p>
|
|
2817
|
+
* @public
|
|
2818
2818
|
*/
|
|
2819
2819
|
nextToken?: string;
|
|
2820
2820
|
}
|
|
2821
2821
|
/**
|
|
2822
|
-
* @public
|
|
2823
2822
|
* <p>
|
|
2824
2823
|
* Contains information about the routed resource.
|
|
2825
2824
|
* </p>
|
|
2825
|
+
* @public
|
|
2826
2826
|
*/
|
|
2827
2827
|
export interface RoutedResource {
|
|
2828
2828
|
/**
|
|
2829
|
-
* @public
|
|
2830
2829
|
* <p>
|
|
2831
2830
|
* The name of the routed resource.
|
|
2832
2831
|
* </p>
|
|
2832
|
+
* @public
|
|
2833
2833
|
*/
|
|
2834
2834
|
name?: string;
|
|
2835
2835
|
/**
|
|
2836
|
-
* @public
|
|
2837
2836
|
* <p>
|
|
2838
2837
|
* The ARN of the routed resource. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.
|
|
2839
2838
|
* </p>
|
|
2839
|
+
* @public
|
|
2840
2840
|
*/
|
|
2841
2841
|
arn?: string;
|
|
2842
2842
|
}
|
|
@@ -2845,18 +2845,18 @@ export interface RoutedResource {
|
|
|
2845
2845
|
*/
|
|
2846
2846
|
export interface ListInputRoutingsResponse {
|
|
2847
2847
|
/**
|
|
2848
|
-
* @public
|
|
2849
2848
|
* <p>
|
|
2850
2849
|
* Summary information about the routed resources.
|
|
2851
2850
|
* </p>
|
|
2851
|
+
* @public
|
|
2852
2852
|
*/
|
|
2853
2853
|
routedResources?: RoutedResource[];
|
|
2854
2854
|
/**
|
|
2855
|
-
* @public
|
|
2856
2855
|
* <p>
|
|
2857
2856
|
* The token that you can use to return the next set of results,
|
|
2858
2857
|
* or <code>null</code> if there are no more results.
|
|
2859
2858
|
* </p>
|
|
2859
|
+
* @public
|
|
2860
2860
|
*/
|
|
2861
2861
|
nextToken?: string;
|
|
2862
2862
|
}
|
|
@@ -2865,13 +2865,13 @@ export interface ListInputRoutingsResponse {
|
|
|
2865
2865
|
*/
|
|
2866
2866
|
export interface ListInputsRequest {
|
|
2867
2867
|
/**
|
|
2868
|
-
* @public
|
|
2869
2868
|
* <p>The token that you can use to return the next set of results.</p>
|
|
2869
|
+
* @public
|
|
2870
2870
|
*/
|
|
2871
2871
|
nextToken?: string;
|
|
2872
2872
|
/**
|
|
2873
|
-
* @public
|
|
2874
2873
|
* <p>The maximum number of results to be returned per request.</p>
|
|
2874
|
+
* @public
|
|
2875
2875
|
*/
|
|
2876
2876
|
maxResults?: number;
|
|
2877
2877
|
}
|
|
@@ -2880,14 +2880,14 @@ export interface ListInputsRequest {
|
|
|
2880
2880
|
*/
|
|
2881
2881
|
export interface ListInputsResponse {
|
|
2882
2882
|
/**
|
|
2883
|
-
* @public
|
|
2884
2883
|
* <p>Summary information about the inputs.</p>
|
|
2884
|
+
* @public
|
|
2885
2885
|
*/
|
|
2886
2886
|
inputSummaries?: InputSummary[];
|
|
2887
2887
|
/**
|
|
2888
|
-
* @public
|
|
2889
2888
|
* <p>The token that you can use to return the next set of results,
|
|
2890
2889
|
* or <code>null</code> if there are no more results.</p>
|
|
2890
|
+
* @public
|
|
2891
2891
|
*/
|
|
2892
2892
|
nextToken?: string;
|
|
2893
2893
|
}
|
|
@@ -2896,8 +2896,8 @@ export interface ListInputsResponse {
|
|
|
2896
2896
|
*/
|
|
2897
2897
|
export interface ListTagsForResourceRequest {
|
|
2898
2898
|
/**
|
|
2899
|
-
* @public
|
|
2900
2899
|
* <p>The ARN of the resource.</p>
|
|
2900
|
+
* @public
|
|
2901
2901
|
*/
|
|
2902
2902
|
resourceArn: string | undefined;
|
|
2903
2903
|
}
|
|
@@ -2906,8 +2906,8 @@ export interface ListTagsForResourceRequest {
|
|
|
2906
2906
|
*/
|
|
2907
2907
|
export interface ListTagsForResourceResponse {
|
|
2908
2908
|
/**
|
|
2909
|
-
* @public
|
|
2910
2909
|
* <p>The list of tags assigned to the resource.</p>
|
|
2910
|
+
* @public
|
|
2911
2911
|
*/
|
|
2912
2912
|
tags?: Tag[];
|
|
2913
2913
|
}
|
|
@@ -2916,8 +2916,8 @@ export interface ListTagsForResourceResponse {
|
|
|
2916
2916
|
*/
|
|
2917
2917
|
export interface PutLoggingOptionsRequest {
|
|
2918
2918
|
/**
|
|
2919
|
-
* @public
|
|
2920
2919
|
* <p>The new values of the AWS IoT Events logging options.</p>
|
|
2920
|
+
* @public
|
|
2921
2921
|
*/
|
|
2922
2922
|
loggingOptions: LoggingOptions | undefined;
|
|
2923
2923
|
}
|
|
@@ -2926,8 +2926,8 @@ export interface PutLoggingOptionsRequest {
|
|
|
2926
2926
|
*/
|
|
2927
2927
|
export interface StartDetectorModelAnalysisRequest {
|
|
2928
2928
|
/**
|
|
2929
|
-
* @public
|
|
2930
2929
|
* <p>Information that defines how a detector operates.</p>
|
|
2930
|
+
* @public
|
|
2931
2931
|
*/
|
|
2932
2932
|
detectorModelDefinition: DetectorModelDefinition | undefined;
|
|
2933
2933
|
}
|
|
@@ -2936,8 +2936,8 @@ export interface StartDetectorModelAnalysisRequest {
|
|
|
2936
2936
|
*/
|
|
2937
2937
|
export interface StartDetectorModelAnalysisResponse {
|
|
2938
2938
|
/**
|
|
2939
|
-
* @public
|
|
2940
2939
|
* <p>The ID that you can use to retrieve the analysis result.</p>
|
|
2940
|
+
* @public
|
|
2941
2941
|
*/
|
|
2942
2942
|
analysisId?: string;
|
|
2943
2943
|
}
|
|
@@ -2946,13 +2946,13 @@ export interface StartDetectorModelAnalysisResponse {
|
|
|
2946
2946
|
*/
|
|
2947
2947
|
export interface TagResourceRequest {
|
|
2948
2948
|
/**
|
|
2949
|
-
* @public
|
|
2950
2949
|
* <p>The ARN of the resource.</p>
|
|
2950
|
+
* @public
|
|
2951
2951
|
*/
|
|
2952
2952
|
resourceArn: string | undefined;
|
|
2953
2953
|
/**
|
|
2954
|
-
* @public
|
|
2955
2954
|
* <p>The new or modified tags for the resource.</p>
|
|
2955
|
+
* @public
|
|
2956
2956
|
*/
|
|
2957
2957
|
tags: Tag[] | undefined;
|
|
2958
2958
|
}
|
|
@@ -2966,13 +2966,13 @@ export interface TagResourceResponse {
|
|
|
2966
2966
|
*/
|
|
2967
2967
|
export interface UntagResourceRequest {
|
|
2968
2968
|
/**
|
|
2969
|
-
* @public
|
|
2970
2969
|
* <p>The ARN of the resource.</p>
|
|
2970
|
+
* @public
|
|
2971
2971
|
*/
|
|
2972
2972
|
resourceArn: string | undefined;
|
|
2973
2973
|
/**
|
|
2974
|
-
* @public
|
|
2975
2974
|
* <p>A list of the keys of the tags to be removed from the resource.</p>
|
|
2975
|
+
* @public
|
|
2976
2976
|
*/
|
|
2977
2977
|
tagKeys: string[] | undefined;
|
|
2978
2978
|
}
|
|
@@ -2986,43 +2986,43 @@ export interface UntagResourceResponse {
|
|
|
2986
2986
|
*/
|
|
2987
2987
|
export interface UpdateAlarmModelRequest {
|
|
2988
2988
|
/**
|
|
2989
|
-
* @public
|
|
2990
2989
|
* <p>The name of the alarm model.</p>
|
|
2990
|
+
* @public
|
|
2991
2991
|
*/
|
|
2992
2992
|
alarmModelName: string | undefined;
|
|
2993
2993
|
/**
|
|
2994
|
-
* @public
|
|
2995
2994
|
* <p>The description of the alarm model.</p>
|
|
2995
|
+
* @public
|
|
2996
2996
|
*/
|
|
2997
2997
|
alarmModelDescription?: string;
|
|
2998
2998
|
/**
|
|
2999
|
-
* @public
|
|
3000
2999
|
* <p>The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>
|
|
3000
|
+
* @public
|
|
3001
3001
|
*/
|
|
3002
3002
|
roleArn: string | undefined;
|
|
3003
3003
|
/**
|
|
3004
|
-
* @public
|
|
3005
3004
|
* <p>A non-negative integer that reflects the severity level of the alarm.</p>
|
|
3005
|
+
* @public
|
|
3006
3006
|
*/
|
|
3007
3007
|
severity?: number;
|
|
3008
3008
|
/**
|
|
3009
|
-
* @public
|
|
3010
3009
|
* <p>Defines when your alarm is invoked.</p>
|
|
3010
|
+
* @public
|
|
3011
3011
|
*/
|
|
3012
3012
|
alarmRule: AlarmRule | undefined;
|
|
3013
3013
|
/**
|
|
3014
|
-
* @public
|
|
3015
3014
|
* <p>Contains information about one or more notification actions.</p>
|
|
3015
|
+
* @public
|
|
3016
3016
|
*/
|
|
3017
3017
|
alarmNotification?: AlarmNotification;
|
|
3018
3018
|
/**
|
|
3019
|
-
* @public
|
|
3020
3019
|
* <p>Contains information about one or more alarm actions.</p>
|
|
3020
|
+
* @public
|
|
3021
3021
|
*/
|
|
3022
3022
|
alarmEventActions?: AlarmEventActions;
|
|
3023
3023
|
/**
|
|
3024
|
-
* @public
|
|
3025
3024
|
* <p>Contains the configuration information of alarm state changes.</p>
|
|
3025
|
+
* @public
|
|
3026
3026
|
*/
|
|
3027
3027
|
alarmCapabilities?: AlarmCapabilities;
|
|
3028
3028
|
}
|
|
@@ -3031,27 +3031,26 @@ export interface UpdateAlarmModelRequest {
|
|
|
3031
3031
|
*/
|
|
3032
3032
|
export interface UpdateAlarmModelResponse {
|
|
3033
3033
|
/**
|
|
3034
|
-
* @public
|
|
3035
3034
|
* <p>The time the alarm model was created, in the Unix epoch format.</p>
|
|
3035
|
+
* @public
|
|
3036
3036
|
*/
|
|
3037
3037
|
creationTime?: Date;
|
|
3038
3038
|
/**
|
|
3039
|
-
* @public
|
|
3040
3039
|
* <p>The ARN of the alarm model. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>
|
|
3040
|
+
* @public
|
|
3041
3041
|
*/
|
|
3042
3042
|
alarmModelArn?: string;
|
|
3043
3043
|
/**
|
|
3044
|
-
* @public
|
|
3045
3044
|
* <p>The version of the alarm model.</p>
|
|
3045
|
+
* @public
|
|
3046
3046
|
*/
|
|
3047
3047
|
alarmModelVersion?: string;
|
|
3048
3048
|
/**
|
|
3049
|
-
* @public
|
|
3050
3049
|
* <p>The time the alarm model was last updated, in the Unix epoch format.</p>
|
|
3050
|
+
* @public
|
|
3051
3051
|
*/
|
|
3052
3052
|
lastUpdateTime?: Date;
|
|
3053
3053
|
/**
|
|
3054
|
-
* @public
|
|
3055
3054
|
* <p>The status of the alarm model. The status can be one of the following values:</p>
|
|
3056
3055
|
* <ul>
|
|
3057
3056
|
* <li>
|
|
@@ -3074,6 +3073,7 @@ export interface UpdateAlarmModelResponse {
|
|
|
3074
3073
|
* and try again.</p>
|
|
3075
3074
|
* </li>
|
|
3076
3075
|
* </ul>
|
|
3076
|
+
* @public
|
|
3077
3077
|
*/
|
|
3078
3078
|
status?: AlarmModelVersionStatus;
|
|
3079
3079
|
}
|
|
@@ -3082,29 +3082,29 @@ export interface UpdateAlarmModelResponse {
|
|
|
3082
3082
|
*/
|
|
3083
3083
|
export interface UpdateDetectorModelRequest {
|
|
3084
3084
|
/**
|
|
3085
|
-
* @public
|
|
3086
3085
|
* <p>The name of the detector model that is updated.</p>
|
|
3086
|
+
* @public
|
|
3087
3087
|
*/
|
|
3088
3088
|
detectorModelName: string | undefined;
|
|
3089
3089
|
/**
|
|
3090
|
-
* @public
|
|
3091
3090
|
* <p>Information that defines how a detector operates.</p>
|
|
3091
|
+
* @public
|
|
3092
3092
|
*/
|
|
3093
3093
|
detectorModelDefinition: DetectorModelDefinition | undefined;
|
|
3094
3094
|
/**
|
|
3095
|
-
* @public
|
|
3096
3095
|
* <p>A brief description of the detector model.</p>
|
|
3096
|
+
* @public
|
|
3097
3097
|
*/
|
|
3098
3098
|
detectorModelDescription?: string;
|
|
3099
3099
|
/**
|
|
3100
|
-
* @public
|
|
3101
3100
|
* <p>The ARN of the role that grants permission to AWS IoT Events to perform its operations.</p>
|
|
3101
|
+
* @public
|
|
3102
3102
|
*/
|
|
3103
3103
|
roleArn: string | undefined;
|
|
3104
3104
|
/**
|
|
3105
|
-
* @public
|
|
3106
3105
|
* <p>Information about the order in which events are evaluated and how actions are executed.
|
|
3107
3106
|
* </p>
|
|
3107
|
+
* @public
|
|
3108
3108
|
*/
|
|
3109
3109
|
evaluationMethod?: EvaluationMethod;
|
|
3110
3110
|
}
|
|
@@ -3113,8 +3113,8 @@ export interface UpdateDetectorModelRequest {
|
|
|
3113
3113
|
*/
|
|
3114
3114
|
export interface UpdateDetectorModelResponse {
|
|
3115
3115
|
/**
|
|
3116
|
-
* @public
|
|
3117
3116
|
* <p>Information about how the detector model is configured.</p>
|
|
3117
|
+
* @public
|
|
3118
3118
|
*/
|
|
3119
3119
|
detectorModelConfiguration?: DetectorModelConfiguration;
|
|
3120
3120
|
}
|
|
@@ -3123,18 +3123,18 @@ export interface UpdateDetectorModelResponse {
|
|
|
3123
3123
|
*/
|
|
3124
3124
|
export interface UpdateInputRequest {
|
|
3125
3125
|
/**
|
|
3126
|
-
* @public
|
|
3127
3126
|
* <p>The name of the input you want to update.</p>
|
|
3127
|
+
* @public
|
|
3128
3128
|
*/
|
|
3129
3129
|
inputName: string | undefined;
|
|
3130
3130
|
/**
|
|
3131
|
-
* @public
|
|
3132
3131
|
* <p>A brief description of the input.</p>
|
|
3132
|
+
* @public
|
|
3133
3133
|
*/
|
|
3134
3134
|
inputDescription?: string;
|
|
3135
3135
|
/**
|
|
3136
|
-
* @public
|
|
3137
3136
|
* <p>The definition of the input.</p>
|
|
3137
|
+
* @public
|
|
3138
3138
|
*/
|
|
3139
3139
|
inputDefinition: InputDefinition | undefined;
|
|
3140
3140
|
}
|
|
@@ -3143,8 +3143,8 @@ export interface UpdateInputRequest {
|
|
|
3143
3143
|
*/
|
|
3144
3144
|
export interface UpdateInputResponse {
|
|
3145
3145
|
/**
|
|
3146
|
-
* @public
|
|
3147
3146
|
* <p>Information about the configuration of the input.</p>
|
|
3147
|
+
* @public
|
|
3148
3148
|
*/
|
|
3149
3149
|
inputConfiguration?: InputConfiguration;
|
|
3150
3150
|
}
|