@aws-sdk/client-iot-events-data 3.34.0 → 3.37.0

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