aws-sdk-ioteventsdata 1.15.0 → 1.16.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ioteventsdata.rb +2 -2
- data/lib/aws-sdk-ioteventsdata/client.rb +294 -4
- data/lib/aws-sdk-ioteventsdata/client_api.rb +305 -2
- data/lib/aws-sdk-ioteventsdata/types.rb +928 -13
- metadata +5 -6
@@ -10,6 +10,377 @@
|
|
10
10
|
module Aws::IoTEventsData
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# Contains the configuration information of an acknowledge action.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] note
|
16
|
+
# The note that you can leave when you acknowledge the alarm.
|
17
|
+
# @return [String]
|
18
|
+
#
|
19
|
+
class AcknowledgeActionConfiguration < Struct.new(
|
20
|
+
:note)
|
21
|
+
SENSITIVE = []
|
22
|
+
include Aws::Structure
|
23
|
+
end
|
24
|
+
|
25
|
+
# Information needed to acknowledge the alarm.
|
26
|
+
#
|
27
|
+
# @note When making an API call, you may pass AcknowledgeAlarmActionRequest
|
28
|
+
# data as a hash:
|
29
|
+
#
|
30
|
+
# {
|
31
|
+
# request_id: "RequestId", # required
|
32
|
+
# alarm_model_name: "AlarmModelName", # required
|
33
|
+
# key_value: "KeyValue",
|
34
|
+
# note: "Note",
|
35
|
+
# }
|
36
|
+
#
|
37
|
+
# @!attribute [rw] request_id
|
38
|
+
# The request ID. Each ID must be unique within each batch.
|
39
|
+
# @return [String]
|
40
|
+
#
|
41
|
+
# @!attribute [rw] alarm_model_name
|
42
|
+
# The name of the alarm model.
|
43
|
+
# @return [String]
|
44
|
+
#
|
45
|
+
# @!attribute [rw] key_value
|
46
|
+
# The value of the key used as a filter to select only the alarms
|
47
|
+
# associated with the [key][1].
|
48
|
+
#
|
49
|
+
#
|
50
|
+
#
|
51
|
+
# [1]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key
|
52
|
+
# @return [String]
|
53
|
+
#
|
54
|
+
# @!attribute [rw] note
|
55
|
+
# The note that you can leave when you acknowledge the alarm.
|
56
|
+
# @return [String]
|
57
|
+
#
|
58
|
+
class AcknowledgeAlarmActionRequest < Struct.new(
|
59
|
+
:request_id,
|
60
|
+
:alarm_model_name,
|
61
|
+
:key_value,
|
62
|
+
:note)
|
63
|
+
SENSITIVE = []
|
64
|
+
include Aws::Structure
|
65
|
+
end
|
66
|
+
|
67
|
+
# Contains information about an alarm.
|
68
|
+
#
|
69
|
+
# @!attribute [rw] alarm_model_name
|
70
|
+
# The name of the alarm model.
|
71
|
+
# @return [String]
|
72
|
+
#
|
73
|
+
# @!attribute [rw] alarm_model_version
|
74
|
+
# The version of the alarm model.
|
75
|
+
# @return [String]
|
76
|
+
#
|
77
|
+
# @!attribute [rw] key_value
|
78
|
+
# The value of the key used as a filter to select only the alarms
|
79
|
+
# associated with the [key][1].
|
80
|
+
#
|
81
|
+
#
|
82
|
+
#
|
83
|
+
# [1]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key
|
84
|
+
# @return [String]
|
85
|
+
#
|
86
|
+
# @!attribute [rw] alarm_state
|
87
|
+
# Contains information about the current state of the alarm.
|
88
|
+
# @return [Types::AlarmState]
|
89
|
+
#
|
90
|
+
# @!attribute [rw] severity
|
91
|
+
# A non-negative integer that reflects the severity level of the
|
92
|
+
# alarm.
|
93
|
+
# @return [Integer]
|
94
|
+
#
|
95
|
+
# @!attribute [rw] creation_time
|
96
|
+
# The time the alarm was created, in the Unix epoch format.
|
97
|
+
# @return [Time]
|
98
|
+
#
|
99
|
+
# @!attribute [rw] last_update_time
|
100
|
+
# The time the alarm was last updated, in the Unix epoch format.
|
101
|
+
# @return [Time]
|
102
|
+
#
|
103
|
+
class Alarm < Struct.new(
|
104
|
+
:alarm_model_name,
|
105
|
+
:alarm_model_version,
|
106
|
+
:key_value,
|
107
|
+
:alarm_state,
|
108
|
+
:severity,
|
109
|
+
:creation_time,
|
110
|
+
:last_update_time)
|
111
|
+
SENSITIVE = []
|
112
|
+
include Aws::Structure
|
113
|
+
end
|
114
|
+
|
115
|
+
# Contains information about the current state of the alarm.
|
116
|
+
#
|
117
|
+
# @!attribute [rw] state_name
|
118
|
+
# The name of the alarm state. The state name can be one of the
|
119
|
+
# following values:
|
120
|
+
#
|
121
|
+
# * `DISABLED` - When the alarm is in the `DISABLED` state, it isn't
|
122
|
+
# ready to evaluate data. To enable the alarm, you must change the
|
123
|
+
# alarm to the `NORMAL` state.
|
124
|
+
#
|
125
|
+
# * `NORMAL` - When the alarm is in the `NORMAL` state, it's ready to
|
126
|
+
# evaluate data.
|
127
|
+
#
|
128
|
+
# * `ACTIVE` - If the alarm is in the `ACTIVE` state, the alarm is
|
129
|
+
# invoked.
|
130
|
+
#
|
131
|
+
# * `ACKNOWLEDGED` - When the alarm is in the `ACKNOWLEDGED` state,
|
132
|
+
# the alarm was invoked and you acknowledged the alarm.
|
133
|
+
#
|
134
|
+
# * `SNOOZE_DISABLED` - When the alarm is in the `SNOOZE_DISABLED`
|
135
|
+
# state, the alarm is disabled for a specified period of time. After
|
136
|
+
# the snooze time, the alarm automatically changes to the `NORMAL`
|
137
|
+
# state.
|
138
|
+
#
|
139
|
+
# * `LATCHED` - When the alarm is in the `LATCHED` state, the alarm
|
140
|
+
# was invoked. However, the data that the alarm is currently
|
141
|
+
# evaluating is within the specified range. To change the alarm to
|
142
|
+
# the `NORMAL` state, you must acknowledge the alarm.
|
143
|
+
# @return [String]
|
144
|
+
#
|
145
|
+
# @!attribute [rw] rule_evaluation
|
146
|
+
# Information needed to evaluate data.
|
147
|
+
# @return [Types::RuleEvaluation]
|
148
|
+
#
|
149
|
+
# @!attribute [rw] customer_action
|
150
|
+
# Contains information about the action that you can take to respond
|
151
|
+
# to the alarm.
|
152
|
+
# @return [Types::CustomerAction]
|
153
|
+
#
|
154
|
+
# @!attribute [rw] system_event
|
155
|
+
# Contains information about alarm state changes.
|
156
|
+
# @return [Types::SystemEvent]
|
157
|
+
#
|
158
|
+
class AlarmState < Struct.new(
|
159
|
+
:state_name,
|
160
|
+
:rule_evaluation,
|
161
|
+
:customer_action,
|
162
|
+
:system_event)
|
163
|
+
SENSITIVE = []
|
164
|
+
include Aws::Structure
|
165
|
+
end
|
166
|
+
|
167
|
+
# Contains a summary of an alarm.
|
168
|
+
#
|
169
|
+
# @!attribute [rw] alarm_model_name
|
170
|
+
# The name of the alarm model.
|
171
|
+
# @return [String]
|
172
|
+
#
|
173
|
+
# @!attribute [rw] alarm_model_version
|
174
|
+
# The version of the alarm model.
|
175
|
+
# @return [String]
|
176
|
+
#
|
177
|
+
# @!attribute [rw] key_value
|
178
|
+
# The value of the key used as a filter to select only the alarms
|
179
|
+
# associated with the [key][1].
|
180
|
+
#
|
181
|
+
#
|
182
|
+
#
|
183
|
+
# [1]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key
|
184
|
+
# @return [String]
|
185
|
+
#
|
186
|
+
# @!attribute [rw] state_name
|
187
|
+
# The name of the alarm state. The state name can be one of the
|
188
|
+
# following values:
|
189
|
+
#
|
190
|
+
# * `DISABLED` - When the alarm is in the `DISABLED` state, it isn't
|
191
|
+
# ready to evaluate data. To enable the alarm, you must change the
|
192
|
+
# alarm to the `NORMAL` state.
|
193
|
+
#
|
194
|
+
# * `NORMAL` - When the alarm is in the `NORMAL` state, it's ready to
|
195
|
+
# evaluate data.
|
196
|
+
#
|
197
|
+
# * `ACTIVE` - If the alarm is in the `ACTIVE` state, the alarm is
|
198
|
+
# invoked.
|
199
|
+
#
|
200
|
+
# * `ACKNOWLEDGED` - When the alarm is in the `ACKNOWLEDGED` state,
|
201
|
+
# the alarm was invoked and you acknowledged the alarm.
|
202
|
+
#
|
203
|
+
# * `SNOOZE_DISABLED` - When the alarm is in the `SNOOZE_DISABLED`
|
204
|
+
# state, the alarm is disabled for a specified period of time. After
|
205
|
+
# the snooze time, the alarm automatically changes to the `NORMAL`
|
206
|
+
# state.
|
207
|
+
#
|
208
|
+
# * `LATCHED` - When the alarm is in the `LATCHED` state, the alarm
|
209
|
+
# was invoked. However, the data that the alarm is currently
|
210
|
+
# evaluating is within the specified range. To change the alarm to
|
211
|
+
# the `NORMAL` state, you must acknowledge the alarm.
|
212
|
+
# @return [String]
|
213
|
+
#
|
214
|
+
# @!attribute [rw] creation_time
|
215
|
+
# The time the alarm was created, in the Unix epoch format.
|
216
|
+
# @return [Time]
|
217
|
+
#
|
218
|
+
# @!attribute [rw] last_update_time
|
219
|
+
# The time the alarm was last updated, in the Unix epoch format.
|
220
|
+
# @return [Time]
|
221
|
+
#
|
222
|
+
class AlarmSummary < Struct.new(
|
223
|
+
:alarm_model_name,
|
224
|
+
:alarm_model_version,
|
225
|
+
:key_value,
|
226
|
+
:state_name,
|
227
|
+
:creation_time,
|
228
|
+
:last_update_time)
|
229
|
+
SENSITIVE = []
|
230
|
+
include Aws::Structure
|
231
|
+
end
|
232
|
+
|
233
|
+
# @note When making an API call, you may pass BatchAcknowledgeAlarmRequest
|
234
|
+
# data as a hash:
|
235
|
+
#
|
236
|
+
# {
|
237
|
+
# acknowledge_action_requests: [ # required
|
238
|
+
# {
|
239
|
+
# request_id: "RequestId", # required
|
240
|
+
# alarm_model_name: "AlarmModelName", # required
|
241
|
+
# key_value: "KeyValue",
|
242
|
+
# note: "Note",
|
243
|
+
# },
|
244
|
+
# ],
|
245
|
+
# }
|
246
|
+
#
|
247
|
+
# @!attribute [rw] acknowledge_action_requests
|
248
|
+
# The list of acknowledge action requests. You can specify up to 10
|
249
|
+
# requests per operation.
|
250
|
+
# @return [Array<Types::AcknowledgeAlarmActionRequest>]
|
251
|
+
#
|
252
|
+
class BatchAcknowledgeAlarmRequest < Struct.new(
|
253
|
+
:acknowledge_action_requests)
|
254
|
+
SENSITIVE = []
|
255
|
+
include Aws::Structure
|
256
|
+
end
|
257
|
+
|
258
|
+
# @!attribute [rw] error_entries
|
259
|
+
# A list of errors associated with the request, or `null` if there are
|
260
|
+
# no errors. Each error entry contains an entry ID that helps you
|
261
|
+
# identify the entry that failed.
|
262
|
+
# @return [Array<Types::BatchAlarmActionErrorEntry>]
|
263
|
+
#
|
264
|
+
class BatchAcknowledgeAlarmResponse < Struct.new(
|
265
|
+
:error_entries)
|
266
|
+
SENSITIVE = []
|
267
|
+
include Aws::Structure
|
268
|
+
end
|
269
|
+
|
270
|
+
# Contains error messages associated with one of the following requests:
|
271
|
+
#
|
272
|
+
# * [BatchAcknowledgeAlarm][1]
|
273
|
+
#
|
274
|
+
# * [BatchDisableAlarm][2]
|
275
|
+
#
|
276
|
+
# * [BatchEnableAlarm][3]
|
277
|
+
#
|
278
|
+
# * [BatchResetAlarm][4]
|
279
|
+
#
|
280
|
+
# * [BatchSnoozeAlarm][5]
|
281
|
+
#
|
282
|
+
#
|
283
|
+
#
|
284
|
+
# [1]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchAcknowledgeAlarm.html
|
285
|
+
# [2]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchDisableAlarm.html
|
286
|
+
# [3]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchEnableAlarm.html
|
287
|
+
# [4]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchResetAlarm.html
|
288
|
+
# [5]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchSnoozeAlarm.html
|
289
|
+
#
|
290
|
+
# @!attribute [rw] request_id
|
291
|
+
# The request ID. Each ID must be unique within each batch.
|
292
|
+
# @return [String]
|
293
|
+
#
|
294
|
+
# @!attribute [rw] error_code
|
295
|
+
# The error code.
|
296
|
+
# @return [String]
|
297
|
+
#
|
298
|
+
# @!attribute [rw] error_message
|
299
|
+
# A message that describes the error.
|
300
|
+
# @return [String]
|
301
|
+
#
|
302
|
+
class BatchAlarmActionErrorEntry < Struct.new(
|
303
|
+
:request_id,
|
304
|
+
:error_code,
|
305
|
+
:error_message)
|
306
|
+
SENSITIVE = []
|
307
|
+
include Aws::Structure
|
308
|
+
end
|
309
|
+
|
310
|
+
# @note When making an API call, you may pass BatchDisableAlarmRequest
|
311
|
+
# data as a hash:
|
312
|
+
#
|
313
|
+
# {
|
314
|
+
# disable_action_requests: [ # required
|
315
|
+
# {
|
316
|
+
# request_id: "RequestId", # required
|
317
|
+
# alarm_model_name: "AlarmModelName", # required
|
318
|
+
# key_value: "KeyValue",
|
319
|
+
# note: "Note",
|
320
|
+
# },
|
321
|
+
# ],
|
322
|
+
# }
|
323
|
+
#
|
324
|
+
# @!attribute [rw] disable_action_requests
|
325
|
+
# The list of disable action requests. You can specify up to 10
|
326
|
+
# requests per operation.
|
327
|
+
# @return [Array<Types::DisableAlarmActionRequest>]
|
328
|
+
#
|
329
|
+
class BatchDisableAlarmRequest < Struct.new(
|
330
|
+
:disable_action_requests)
|
331
|
+
SENSITIVE = []
|
332
|
+
include Aws::Structure
|
333
|
+
end
|
334
|
+
|
335
|
+
# @!attribute [rw] error_entries
|
336
|
+
# A list of errors associated with the request, or `null` if there are
|
337
|
+
# no errors. Each error entry contains an entry ID that helps you
|
338
|
+
# identify the entry that failed.
|
339
|
+
# @return [Array<Types::BatchAlarmActionErrorEntry>]
|
340
|
+
#
|
341
|
+
class BatchDisableAlarmResponse < Struct.new(
|
342
|
+
:error_entries)
|
343
|
+
SENSITIVE = []
|
344
|
+
include Aws::Structure
|
345
|
+
end
|
346
|
+
|
347
|
+
# @note When making an API call, you may pass BatchEnableAlarmRequest
|
348
|
+
# data as a hash:
|
349
|
+
#
|
350
|
+
# {
|
351
|
+
# enable_action_requests: [ # required
|
352
|
+
# {
|
353
|
+
# request_id: "RequestId", # required
|
354
|
+
# alarm_model_name: "AlarmModelName", # required
|
355
|
+
# key_value: "KeyValue",
|
356
|
+
# note: "Note",
|
357
|
+
# },
|
358
|
+
# ],
|
359
|
+
# }
|
360
|
+
#
|
361
|
+
# @!attribute [rw] enable_action_requests
|
362
|
+
# The list of enable action requests. You can specify up to 10
|
363
|
+
# requests per operation.
|
364
|
+
# @return [Array<Types::EnableAlarmActionRequest>]
|
365
|
+
#
|
366
|
+
class BatchEnableAlarmRequest < Struct.new(
|
367
|
+
:enable_action_requests)
|
368
|
+
SENSITIVE = []
|
369
|
+
include Aws::Structure
|
370
|
+
end
|
371
|
+
|
372
|
+
# @!attribute [rw] error_entries
|
373
|
+
# A list of errors associated with the request, or `null` if there are
|
374
|
+
# no errors. Each error entry contains an entry ID that helps you
|
375
|
+
# identify the entry that failed.
|
376
|
+
# @return [Array<Types::BatchAlarmActionErrorEntry>]
|
377
|
+
#
|
378
|
+
class BatchEnableAlarmResponse < Struct.new(
|
379
|
+
:error_entries)
|
380
|
+
SENSITIVE = []
|
381
|
+
include Aws::Structure
|
382
|
+
end
|
383
|
+
|
13
384
|
# Contains information about the errors encountered.
|
14
385
|
#
|
15
386
|
# @!attribute [rw] message_id
|
@@ -18,11 +389,11 @@ module Aws::IoTEventsData
|
|
18
389
|
# @return [String]
|
19
390
|
#
|
20
391
|
# @!attribute [rw] error_code
|
21
|
-
# The code
|
392
|
+
# The error code.
|
22
393
|
# @return [String]
|
23
394
|
#
|
24
395
|
# @!attribute [rw] error_message
|
25
|
-
#
|
396
|
+
# A message that describes the error.
|
26
397
|
# @return [String]
|
27
398
|
#
|
28
399
|
class BatchPutMessageErrorEntry < Struct.new(
|
@@ -40,8 +411,11 @@ module Aws::IoTEventsData
|
|
40
411
|
# messages: [ # required
|
41
412
|
# {
|
42
413
|
# message_id: "MessageId", # required
|
43
|
-
# input_name: "
|
414
|
+
# input_name: "EphemeralInputName", # required
|
44
415
|
# payload: "data", # required
|
416
|
+
# timestamp: {
|
417
|
+
# time_in_millis: 1,
|
418
|
+
# },
|
45
419
|
# },
|
46
420
|
# ],
|
47
421
|
# }
|
@@ -68,7 +442,82 @@ module Aws::IoTEventsData
|
|
68
442
|
include Aws::Structure
|
69
443
|
end
|
70
444
|
|
71
|
-
#
|
445
|
+
# @note When making an API call, you may pass BatchResetAlarmRequest
|
446
|
+
# data as a hash:
|
447
|
+
#
|
448
|
+
# {
|
449
|
+
# reset_action_requests: [ # required
|
450
|
+
# {
|
451
|
+
# request_id: "RequestId", # required
|
452
|
+
# alarm_model_name: "AlarmModelName", # required
|
453
|
+
# key_value: "KeyValue",
|
454
|
+
# note: "Note",
|
455
|
+
# },
|
456
|
+
# ],
|
457
|
+
# }
|
458
|
+
#
|
459
|
+
# @!attribute [rw] reset_action_requests
|
460
|
+
# The list of reset action requests. You can specify up to 10 requests
|
461
|
+
# per operation.
|
462
|
+
# @return [Array<Types::ResetAlarmActionRequest>]
|
463
|
+
#
|
464
|
+
class BatchResetAlarmRequest < Struct.new(
|
465
|
+
:reset_action_requests)
|
466
|
+
SENSITIVE = []
|
467
|
+
include Aws::Structure
|
468
|
+
end
|
469
|
+
|
470
|
+
# @!attribute [rw] error_entries
|
471
|
+
# A list of errors associated with the request, or `null` if there are
|
472
|
+
# no errors. Each error entry contains an entry ID that helps you
|
473
|
+
# identify the entry that failed.
|
474
|
+
# @return [Array<Types::BatchAlarmActionErrorEntry>]
|
475
|
+
#
|
476
|
+
class BatchResetAlarmResponse < Struct.new(
|
477
|
+
:error_entries)
|
478
|
+
SENSITIVE = []
|
479
|
+
include Aws::Structure
|
480
|
+
end
|
481
|
+
|
482
|
+
# @note When making an API call, you may pass BatchSnoozeAlarmRequest
|
483
|
+
# data as a hash:
|
484
|
+
#
|
485
|
+
# {
|
486
|
+
# snooze_action_requests: [ # required
|
487
|
+
# {
|
488
|
+
# request_id: "RequestId", # required
|
489
|
+
# alarm_model_name: "AlarmModelName", # required
|
490
|
+
# key_value: "KeyValue",
|
491
|
+
# note: "Note",
|
492
|
+
# snooze_duration: 1, # required
|
493
|
+
# },
|
494
|
+
# ],
|
495
|
+
# }
|
496
|
+
#
|
497
|
+
# @!attribute [rw] snooze_action_requests
|
498
|
+
# The list of snooze action requests. You can specify up to 10
|
499
|
+
# requests per operation.
|
500
|
+
# @return [Array<Types::SnoozeAlarmActionRequest>]
|
501
|
+
#
|
502
|
+
class BatchSnoozeAlarmRequest < Struct.new(
|
503
|
+
:snooze_action_requests)
|
504
|
+
SENSITIVE = []
|
505
|
+
include Aws::Structure
|
506
|
+
end
|
507
|
+
|
508
|
+
# @!attribute [rw] error_entries
|
509
|
+
# A list of errors associated with the request, or `null` if there are
|
510
|
+
# no errors. Each error entry contains an entry ID that helps you
|
511
|
+
# identify the entry that failed.
|
512
|
+
# @return [Array<Types::BatchAlarmActionErrorEntry>]
|
513
|
+
#
|
514
|
+
class BatchSnoozeAlarmResponse < Struct.new(
|
515
|
+
:error_entries)
|
516
|
+
SENSITIVE = []
|
517
|
+
include Aws::Structure
|
518
|
+
end
|
519
|
+
|
520
|
+
# Information about the error that occurred when attempting to update a
|
72
521
|
# detector.
|
73
522
|
#
|
74
523
|
# @!attribute [rw] message_id
|
@@ -78,11 +527,11 @@ module Aws::IoTEventsData
|
|
78
527
|
# @return [String]
|
79
528
|
#
|
80
529
|
# @!attribute [rw] error_code
|
81
|
-
# The code
|
530
|
+
# The error code.
|
82
531
|
# @return [String]
|
83
532
|
#
|
84
533
|
# @!attribute [rw] error_message
|
85
|
-
# A message
|
534
|
+
# A message that describes the error.
|
86
535
|
# @return [String]
|
87
536
|
#
|
88
537
|
class BatchUpdateDetectorErrorEntry < Struct.new(
|
@@ -143,6 +592,104 @@ module Aws::IoTEventsData
|
|
143
592
|
include Aws::Structure
|
144
593
|
end
|
145
594
|
|
595
|
+
# Contains information about the action that you can take to respond to
|
596
|
+
# the alarm.
|
597
|
+
#
|
598
|
+
# @!attribute [rw] action_name
|
599
|
+
# The name of the action. The action name can be one of the following
|
600
|
+
# values:
|
601
|
+
#
|
602
|
+
# * `SNOOZE` - When you snooze the alarm, the alarm state changes to
|
603
|
+
# `SNOOZE_DISABLED`.
|
604
|
+
#
|
605
|
+
# * `ENABLE` - When you enable the alarm, the alarm state changes to
|
606
|
+
# `NORMAL`.
|
607
|
+
#
|
608
|
+
# * `DISABLE` - When you disable the alarm, the alarm state changes to
|
609
|
+
# `DISABLED`.
|
610
|
+
#
|
611
|
+
# * `ACKNOWLEDGE` - When you acknowledge the alarm, the alarm state
|
612
|
+
# changes to `ACKNOWLEDGED`.
|
613
|
+
#
|
614
|
+
# * `RESET` - When you reset the alarm, the alarm state changes to
|
615
|
+
# `NORMAL`.
|
616
|
+
#
|
617
|
+
# For more information, see the [AlarmState][1] API.
|
618
|
+
#
|
619
|
+
#
|
620
|
+
#
|
621
|
+
# [1]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_AlarmState.html
|
622
|
+
# @return [String]
|
623
|
+
#
|
624
|
+
# @!attribute [rw] snooze_action_configuration
|
625
|
+
# Contains the configuration information of a snooze action.
|
626
|
+
# @return [Types::SnoozeActionConfiguration]
|
627
|
+
#
|
628
|
+
# @!attribute [rw] enable_action_configuration
|
629
|
+
# Contains the configuration information of an enable action.
|
630
|
+
# @return [Types::EnableActionConfiguration]
|
631
|
+
#
|
632
|
+
# @!attribute [rw] disable_action_configuration
|
633
|
+
# Contains the configuration information of a disable action.
|
634
|
+
# @return [Types::DisableActionConfiguration]
|
635
|
+
#
|
636
|
+
# @!attribute [rw] acknowledge_action_configuration
|
637
|
+
# Contains the configuration information of an acknowledge action.
|
638
|
+
# @return [Types::AcknowledgeActionConfiguration]
|
639
|
+
#
|
640
|
+
# @!attribute [rw] reset_action_configuration
|
641
|
+
# Contains the configuration information of a reset action.
|
642
|
+
# @return [Types::ResetActionConfiguration]
|
643
|
+
#
|
644
|
+
class CustomerAction < Struct.new(
|
645
|
+
:action_name,
|
646
|
+
:snooze_action_configuration,
|
647
|
+
:enable_action_configuration,
|
648
|
+
:disable_action_configuration,
|
649
|
+
:acknowledge_action_configuration,
|
650
|
+
:reset_action_configuration)
|
651
|
+
SENSITIVE = []
|
652
|
+
include Aws::Structure
|
653
|
+
end
|
654
|
+
|
655
|
+
# @note When making an API call, you may pass DescribeAlarmRequest
|
656
|
+
# data as a hash:
|
657
|
+
#
|
658
|
+
# {
|
659
|
+
# alarm_model_name: "AlarmModelName", # required
|
660
|
+
# key_value: "KeyValue",
|
661
|
+
# }
|
662
|
+
#
|
663
|
+
# @!attribute [rw] alarm_model_name
|
664
|
+
# The name of the alarm model.
|
665
|
+
# @return [String]
|
666
|
+
#
|
667
|
+
# @!attribute [rw] key_value
|
668
|
+
# The value of the key used as a filter to select only the alarms
|
669
|
+
# associated with the [key][1].
|
670
|
+
#
|
671
|
+
#
|
672
|
+
#
|
673
|
+
# [1]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key
|
674
|
+
# @return [String]
|
675
|
+
#
|
676
|
+
class DescribeAlarmRequest < Struct.new(
|
677
|
+
:alarm_model_name,
|
678
|
+
:key_value)
|
679
|
+
SENSITIVE = []
|
680
|
+
include Aws::Structure
|
681
|
+
end
|
682
|
+
|
683
|
+
# @!attribute [rw] alarm
|
684
|
+
# Contains information about an alarm.
|
685
|
+
# @return [Types::Alarm]
|
686
|
+
#
|
687
|
+
class DescribeAlarmResponse < Struct.new(
|
688
|
+
:alarm)
|
689
|
+
SENSITIVE = []
|
690
|
+
include Aws::Structure
|
691
|
+
end
|
692
|
+
|
146
693
|
# @note When making an API call, you may pass DescribeDetectorRequest
|
147
694
|
# data as a hash:
|
148
695
|
#
|
@@ -336,7 +883,115 @@ module Aws::IoTEventsData
|
|
336
883
|
include Aws::Structure
|
337
884
|
end
|
338
885
|
|
339
|
-
#
|
886
|
+
# Contains the configuration information of a disable action.
|
887
|
+
#
|
888
|
+
# @!attribute [rw] note
|
889
|
+
# The note that you can leave when you disable the alarm.
|
890
|
+
# @return [String]
|
891
|
+
#
|
892
|
+
class DisableActionConfiguration < Struct.new(
|
893
|
+
:note)
|
894
|
+
SENSITIVE = []
|
895
|
+
include Aws::Structure
|
896
|
+
end
|
897
|
+
|
898
|
+
# Information used to disable the alarm.
|
899
|
+
#
|
900
|
+
# @note When making an API call, you may pass DisableAlarmActionRequest
|
901
|
+
# data as a hash:
|
902
|
+
#
|
903
|
+
# {
|
904
|
+
# request_id: "RequestId", # required
|
905
|
+
# alarm_model_name: "AlarmModelName", # required
|
906
|
+
# key_value: "KeyValue",
|
907
|
+
# note: "Note",
|
908
|
+
# }
|
909
|
+
#
|
910
|
+
# @!attribute [rw] request_id
|
911
|
+
# The request ID. Each ID must be unique within each batch.
|
912
|
+
# @return [String]
|
913
|
+
#
|
914
|
+
# @!attribute [rw] alarm_model_name
|
915
|
+
# The name of the alarm model.
|
916
|
+
# @return [String]
|
917
|
+
#
|
918
|
+
# @!attribute [rw] key_value
|
919
|
+
# The value of the key used as a filter to select only the alarms
|
920
|
+
# associated with the [key][1].
|
921
|
+
#
|
922
|
+
#
|
923
|
+
#
|
924
|
+
# [1]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key
|
925
|
+
# @return [String]
|
926
|
+
#
|
927
|
+
# @!attribute [rw] note
|
928
|
+
# The note that you can leave when you disable the alarm.
|
929
|
+
# @return [String]
|
930
|
+
#
|
931
|
+
class DisableAlarmActionRequest < Struct.new(
|
932
|
+
:request_id,
|
933
|
+
:alarm_model_name,
|
934
|
+
:key_value,
|
935
|
+
:note)
|
936
|
+
SENSITIVE = []
|
937
|
+
include Aws::Structure
|
938
|
+
end
|
939
|
+
|
940
|
+
# Contains the configuration information of an enable action.
|
941
|
+
#
|
942
|
+
# @!attribute [rw] note
|
943
|
+
# The note that you can leave when you enable the alarm.
|
944
|
+
# @return [String]
|
945
|
+
#
|
946
|
+
class EnableActionConfiguration < Struct.new(
|
947
|
+
:note)
|
948
|
+
SENSITIVE = []
|
949
|
+
include Aws::Structure
|
950
|
+
end
|
951
|
+
|
952
|
+
# Information needed to enable the alarm.
|
953
|
+
#
|
954
|
+
# @note When making an API call, you may pass EnableAlarmActionRequest
|
955
|
+
# data as a hash:
|
956
|
+
#
|
957
|
+
# {
|
958
|
+
# request_id: "RequestId", # required
|
959
|
+
# alarm_model_name: "AlarmModelName", # required
|
960
|
+
# key_value: "KeyValue",
|
961
|
+
# note: "Note",
|
962
|
+
# }
|
963
|
+
#
|
964
|
+
# @!attribute [rw] request_id
|
965
|
+
# The request ID. Each ID must be unique within each batch.
|
966
|
+
# @return [String]
|
967
|
+
#
|
968
|
+
# @!attribute [rw] alarm_model_name
|
969
|
+
# The name of the alarm model.
|
970
|
+
# @return [String]
|
971
|
+
#
|
972
|
+
# @!attribute [rw] key_value
|
973
|
+
# The value of the key used as a filter to select only the alarms
|
974
|
+
# associated with the [key][1].
|
975
|
+
#
|
976
|
+
#
|
977
|
+
#
|
978
|
+
# [1]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key
|
979
|
+
# @return [String]
|
980
|
+
#
|
981
|
+
# @!attribute [rw] note
|
982
|
+
# The note that you can leave when you enable the alarm.
|
983
|
+
# @return [String]
|
984
|
+
#
|
985
|
+
class EnableAlarmActionRequest < Struct.new(
|
986
|
+
:request_id,
|
987
|
+
:alarm_model_name,
|
988
|
+
:key_value,
|
989
|
+
:note)
|
990
|
+
SENSITIVE = []
|
991
|
+
include Aws::Structure
|
992
|
+
end
|
993
|
+
|
994
|
+
# An internal failure occurred.
|
340
995
|
#
|
341
996
|
# @!attribute [rw] message
|
342
997
|
# The message for the exception.
|
@@ -360,6 +1015,51 @@ module Aws::IoTEventsData
|
|
360
1015
|
include Aws::Structure
|
361
1016
|
end
|
362
1017
|
|
1018
|
+
# @note When making an API call, you may pass ListAlarmsRequest
|
1019
|
+
# data as a hash:
|
1020
|
+
#
|
1021
|
+
# {
|
1022
|
+
# alarm_model_name: "AlarmModelName", # required
|
1023
|
+
# next_token: "NextToken",
|
1024
|
+
# max_results: 1,
|
1025
|
+
# }
|
1026
|
+
#
|
1027
|
+
# @!attribute [rw] alarm_model_name
|
1028
|
+
# The name of the alarm model.
|
1029
|
+
# @return [String]
|
1030
|
+
#
|
1031
|
+
# @!attribute [rw] next_token
|
1032
|
+
# The token that you can use to return the next set of results.
|
1033
|
+
# @return [String]
|
1034
|
+
#
|
1035
|
+
# @!attribute [rw] max_results
|
1036
|
+
# The maximum number of results to be returned per request.
|
1037
|
+
# @return [Integer]
|
1038
|
+
#
|
1039
|
+
class ListAlarmsRequest < Struct.new(
|
1040
|
+
:alarm_model_name,
|
1041
|
+
:next_token,
|
1042
|
+
:max_results)
|
1043
|
+
SENSITIVE = []
|
1044
|
+
include Aws::Structure
|
1045
|
+
end
|
1046
|
+
|
1047
|
+
# @!attribute [rw] alarm_summaries
|
1048
|
+
# A list that summarizes each alarm.
|
1049
|
+
# @return [Array<Types::AlarmSummary>]
|
1050
|
+
#
|
1051
|
+
# @!attribute [rw] next_token
|
1052
|
+
# The token that you can use to return the next set of results, or
|
1053
|
+
# `null` if there are no more results.
|
1054
|
+
# @return [String]
|
1055
|
+
#
|
1056
|
+
class ListAlarmsResponse < Struct.new(
|
1057
|
+
:alarm_summaries,
|
1058
|
+
:next_token)
|
1059
|
+
SENSITIVE = []
|
1060
|
+
include Aws::Structure
|
1061
|
+
end
|
1062
|
+
|
363
1063
|
# @note When making an API call, you may pass ListDetectorsRequest
|
364
1064
|
# data as a hash:
|
365
1065
|
#
|
@@ -381,11 +1081,11 @@ module Aws::IoTEventsData
|
|
381
1081
|
# @return [String]
|
382
1082
|
#
|
383
1083
|
# @!attribute [rw] next_token
|
384
|
-
# The token
|
1084
|
+
# The token that you can use to return the next set of results.
|
385
1085
|
# @return [String]
|
386
1086
|
#
|
387
1087
|
# @!attribute [rw] max_results
|
388
|
-
# The maximum number of results to
|
1088
|
+
# The maximum number of results to be returned per request.
|
389
1089
|
# @return [Integer]
|
390
1090
|
#
|
391
1091
|
class ListDetectorsRequest < Struct.new(
|
@@ -402,8 +1102,8 @@ module Aws::IoTEventsData
|
|
402
1102
|
# @return [Array<Types::DetectorSummary>]
|
403
1103
|
#
|
404
1104
|
# @!attribute [rw] next_token
|
405
|
-
#
|
406
|
-
# no
|
1105
|
+
# The token that you can use to return the next set of results, or
|
1106
|
+
# `null` if there are no more results.
|
407
1107
|
# @return [String]
|
408
1108
|
#
|
409
1109
|
class ListDetectorsResponse < Struct.new(
|
@@ -420,8 +1120,11 @@ module Aws::IoTEventsData
|
|
420
1120
|
#
|
421
1121
|
# {
|
422
1122
|
# message_id: "MessageId", # required
|
423
|
-
# input_name: "
|
1123
|
+
# input_name: "EphemeralInputName", # required
|
424
1124
|
# payload: "data", # required
|
1125
|
+
# timestamp: {
|
1126
|
+
# time_in_millis: 1,
|
1127
|
+
# },
|
425
1128
|
# }
|
426
1129
|
#
|
427
1130
|
# @!attribute [rw] message_id
|
@@ -439,10 +1142,69 @@ module Aws::IoTEventsData
|
|
439
1142
|
# must decode it).
|
440
1143
|
# @return [String]
|
441
1144
|
#
|
1145
|
+
# @!attribute [rw] timestamp
|
1146
|
+
# The timestamp associated with the message.
|
1147
|
+
# @return [Types::TimestampValue]
|
1148
|
+
#
|
442
1149
|
class Message < Struct.new(
|
443
1150
|
:message_id,
|
444
1151
|
:input_name,
|
445
|
-
:payload
|
1152
|
+
:payload,
|
1153
|
+
:timestamp)
|
1154
|
+
SENSITIVE = []
|
1155
|
+
include Aws::Structure
|
1156
|
+
end
|
1157
|
+
|
1158
|
+
# Contains the configuration information of a reset action.
|
1159
|
+
#
|
1160
|
+
# @!attribute [rw] note
|
1161
|
+
# The note that you can leave when you reset the alarm.
|
1162
|
+
# @return [String]
|
1163
|
+
#
|
1164
|
+
class ResetActionConfiguration < Struct.new(
|
1165
|
+
:note)
|
1166
|
+
SENSITIVE = []
|
1167
|
+
include Aws::Structure
|
1168
|
+
end
|
1169
|
+
|
1170
|
+
# Information needed to reset the alarm.
|
1171
|
+
#
|
1172
|
+
# @note When making an API call, you may pass ResetAlarmActionRequest
|
1173
|
+
# data as a hash:
|
1174
|
+
#
|
1175
|
+
# {
|
1176
|
+
# request_id: "RequestId", # required
|
1177
|
+
# alarm_model_name: "AlarmModelName", # required
|
1178
|
+
# key_value: "KeyValue",
|
1179
|
+
# note: "Note",
|
1180
|
+
# }
|
1181
|
+
#
|
1182
|
+
# @!attribute [rw] request_id
|
1183
|
+
# The request ID. Each ID must be unique within each batch.
|
1184
|
+
# @return [String]
|
1185
|
+
#
|
1186
|
+
# @!attribute [rw] alarm_model_name
|
1187
|
+
# The name of the alarm model.
|
1188
|
+
# @return [String]
|
1189
|
+
#
|
1190
|
+
# @!attribute [rw] key_value
|
1191
|
+
# The value of the key used as a filter to select only the alarms
|
1192
|
+
# associated with the [key][1].
|
1193
|
+
#
|
1194
|
+
#
|
1195
|
+
#
|
1196
|
+
# [1]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key
|
1197
|
+
# @return [String]
|
1198
|
+
#
|
1199
|
+
# @!attribute [rw] note
|
1200
|
+
# The note that you can leave when you reset the alarm.
|
1201
|
+
# @return [String]
|
1202
|
+
#
|
1203
|
+
class ResetAlarmActionRequest < Struct.new(
|
1204
|
+
:request_id,
|
1205
|
+
:alarm_model_name,
|
1206
|
+
:key_value,
|
1207
|
+
:note)
|
446
1208
|
SENSITIVE = []
|
447
1209
|
include Aws::Structure
|
448
1210
|
end
|
@@ -459,6 +1221,18 @@ module Aws::IoTEventsData
|
|
459
1221
|
include Aws::Structure
|
460
1222
|
end
|
461
1223
|
|
1224
|
+
# Information needed to evaluate data.
|
1225
|
+
#
|
1226
|
+
# @!attribute [rw] simple_rule_evaluation
|
1227
|
+
# Information needed to compare two values with a comparison operator.
|
1228
|
+
# @return [Types::SimpleRuleEvaluation]
|
1229
|
+
#
|
1230
|
+
class RuleEvaluation < Struct.new(
|
1231
|
+
:simple_rule_evaluation)
|
1232
|
+
SENSITIVE = []
|
1233
|
+
include Aws::Structure
|
1234
|
+
end
|
1235
|
+
|
462
1236
|
# The service is currently unavailable.
|
463
1237
|
#
|
464
1238
|
# @!attribute [rw] message
|
@@ -471,6 +1245,128 @@ module Aws::IoTEventsData
|
|
471
1245
|
include Aws::Structure
|
472
1246
|
end
|
473
1247
|
|
1248
|
+
# Information needed to compare two values with a comparison operator.
|
1249
|
+
#
|
1250
|
+
# @!attribute [rw] input_property_value
|
1251
|
+
# The value of the input property, on the left side of the comparison
|
1252
|
+
# operator.
|
1253
|
+
# @return [String]
|
1254
|
+
#
|
1255
|
+
# @!attribute [rw] operator
|
1256
|
+
# The comparison operator.
|
1257
|
+
# @return [String]
|
1258
|
+
#
|
1259
|
+
# @!attribute [rw] threshold_value
|
1260
|
+
# The threshold value, on the right side of the comparison operator.
|
1261
|
+
# @return [String]
|
1262
|
+
#
|
1263
|
+
class SimpleRuleEvaluation < Struct.new(
|
1264
|
+
:input_property_value,
|
1265
|
+
:operator,
|
1266
|
+
:threshold_value)
|
1267
|
+
SENSITIVE = []
|
1268
|
+
include Aws::Structure
|
1269
|
+
end
|
1270
|
+
|
1271
|
+
# Contains the configuration information of a snooze action.
|
1272
|
+
#
|
1273
|
+
# @!attribute [rw] snooze_duration
|
1274
|
+
# The snooze time in seconds. The alarm automatically changes to the
|
1275
|
+
# `NORMAL` state after this duration.
|
1276
|
+
# @return [Integer]
|
1277
|
+
#
|
1278
|
+
# @!attribute [rw] note
|
1279
|
+
# The note that you can leave when you snooze the alarm.
|
1280
|
+
# @return [String]
|
1281
|
+
#
|
1282
|
+
class SnoozeActionConfiguration < Struct.new(
|
1283
|
+
:snooze_duration,
|
1284
|
+
:note)
|
1285
|
+
SENSITIVE = []
|
1286
|
+
include Aws::Structure
|
1287
|
+
end
|
1288
|
+
|
1289
|
+
# Information needed to snooze the alarm.
|
1290
|
+
#
|
1291
|
+
# @note When making an API call, you may pass SnoozeAlarmActionRequest
|
1292
|
+
# data as a hash:
|
1293
|
+
#
|
1294
|
+
# {
|
1295
|
+
# request_id: "RequestId", # required
|
1296
|
+
# alarm_model_name: "AlarmModelName", # required
|
1297
|
+
# key_value: "KeyValue",
|
1298
|
+
# note: "Note",
|
1299
|
+
# snooze_duration: 1, # required
|
1300
|
+
# }
|
1301
|
+
#
|
1302
|
+
# @!attribute [rw] request_id
|
1303
|
+
# The request ID. Each ID must be unique within each batch.
|
1304
|
+
# @return [String]
|
1305
|
+
#
|
1306
|
+
# @!attribute [rw] alarm_model_name
|
1307
|
+
# The name of the alarm model.
|
1308
|
+
# @return [String]
|
1309
|
+
#
|
1310
|
+
# @!attribute [rw] key_value
|
1311
|
+
# The value of the key used as a filter to select only the alarms
|
1312
|
+
# associated with the [key][1].
|
1313
|
+
#
|
1314
|
+
#
|
1315
|
+
#
|
1316
|
+
# [1]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key
|
1317
|
+
# @return [String]
|
1318
|
+
#
|
1319
|
+
# @!attribute [rw] note
|
1320
|
+
# The note that you can leave when you snooze the alarm.
|
1321
|
+
# @return [String]
|
1322
|
+
#
|
1323
|
+
# @!attribute [rw] snooze_duration
|
1324
|
+
# The snooze time in seconds. The alarm automatically changes to the
|
1325
|
+
# `NORMAL` state after this duration.
|
1326
|
+
# @return [Integer]
|
1327
|
+
#
|
1328
|
+
class SnoozeAlarmActionRequest < Struct.new(
|
1329
|
+
:request_id,
|
1330
|
+
:alarm_model_name,
|
1331
|
+
:key_value,
|
1332
|
+
:note,
|
1333
|
+
:snooze_duration)
|
1334
|
+
SENSITIVE = []
|
1335
|
+
include Aws::Structure
|
1336
|
+
end
|
1337
|
+
|
1338
|
+
# Contains the configuration information of alarm state changes.
|
1339
|
+
#
|
1340
|
+
# @!attribute [rw] trigger_type
|
1341
|
+
# The trigger type. If the value is `SNOOZE_TIMEOUT`, the snooze
|
1342
|
+
# duration ends and the alarm automatically changes to the `NORMAL`
|
1343
|
+
# state.
|
1344
|
+
# @return [String]
|
1345
|
+
#
|
1346
|
+
class StateChangeConfiguration < Struct.new(
|
1347
|
+
:trigger_type)
|
1348
|
+
SENSITIVE = []
|
1349
|
+
include Aws::Structure
|
1350
|
+
end
|
1351
|
+
|
1352
|
+
# Contains information about alarm state changes.
|
1353
|
+
#
|
1354
|
+
# @!attribute [rw] event_type
|
1355
|
+
# The event type. If the value is `STATE_CHANGE`, the event contains
|
1356
|
+
# information about alarm state changes.
|
1357
|
+
# @return [String]
|
1358
|
+
#
|
1359
|
+
# @!attribute [rw] state_change_configuration
|
1360
|
+
# Contains the configuration information of alarm state changes.
|
1361
|
+
# @return [Types::StateChangeConfiguration]
|
1362
|
+
#
|
1363
|
+
class SystemEvent < Struct.new(
|
1364
|
+
:event_type,
|
1365
|
+
:state_change_configuration)
|
1366
|
+
SENSITIVE = []
|
1367
|
+
include Aws::Structure
|
1368
|
+
end
|
1369
|
+
|
474
1370
|
# The request could not be completed due to throttling.
|
475
1371
|
#
|
476
1372
|
# @!attribute [rw] message
|
@@ -526,6 +1422,25 @@ module Aws::IoTEventsData
|
|
526
1422
|
include Aws::Structure
|
527
1423
|
end
|
528
1424
|
|
1425
|
+
# Contains information about a timestamp.
|
1426
|
+
#
|
1427
|
+
# @note When making an API call, you may pass TimestampValue
|
1428
|
+
# data as a hash:
|
1429
|
+
#
|
1430
|
+
# {
|
1431
|
+
# time_in_millis: 1,
|
1432
|
+
# }
|
1433
|
+
#
|
1434
|
+
# @!attribute [rw] time_in_millis
|
1435
|
+
# The value of the timestamp, in the Unix epoch format.
|
1436
|
+
# @return [Integer]
|
1437
|
+
#
|
1438
|
+
class TimestampValue < Struct.new(
|
1439
|
+
:time_in_millis)
|
1440
|
+
SENSITIVE = []
|
1441
|
+
include Aws::Structure
|
1442
|
+
end
|
1443
|
+
|
529
1444
|
# Information used to update the detector (instance).
|
530
1445
|
#
|
531
1446
|
# @note When making an API call, you may pass UpdateDetectorRequest
|