1{ 2 "version": "2.0", 3 "service": "<p>AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use AWS IoT Events Data API commands to send inputs to detectors, list detectors, and view or update a detector's status.</p> <p> For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/what-is-iotevents.html\">What is AWS IoT Events?</a> in the <i>AWS IoT Events Developer Guide</i>.</p>", 4 "operations": { 5 "BatchAcknowledgeAlarm": "<p>Acknowledges one or more alarms. The alarms change to the <code>ACKNOWLEDGED</code> state after you acknowledge them.</p>", 6 "BatchDisableAlarm": "<p>Disables one or more alarms. The alarms change to the <code>DISABLED</code> state after you disable them.</p>", 7 "BatchEnableAlarm": "<p>Enables one or more alarms. The alarms change to the <code>NORMAL</code> state after you enable them.</p>", 8 "BatchPutMessage": "<p>Sends a set of messages to the AWS IoT Events system. Each message payload is transformed into the input you specify (<code>\"inputName\"</code>) and ingested into any detectors that monitor that input. If multiple messages are sent, the order in which the messages are processed isn't guaranteed. To guarantee ordering, you must send messages one at a time and wait for a successful response.</p>", 9 "BatchResetAlarm": "<p>Resets one or more alarms. The alarms return to the <code>NORMAL</code> state after you reset them.</p>", 10 "BatchSnoozeAlarm": "<p>Changes one or more alarms to the snooze mode. The alarms change to the <code>SNOOZE_DISABLED</code> state after you set them to the snooze mode.</p>", 11 "BatchUpdateDetector": "<p>Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.</p>", 12 "DescribeAlarm": "<p>Retrieves information about an alarm.</p>", 13 "DescribeDetector": "<p>Returns information about the specified detector (instance).</p>", 14 "ListAlarms": "<p>Lists one or more alarms. The operation returns only the metadata associated with each alarm.</p>", 15 "ListDetectors": "<p>Lists detectors (the instances of a detector model).</p>" 16 }, 17 "shapes": { 18 "AcknowledgeActionConfiguration": { 19 "base": "<p>Contains the configuration information of an acknowledge action.</p>", 20 "refs": { 21 "CustomerAction$acknowledgeActionConfiguration": "<p>Contains the configuration information of an acknowledge action.</p>" 22 } 23 }, 24 "AcknowledgeAlarmActionRequest": { 25 "base": "<p>Information needed to acknowledge the alarm.</p>", 26 "refs": { 27 "AcknowledgeAlarmActionRequests$member": null 28 } 29 }, 30 "AcknowledgeAlarmActionRequests": { 31 "base": null, 32 "refs": { 33 "BatchAcknowledgeAlarmRequest$acknowledgeActionRequests": "<p>The list of acknowledge action requests. You can specify up to 10 requests per operation.</p>" 34 } 35 }, 36 "Alarm": { 37 "base": "<p>Contains information about an alarm.</p>", 38 "refs": { 39 "DescribeAlarmResponse$alarm": "<p>Contains information about an alarm.</p>" 40 } 41 }, 42 "AlarmModelName": { 43 "base": null, 44 "refs": { 45 "AcknowledgeAlarmActionRequest$alarmModelName": "<p>The name of the alarm model.</p>", 46 "Alarm$alarmModelName": "<p>The name of the alarm model.</p>", 47 "AlarmSummary$alarmModelName": "<p>The name of the alarm model.</p>", 48 "DescribeAlarmRequest$alarmModelName": "<p>The name of the alarm model.</p>", 49 "DisableAlarmActionRequest$alarmModelName": "<p>The name of the alarm model.</p>", 50 "EnableAlarmActionRequest$alarmModelName": "<p>The name of the alarm model.</p>", 51 "ListAlarmsRequest$alarmModelName": "<p>The name of the alarm model.</p>", 52 "ResetAlarmActionRequest$alarmModelName": "<p>The name of the alarm model.</p>", 53 "SnoozeAlarmActionRequest$alarmModelName": "<p>The name of the alarm model.</p>" 54 } 55 }, 56 "AlarmModelVersion": { 57 "base": null, 58 "refs": { 59 "Alarm$alarmModelVersion": "<p>The version of the alarm model.</p>", 60 "AlarmSummary$alarmModelVersion": "<p>The version of the alarm model.</p>" 61 } 62 }, 63 "AlarmState": { 64 "base": "<p>Contains information about the current state of the alarm.</p>", 65 "refs": { 66 "Alarm$alarmState": "<p>Contains information about the current state of the alarm.</p>" 67 } 68 }, 69 "AlarmStateName": { 70 "base": null, 71 "refs": { 72 "AlarmState$stateName": "<p>The name of the alarm state. The state name can be one of the following values:</p> <ul> <li> <p> <code>DISABLED</code> - When the alarm is in the <code>DISABLED</code> state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the <code>NORMAL</code> state.</p> </li> <li> <p> <code>NORMAL</code> - When the alarm is in the <code>NORMAL</code> state, it's ready to evaluate data.</p> </li> <li> <p> <code>ACTIVE</code> - If the alarm is in the <code>ACTIVE</code> state, the alarm is invoked.</p> </li> <li> <p> <code>ACKNOWLEDGED</code> - When the alarm is in the <code>ACKNOWLEDGED</code> state, the alarm was invoked and you acknowledged the alarm.</p> </li> <li> <p> <code>SNOOZE_DISABLED</code> - When the alarm is in the <code>SNOOZE_DISABLED</code> state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the <code>NORMAL</code> state. </p> </li> <li> <p> <code>LATCHED</code> - When the alarm is in the <code>LATCHED</code> state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the <code>NORMAL</code> state, you must acknowledge the alarm.</p> </li> </ul>", 73 "AlarmSummary$stateName": "<p>The name of the alarm state. The state name can be one of the following values:</p> <ul> <li> <p> <code>DISABLED</code> - When the alarm is in the <code>DISABLED</code> state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the <code>NORMAL</code> state.</p> </li> <li> <p> <code>NORMAL</code> - When the alarm is in the <code>NORMAL</code> state, it's ready to evaluate data.</p> </li> <li> <p> <code>ACTIVE</code> - If the alarm is in the <code>ACTIVE</code> state, the alarm is invoked.</p> </li> <li> <p> <code>ACKNOWLEDGED</code> - When the alarm is in the <code>ACKNOWLEDGED</code> state, the alarm was invoked and you acknowledged the alarm.</p> </li> <li> <p> <code>SNOOZE_DISABLED</code> - When the alarm is in the <code>SNOOZE_DISABLED</code> state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the <code>NORMAL</code> state. </p> </li> <li> <p> <code>LATCHED</code> - When the alarm is in the <code>LATCHED</code> state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the <code>NORMAL</code> state, you must acknowledge the alarm.</p> </li> </ul>" 74 } 75 }, 76 "AlarmSummaries": { 77 "base": null, 78 "refs": { 79 "ListAlarmsResponse$alarmSummaries": "<p>A list that summarizes each alarm.</p>" 80 } 81 }, 82 "AlarmSummary": { 83 "base": "<p>Contains a summary of an alarm.</p>", 84 "refs": { 85 "AlarmSummaries$member": null 86 } 87 }, 88 "BatchAcknowledgeAlarmRequest": { 89 "base": null, 90 "refs": { 91 } 92 }, 93 "BatchAcknowledgeAlarmResponse": { 94 "base": null, 95 "refs": { 96 } 97 }, 98 "BatchAlarmActionErrorEntries": { 99 "base": null, 100 "refs": { 101 "BatchAcknowledgeAlarmResponse$errorEntries": "<p>A list of errors associated with the request, or <code>null</code> if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.</p>", 102 "BatchDisableAlarmResponse$errorEntries": "<p>A list of errors associated with the request, or <code>null</code> if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.</p>", 103 "BatchEnableAlarmResponse$errorEntries": "<p>A list of errors associated with the request, or <code>null</code> if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.</p>", 104 "BatchResetAlarmResponse$errorEntries": "<p>A list of errors associated with the request, or <code>null</code> if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.</p>", 105 "BatchSnoozeAlarmResponse$errorEntries": "<p>A list of errors associated with the request, or <code>null</code> if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.</p>" 106 } 107 }, 108 "BatchAlarmActionErrorEntry": { 109 "base": "<p>Contains error messages associated with one of the following requests:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchAcknowledgeAlarm.html\">BatchAcknowledgeAlarm</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchDisableAlarm.html\">BatchDisableAlarm</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchEnableAlarm.html\">BatchEnableAlarm</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchResetAlarm.html\">BatchResetAlarm</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchSnoozeAlarm.html\">BatchSnoozeAlarm</a> </p> </li> </ul>", 110 "refs": { 111 "BatchAlarmActionErrorEntries$member": null 112 } 113 }, 114 "BatchDisableAlarmRequest": { 115 "base": null, 116 "refs": { 117 } 118 }, 119 "BatchDisableAlarmResponse": { 120 "base": null, 121 "refs": { 122 } 123 }, 124 "BatchEnableAlarmRequest": { 125 "base": null, 126 "refs": { 127 } 128 }, 129 "BatchEnableAlarmResponse": { 130 "base": null, 131 "refs": { 132 } 133 }, 134 "BatchPutMessageErrorEntries": { 135 "base": null, 136 "refs": { 137 "BatchPutMessageResponse$BatchPutMessageErrorEntries": "<p>A list of any errors encountered when sending the messages.</p>" 138 } 139 }, 140 "BatchPutMessageErrorEntry": { 141 "base": "<p>Contains information about the errors encountered.</p>", 142 "refs": { 143 "BatchPutMessageErrorEntries$member": null 144 } 145 }, 146 "BatchPutMessageRequest": { 147 "base": null, 148 "refs": { 149 } 150 }, 151 "BatchPutMessageResponse": { 152 "base": null, 153 "refs": { 154 } 155 }, 156 "BatchResetAlarmRequest": { 157 "base": null, 158 "refs": { 159 } 160 }, 161 "BatchResetAlarmResponse": { 162 "base": null, 163 "refs": { 164 } 165 }, 166 "BatchSnoozeAlarmRequest": { 167 "base": null, 168 "refs": { 169 } 170 }, 171 "BatchSnoozeAlarmResponse": { 172 "base": null, 173 "refs": { 174 } 175 }, 176 "BatchUpdateDetectorErrorEntries": { 177 "base": null, 178 "refs": { 179 "BatchUpdateDetectorResponse$batchUpdateDetectorErrorEntries": "<p>A list of those detector updates that resulted in errors. (If an error is listed here, the specific update did not occur.)</p>" 180 } 181 }, 182 "BatchUpdateDetectorErrorEntry": { 183 "base": "<p>Information about the error that occurred when attempting to update a detector.</p>", 184 "refs": { 185 "BatchUpdateDetectorErrorEntries$member": null 186 } 187 }, 188 "BatchUpdateDetectorRequest": { 189 "base": null, 190 "refs": { 191 } 192 }, 193 "BatchUpdateDetectorResponse": { 194 "base": null, 195 "refs": { 196 } 197 }, 198 "ComparisonOperator": { 199 "base": null, 200 "refs": { 201 "SimpleRuleEvaluation$operator": "<p>The comparison operator.</p>" 202 } 203 }, 204 "CustomerAction": { 205 "base": "<p>Contains information about the action that you can take to respond to the alarm.</p>", 206 "refs": { 207 "AlarmState$customerAction": "<p>Contains information about the action that you can take to respond to the alarm.</p>" 208 } 209 }, 210 "CustomerActionName": { 211 "base": null, 212 "refs": { 213 "CustomerAction$actionName": "<p>The name of the action. The action name can be one of the following values:</p> <ul> <li> <p> <code>SNOOZE</code> - When you snooze the alarm, the alarm state changes to <code>SNOOZE_DISABLED</code>.</p> </li> <li> <p> <code>ENABLE</code> - When you enable the alarm, the alarm state changes to <code>NORMAL</code>.</p> </li> <li> <p> <code>DISABLE</code> - When you disable the alarm, the alarm state changes to <code>DISABLED</code>.</p> </li> <li> <p> <code>ACKNOWLEDGE</code> - When you acknowledge the alarm, the alarm state changes to <code>ACKNOWLEDGED</code>.</p> </li> <li> <p> <code>RESET</code> - When you reset the alarm, the alarm state changes to <code>NORMAL</code>.</p> </li> </ul> <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>" 214 } 215 }, 216 "DescribeAlarmRequest": { 217 "base": null, 218 "refs": { 219 } 220 }, 221 "DescribeAlarmResponse": { 222 "base": null, 223 "refs": { 224 } 225 }, 226 "DescribeDetectorRequest": { 227 "base": null, 228 "refs": { 229 } 230 }, 231 "DescribeDetectorResponse": { 232 "base": null, 233 "refs": { 234 } 235 }, 236 "Detector": { 237 "base": "<p>Information about the detector (instance).</p>", 238 "refs": { 239 "DescribeDetectorResponse$detector": "<p>Information about the detector (instance).</p>" 240 } 241 }, 242 "DetectorModelName": { 243 "base": null, 244 "refs": { 245 "DescribeDetectorRequest$detectorModelName": "<p>The name of the detector model whose detectors (instances) you want information about.</p>", 246 "Detector$detectorModelName": "<p>The name of the detector model that created this detector (instance).</p>", 247 "DetectorSummary$detectorModelName": "<p>The name of the detector model that created this detector (instance).</p>", 248 "ListDetectorsRequest$detectorModelName": "<p>The name of the detector model whose detectors (instances) are listed.</p>", 249 "UpdateDetectorRequest$detectorModelName": "<p>The name of the detector model that created the detectors (instances).</p>" 250 } 251 }, 252 "DetectorModelVersion": { 253 "base": null, 254 "refs": { 255 "Detector$detectorModelVersion": "<p>The version of the detector model that created this detector (instance).</p>", 256 "DetectorSummary$detectorModelVersion": "<p>The version of the detector model that created this detector (instance).</p>" 257 } 258 }, 259 "DetectorState": { 260 "base": "<p>Information about the current state of the detector instance.</p>", 261 "refs": { 262 "Detector$state": "<p>The current state of the detector (instance).</p>" 263 } 264 }, 265 "DetectorStateDefinition": { 266 "base": "<p>The new state, variable values, and timer settings of the detector (instance).</p>", 267 "refs": { 268 "UpdateDetectorRequest$state": "<p>The new state, variable values, and timer settings of the detector (instance).</p>" 269 } 270 }, 271 "DetectorStateSummary": { 272 "base": "<p>Information about the detector state.</p>", 273 "refs": { 274 "DetectorSummary$state": "<p>The current state of the detector (instance).</p>" 275 } 276 }, 277 "DetectorSummaries": { 278 "base": null, 279 "refs": { 280 "ListDetectorsResponse$detectorSummaries": "<p>A list of summary information about the detectors (instances).</p>" 281 } 282 }, 283 "DetectorSummary": { 284 "base": "<p>Information about the detector (instance).</p>", 285 "refs": { 286 "DetectorSummaries$member": null 287 } 288 }, 289 "DisableActionConfiguration": { 290 "base": "<p>Contains the configuration information of a disable action.</p>", 291 "refs": { 292 "CustomerAction$disableActionConfiguration": "<p>Contains the configuration information of a disable action.</p>" 293 } 294 }, 295 "DisableAlarmActionRequest": { 296 "base": "<p>Information used to disable the alarm.</p>", 297 "refs": { 298 "DisableAlarmActionRequests$member": null 299 } 300 }, 301 "DisableAlarmActionRequests": { 302 "base": null, 303 "refs": { 304 "BatchDisableAlarmRequest$disableActionRequests": "<p>The list of disable action requests. You can specify up to 10 requests per operation.</p>" 305 } 306 }, 307 "EnableActionConfiguration": { 308 "base": "<p>Contains the configuration information of an enable action.</p>", 309 "refs": { 310 "CustomerAction$enableActionConfiguration": "<p>Contains the configuration information of an enable action.</p>" 311 } 312 }, 313 "EnableAlarmActionRequest": { 314 "base": "<p>Information needed to enable the alarm.</p>", 315 "refs": { 316 "EnableAlarmActionRequests$member": null 317 } 318 }, 319 "EnableAlarmActionRequests": { 320 "base": null, 321 "refs": { 322 "BatchEnableAlarmRequest$enableActionRequests": "<p>The list of enable action requests. You can specify up to 10 requests per operation.</p>" 323 } 324 }, 325 "EphemeralInputName": { 326 "base": null, 327 "refs": { 328 "Message$inputName": "<p>The name of the input into which the message payload is transformed.</p>" 329 } 330 }, 331 "EpochMilliTimestamp": { 332 "base": null, 333 "refs": { 334 "TimestampValue$timeInMillis": "<p>The value of the timestamp, in the Unix epoch format.</p>" 335 } 336 }, 337 "ErrorCode": { 338 "base": null, 339 "refs": { 340 "BatchAlarmActionErrorEntry$errorCode": "<p>The error code.</p>", 341 "BatchPutMessageErrorEntry$errorCode": "<p>The error code.</p>", 342 "BatchUpdateDetectorErrorEntry$errorCode": "<p>The error code.</p>" 343 } 344 }, 345 "ErrorMessage": { 346 "base": null, 347 "refs": { 348 "BatchAlarmActionErrorEntry$errorMessage": "<p>A message that describes the error.</p>", 349 "BatchPutMessageErrorEntry$errorMessage": "<p>A message that describes the error.</p>", 350 "BatchUpdateDetectorErrorEntry$errorMessage": "<p>A message that describes the error.</p>" 351 } 352 }, 353 "EventType": { 354 "base": null, 355 "refs": { 356 "SystemEvent$eventType": "<p>The event type. If the value is <code>STATE_CHANGE</code>, the event contains information about alarm state changes.</p>" 357 } 358 }, 359 "InputPropertyValue": { 360 "base": null, 361 "refs": { 362 "SimpleRuleEvaluation$inputPropertyValue": "<p>The value of the input property, on the left side of the comparison operator.</p>" 363 } 364 }, 365 "InternalFailureException": { 366 "base": "<p>An internal failure occurred.</p>", 367 "refs": { 368 } 369 }, 370 "InvalidRequestException": { 371 "base": "<p>The request was invalid.</p>", 372 "refs": { 373 } 374 }, 375 "KeyValue": { 376 "base": null, 377 "refs": { 378 "AcknowledgeAlarmActionRequest$keyValue": "<p>The value of the key used as a filter to select only the alarms associated with the <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key\">key</a>.</p>", 379 "Alarm$keyValue": "<p>The value of the key used as a filter to select only the alarms associated with the <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key\">key</a>.</p>", 380 "AlarmSummary$keyValue": "<p>The value of the key used as a filter to select only the alarms associated with the <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key\">key</a>.</p>", 381 "DescribeAlarmRequest$keyValue": "<p>The value of the key used as a filter to select only the alarms associated with the <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key\">key</a>.</p>", 382 "DescribeDetectorRequest$keyValue": "<p>A filter used to limit results to detectors (instances) created because of the given key ID.</p>", 383 "Detector$keyValue": "<p>The value of the key (identifying the device or system) that caused the creation of this detector (instance).</p>", 384 "DetectorSummary$keyValue": "<p>The value of the key (identifying the device or system) that caused the creation of this detector (instance).</p>", 385 "DisableAlarmActionRequest$keyValue": "<p>The value of the key used as a filter to select only the alarms associated with the <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key\">key</a>.</p>", 386 "EnableAlarmActionRequest$keyValue": "<p>The value of the key used as a filter to select only the alarms associated with the <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key\">key</a>.</p>", 387 "ResetAlarmActionRequest$keyValue": "<p>The value of the key used as a filter to select only the alarms associated with the <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key\">key</a>.</p>", 388 "SnoozeAlarmActionRequest$keyValue": "<p>The value of the key used as a filter to select only the alarms associated with the <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key\">key</a>.</p>", 389 "UpdateDetectorRequest$keyValue": "<p>The value of the input key attribute (identifying the device or system) that caused the creation of this detector (instance).</p>" 390 } 391 }, 392 "ListAlarmsRequest": { 393 "base": null, 394 "refs": { 395 } 396 }, 397 "ListAlarmsResponse": { 398 "base": null, 399 "refs": { 400 } 401 }, 402 "ListDetectorsRequest": { 403 "base": null, 404 "refs": { 405 } 406 }, 407 "ListDetectorsResponse": { 408 "base": null, 409 "refs": { 410 } 411 }, 412 "MaxResults": { 413 "base": null, 414 "refs": { 415 "ListAlarmsRequest$maxResults": "<p>The maximum number of results to be returned per request.</p>", 416 "ListDetectorsRequest$maxResults": "<p>The maximum number of results to be returned per request.</p>" 417 } 418 }, 419 "Message": { 420 "base": "<p>Information about a message.</p>", 421 "refs": { 422 "Messages$member": null 423 } 424 }, 425 "MessageId": { 426 "base": null, 427 "refs": { 428 "BatchPutMessageErrorEntry$messageId": "<p>The ID of the message that caused the error. (See the value corresponding to the <code>\"messageId\"</code> key in the <code>\"message\"</code> object.)</p>", 429 "BatchUpdateDetectorErrorEntry$messageId": "<p>The <code>\"messageId\"</code> of the update request that caused the error. (The value of the <code>\"messageId\"</code> in the update request <code>\"Detector\"</code> object.)</p>", 430 "Message$messageId": "<p>The ID to assign to the message. Within each batch sent, each <code>\"messageId\"</code> must be unique.</p>", 431 "UpdateDetectorRequest$messageId": "<p>The ID to assign to the detector update <code>\"message\"</code>. Each <code>\"messageId\"</code> must be unique within each batch sent.</p>" 432 } 433 }, 434 "Messages": { 435 "base": null, 436 "refs": { 437 "BatchPutMessageRequest$messages": "<p>The list of messages to send. Each message has the following format: <code>'{ \"messageId\": \"string\", \"inputName\": \"string\", \"payload\": \"string\"}'</code> </p>" 438 } 439 }, 440 "NextToken": { 441 "base": null, 442 "refs": { 443 "ListAlarmsRequest$nextToken": "<p>The token that you can use to return the next set of results.</p>", 444 "ListAlarmsResponse$nextToken": "<p>The token that you can use to return the next set of results, or <code>null</code> if there are no more results.</p>", 445 "ListDetectorsRequest$nextToken": "<p>The token that you can use to return the next set of results.</p>", 446 "ListDetectorsResponse$nextToken": "<p>The token that you can use to return the next set of results, or <code>null</code> if there are no more results.</p>" 447 } 448 }, 449 "Note": { 450 "base": null, 451 "refs": { 452 "AcknowledgeActionConfiguration$note": "<p>The note that you can leave when you acknowledge the alarm.</p>", 453 "AcknowledgeAlarmActionRequest$note": "<p>The note that you can leave when you acknowledge the alarm.</p>", 454 "DisableActionConfiguration$note": "<p>The note that you can leave when you disable the alarm.</p>", 455 "DisableAlarmActionRequest$note": "<p>The note that you can leave when you disable the alarm.</p>", 456 "EnableActionConfiguration$note": "<p>The note that you can leave when you enable the alarm.</p>", 457 "EnableAlarmActionRequest$note": "<p>The note that you can leave when you enable the alarm.</p>", 458 "ResetActionConfiguration$note": "<p>The note that you can leave when you reset the alarm.</p>", 459 "ResetAlarmActionRequest$note": "<p>The note that you can leave when you reset the alarm.</p>", 460 "SnoozeActionConfiguration$note": "<p>The note that you can leave when you snooze the alarm.</p>", 461 "SnoozeAlarmActionRequest$note": "<p>The note that you can leave when you snooze the alarm.</p>" 462 } 463 }, 464 "Payload": { 465 "base": null, 466 "refs": { 467 "Message$payload": "<p>The payload of the message. This can be a JSON string or a Base-64-encoded string representing binary data (in which case you must decode it).</p>" 468 } 469 }, 470 "RequestId": { 471 "base": null, 472 "refs": { 473 "AcknowledgeAlarmActionRequest$requestId": "<p>The request ID. Each ID must be unique within each batch.</p>", 474 "BatchAlarmActionErrorEntry$requestId": "<p>The request ID. Each ID must be unique within each batch.</p>", 475 "DisableAlarmActionRequest$requestId": "<p>The request ID. Each ID must be unique within each batch.</p>", 476 "EnableAlarmActionRequest$requestId": "<p>The request ID. Each ID must be unique within each batch.</p>", 477 "ResetAlarmActionRequest$requestId": "<p>The request ID. Each ID must be unique within each batch.</p>", 478 "SnoozeAlarmActionRequest$requestId": "<p>The request ID. Each ID must be unique within each batch.</p>" 479 } 480 }, 481 "ResetActionConfiguration": { 482 "base": "<p>Contains the configuration information of a reset action.</p>", 483 "refs": { 484 "CustomerAction$resetActionConfiguration": "<p>Contains the configuration information of a reset action.</p>" 485 } 486 }, 487 "ResetAlarmActionRequest": { 488 "base": "<p>Information needed to reset the alarm.</p>", 489 "refs": { 490 "ResetAlarmActionRequests$member": null 491 } 492 }, 493 "ResetAlarmActionRequests": { 494 "base": null, 495 "refs": { 496 "BatchResetAlarmRequest$resetActionRequests": "<p>The list of reset action requests. You can specify up to 10 requests per operation.</p>" 497 } 498 }, 499 "ResourceNotFoundException": { 500 "base": "<p>The resource was not found.</p>", 501 "refs": { 502 } 503 }, 504 "RuleEvaluation": { 505 "base": "<p>Information needed to evaluate data.</p>", 506 "refs": { 507 "AlarmState$ruleEvaluation": "<p>Information needed to evaluate data.</p>" 508 } 509 }, 510 "Seconds": { 511 "base": null, 512 "refs": { 513 "TimerDefinition$seconds": "<p>The new setting of the timer (the number of seconds before the timer elapses).</p>" 514 } 515 }, 516 "ServiceUnavailableException": { 517 "base": "<p>The service is currently unavailable.</p>", 518 "refs": { 519 } 520 }, 521 "Severity": { 522 "base": null, 523 "refs": { 524 "Alarm$severity": "<p>A non-negative integer that reflects the severity level of the alarm.</p>" 525 } 526 }, 527 "SimpleRuleEvaluation": { 528 "base": "<p>Information needed to compare two values with a comparison operator.</p>", 529 "refs": { 530 "RuleEvaluation$simpleRuleEvaluation": "<p>Information needed to compare two values with a comparison operator.</p>" 531 } 532 }, 533 "SnoozeActionConfiguration": { 534 "base": "<p>Contains the configuration information of a snooze action.</p>", 535 "refs": { 536 "CustomerAction$snoozeActionConfiguration": "<p>Contains the configuration information of a snooze action.</p>" 537 } 538 }, 539 "SnoozeAlarmActionRequest": { 540 "base": "<p>Information needed to snooze the alarm.</p>", 541 "refs": { 542 "SnoozeAlarmActionRequests$member": null 543 } 544 }, 545 "SnoozeAlarmActionRequests": { 546 "base": null, 547 "refs": { 548 "BatchSnoozeAlarmRequest$snoozeActionRequests": "<p>The list of snooze action requests. You can specify up to 10 requests per operation.</p>" 549 } 550 }, 551 "SnoozeDuration": { 552 "base": null, 553 "refs": { 554 "SnoozeActionConfiguration$snoozeDuration": "<p>The snooze time in seconds. The alarm automatically changes to the <code>NORMAL</code> state after this duration.</p>", 555 "SnoozeAlarmActionRequest$snoozeDuration": "<p>The snooze time in seconds. The alarm automatically changes to the <code>NORMAL</code> state after this duration.</p>" 556 } 557 }, 558 "StateChangeConfiguration": { 559 "base": "<p>Contains the configuration information of alarm state changes.</p>", 560 "refs": { 561 "SystemEvent$stateChangeConfiguration": "<p>Contains the configuration information of alarm state changes.</p>" 562 } 563 }, 564 "StateName": { 565 "base": null, 566 "refs": { 567 "DetectorState$stateName": "<p>The name of the state.</p>", 568 "DetectorStateDefinition$stateName": "<p>The name of the new state of the detector (instance).</p>", 569 "DetectorStateSummary$stateName": "<p>The name of the state.</p>", 570 "ListDetectorsRequest$stateName": "<p>A filter that limits results to those detectors (instances) in the given state.</p>" 571 } 572 }, 573 "SystemEvent": { 574 "base": "<p>Contains information about alarm state changes.</p>", 575 "refs": { 576 "AlarmState$systemEvent": "<p>Contains information about alarm state changes.</p>" 577 } 578 }, 579 "ThresholdValue": { 580 "base": null, 581 "refs": { 582 "SimpleRuleEvaluation$thresholdValue": "<p>The threshold value, on the right side of the comparison operator.</p>" 583 } 584 }, 585 "ThrottlingException": { 586 "base": "<p>The request could not be completed due to throttling.</p>", 587 "refs": { 588 } 589 }, 590 "Timer": { 591 "base": "<p>The current state of a timer.</p>", 592 "refs": { 593 "Timers$member": null 594 } 595 }, 596 "TimerDefinition": { 597 "base": "<p>The new setting of a timer.</p>", 598 "refs": { 599 "TimerDefinitions$member": null 600 } 601 }, 602 "TimerDefinitions": { 603 "base": null, 604 "refs": { 605 "DetectorStateDefinition$timers": "<p>The new values of the detector's timers. Any timer whose value isn't specified is cleared, and its timeout event won't occur.</p>" 606 } 607 }, 608 "TimerName": { 609 "base": null, 610 "refs": { 611 "Timer$name": "<p>The name of the timer.</p>", 612 "TimerDefinition$name": "<p>The name of the timer.</p>" 613 } 614 }, 615 "Timers": { 616 "base": null, 617 "refs": { 618 "DetectorState$timers": "<p>The current state of the detector's timers.</p>" 619 } 620 }, 621 "Timestamp": { 622 "base": null, 623 "refs": { 624 "Alarm$creationTime": "<p>The time the alarm was created, in the Unix epoch format.</p>", 625 "Alarm$lastUpdateTime": "<p>The time the alarm was last updated, in the Unix epoch format.</p>", 626 "AlarmSummary$creationTime": "<p>The time the alarm was created, in the Unix epoch format.</p>", 627 "AlarmSummary$lastUpdateTime": "<p>The time the alarm was last updated, in the Unix epoch format.</p>", 628 "Detector$creationTime": "<p>The time the detector (instance) was created.</p>", 629 "Detector$lastUpdateTime": "<p>The time the detector (instance) was last updated.</p>", 630 "DetectorSummary$creationTime": "<p>The time the detector (instance) was created.</p>", 631 "DetectorSummary$lastUpdateTime": "<p>The time the detector (instance) was last updated.</p>", 632 "Timer$timestamp": "<p>The number of seconds which have elapsed on the timer.</p>" 633 } 634 }, 635 "TimestampValue": { 636 "base": "<p>Contains information about a timestamp.</p>", 637 "refs": { 638 "Message$timestamp": "<p>The timestamp associated with the message.</p>" 639 } 640 }, 641 "TriggerType": { 642 "base": null, 643 "refs": { 644 "StateChangeConfiguration$triggerType": "<p>The trigger type. If the value is <code>SNOOZE_TIMEOUT</code>, the snooze duration ends and the alarm automatically changes to the <code>NORMAL</code> state.</p>" 645 } 646 }, 647 "UpdateDetectorRequest": { 648 "base": "<p>Information used to update the detector (instance).</p>", 649 "refs": { 650 "UpdateDetectorRequests$member": null 651 } 652 }, 653 "UpdateDetectorRequests": { 654 "base": null, 655 "refs": { 656 "BatchUpdateDetectorRequest$detectors": "<p>The list of detectors (instances) to update, along with the values to update.</p>" 657 } 658 }, 659 "Variable": { 660 "base": "<p>The current state of the variable.</p>", 661 "refs": { 662 "Variables$member": null 663 } 664 }, 665 "VariableDefinition": { 666 "base": "<p>The new value of the variable.</p>", 667 "refs": { 668 "VariableDefinitions$member": null 669 } 670 }, 671 "VariableDefinitions": { 672 "base": null, 673 "refs": { 674 "DetectorStateDefinition$variables": "<p>The new values of the detector's variables. Any variable whose value isn't specified is cleared.</p>" 675 } 676 }, 677 "VariableName": { 678 "base": null, 679 "refs": { 680 "Variable$name": "<p>The name of the variable.</p>", 681 "VariableDefinition$name": "<p>The name of the variable.</p>" 682 } 683 }, 684 "VariableValue": { 685 "base": null, 686 "refs": { 687 "Variable$value": "<p>The current value of the variable.</p>", 688 "VariableDefinition$value": "<p>The new value of the variable.</p>" 689 } 690 }, 691 "Variables": { 692 "base": null, 693 "refs": { 694 "DetectorState$variables": "<p>The current values of the detector's variables.</p>" 695 } 696 }, 697 "errorMessage": { 698 "base": null, 699 "refs": { 700 "InternalFailureException$message": "<p>The message for the exception.</p>", 701 "InvalidRequestException$message": "<p>The message for the exception.</p>", 702 "ResourceNotFoundException$message": "<p>The message for the exception.</p>", 703 "ServiceUnavailableException$message": "<p>The message for the exception.</p>", 704 "ThrottlingException$message": "<p>The message for the exception.</p>" 705 } 706 } 707 } 708} 709