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