iotevents-data-2018-10-23.min.json 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717
  1. {
  2. "version": "2.0",
  3. "metadata": {
  4. "apiVersion": "2018-10-23",
  5. "endpointPrefix": "data.iotevents",
  6. "protocol": "rest-json",
  7. "serviceFullName": "AWS IoT Events Data",
  8. "serviceId": "IoT Events Data",
  9. "signatureVersion": "v4",
  10. "signingName": "ioteventsdata",
  11. "uid": "iotevents-data-2018-10-23"
  12. },
  13. "operations": {
  14. "BatchAcknowledgeAlarm": {
  15. "http": {
  16. "requestUri": "/alarms/acknowledge",
  17. "responseCode": 202
  18. },
  19. "input": {
  20. "type": "structure",
  21. "required": [
  22. "acknowledgeActionRequests"
  23. ],
  24. "members": {
  25. "acknowledgeActionRequests": {
  26. "type": "list",
  27. "member": {
  28. "type": "structure",
  29. "required": [
  30. "requestId",
  31. "alarmModelName"
  32. ],
  33. "members": {
  34. "requestId": {},
  35. "alarmModelName": {},
  36. "keyValue": {},
  37. "note": {}
  38. }
  39. }
  40. }
  41. }
  42. },
  43. "output": {
  44. "type": "structure",
  45. "members": {
  46. "errorEntries": {
  47. "shape": "S9"
  48. }
  49. }
  50. }
  51. },
  52. "BatchDeleteDetector": {
  53. "http": {
  54. "requestUri": "/detectors/delete",
  55. "responseCode": 200
  56. },
  57. "input": {
  58. "type": "structure",
  59. "required": [
  60. "detectors"
  61. ],
  62. "members": {
  63. "detectors": {
  64. "type": "list",
  65. "member": {
  66. "type": "structure",
  67. "required": [
  68. "messageId",
  69. "detectorModelName"
  70. ],
  71. "members": {
  72. "messageId": {},
  73. "detectorModelName": {},
  74. "keyValue": {}
  75. }
  76. }
  77. }
  78. }
  79. },
  80. "output": {
  81. "type": "structure",
  82. "members": {
  83. "batchDeleteDetectorErrorEntries": {
  84. "type": "list",
  85. "member": {
  86. "type": "structure",
  87. "members": {
  88. "messageId": {},
  89. "errorCode": {},
  90. "errorMessage": {}
  91. }
  92. }
  93. }
  94. }
  95. }
  96. },
  97. "BatchDisableAlarm": {
  98. "http": {
  99. "requestUri": "/alarms/disable",
  100. "responseCode": 202
  101. },
  102. "input": {
  103. "type": "structure",
  104. "required": [
  105. "disableActionRequests"
  106. ],
  107. "members": {
  108. "disableActionRequests": {
  109. "type": "list",
  110. "member": {
  111. "type": "structure",
  112. "required": [
  113. "requestId",
  114. "alarmModelName"
  115. ],
  116. "members": {
  117. "requestId": {},
  118. "alarmModelName": {},
  119. "keyValue": {},
  120. "note": {}
  121. }
  122. }
  123. }
  124. }
  125. },
  126. "output": {
  127. "type": "structure",
  128. "members": {
  129. "errorEntries": {
  130. "shape": "S9"
  131. }
  132. }
  133. }
  134. },
  135. "BatchEnableAlarm": {
  136. "http": {
  137. "requestUri": "/alarms/enable",
  138. "responseCode": 202
  139. },
  140. "input": {
  141. "type": "structure",
  142. "required": [
  143. "enableActionRequests"
  144. ],
  145. "members": {
  146. "enableActionRequests": {
  147. "type": "list",
  148. "member": {
  149. "type": "structure",
  150. "required": [
  151. "requestId",
  152. "alarmModelName"
  153. ],
  154. "members": {
  155. "requestId": {},
  156. "alarmModelName": {},
  157. "keyValue": {},
  158. "note": {}
  159. }
  160. }
  161. }
  162. }
  163. },
  164. "output": {
  165. "type": "structure",
  166. "members": {
  167. "errorEntries": {
  168. "shape": "S9"
  169. }
  170. }
  171. }
  172. },
  173. "BatchPutMessage": {
  174. "http": {
  175. "requestUri": "/inputs/messages",
  176. "responseCode": 200
  177. },
  178. "input": {
  179. "type": "structure",
  180. "required": [
  181. "messages"
  182. ],
  183. "members": {
  184. "messages": {
  185. "type": "list",
  186. "member": {
  187. "type": "structure",
  188. "required": [
  189. "messageId",
  190. "inputName",
  191. "payload"
  192. ],
  193. "members": {
  194. "messageId": {},
  195. "inputName": {},
  196. "payload": {
  197. "type": "blob"
  198. },
  199. "timestamp": {
  200. "type": "structure",
  201. "members": {
  202. "timeInMillis": {
  203. "type": "long"
  204. }
  205. }
  206. }
  207. }
  208. }
  209. }
  210. }
  211. },
  212. "output": {
  213. "type": "structure",
  214. "members": {
  215. "BatchPutMessageErrorEntries": {
  216. "type": "list",
  217. "member": {
  218. "type": "structure",
  219. "members": {
  220. "messageId": {},
  221. "errorCode": {},
  222. "errorMessage": {}
  223. }
  224. }
  225. }
  226. }
  227. }
  228. },
  229. "BatchResetAlarm": {
  230. "http": {
  231. "requestUri": "/alarms/reset",
  232. "responseCode": 202
  233. },
  234. "input": {
  235. "type": "structure",
  236. "required": [
  237. "resetActionRequests"
  238. ],
  239. "members": {
  240. "resetActionRequests": {
  241. "type": "list",
  242. "member": {
  243. "type": "structure",
  244. "required": [
  245. "requestId",
  246. "alarmModelName"
  247. ],
  248. "members": {
  249. "requestId": {},
  250. "alarmModelName": {},
  251. "keyValue": {},
  252. "note": {}
  253. }
  254. }
  255. }
  256. }
  257. },
  258. "output": {
  259. "type": "structure",
  260. "members": {
  261. "errorEntries": {
  262. "shape": "S9"
  263. }
  264. }
  265. }
  266. },
  267. "BatchSnoozeAlarm": {
  268. "http": {
  269. "requestUri": "/alarms/snooze",
  270. "responseCode": 202
  271. },
  272. "input": {
  273. "type": "structure",
  274. "required": [
  275. "snoozeActionRequests"
  276. ],
  277. "members": {
  278. "snoozeActionRequests": {
  279. "type": "list",
  280. "member": {
  281. "type": "structure",
  282. "required": [
  283. "requestId",
  284. "alarmModelName",
  285. "snoozeDuration"
  286. ],
  287. "members": {
  288. "requestId": {},
  289. "alarmModelName": {},
  290. "keyValue": {},
  291. "note": {},
  292. "snoozeDuration": {
  293. "type": "integer"
  294. }
  295. }
  296. }
  297. }
  298. }
  299. },
  300. "output": {
  301. "type": "structure",
  302. "members": {
  303. "errorEntries": {
  304. "shape": "S9"
  305. }
  306. }
  307. }
  308. },
  309. "BatchUpdateDetector": {
  310. "http": {
  311. "requestUri": "/detectors",
  312. "responseCode": 200
  313. },
  314. "input": {
  315. "type": "structure",
  316. "required": [
  317. "detectors"
  318. ],
  319. "members": {
  320. "detectors": {
  321. "type": "list",
  322. "member": {
  323. "type": "structure",
  324. "required": [
  325. "messageId",
  326. "detectorModelName",
  327. "state"
  328. ],
  329. "members": {
  330. "messageId": {},
  331. "detectorModelName": {},
  332. "keyValue": {},
  333. "state": {
  334. "type": "structure",
  335. "required": [
  336. "stateName",
  337. "variables",
  338. "timers"
  339. ],
  340. "members": {
  341. "stateName": {},
  342. "variables": {
  343. "type": "list",
  344. "member": {
  345. "type": "structure",
  346. "required": [
  347. "name",
  348. "value"
  349. ],
  350. "members": {
  351. "name": {},
  352. "value": {}
  353. }
  354. }
  355. },
  356. "timers": {
  357. "type": "list",
  358. "member": {
  359. "type": "structure",
  360. "required": [
  361. "name",
  362. "seconds"
  363. ],
  364. "members": {
  365. "name": {},
  366. "seconds": {
  367. "type": "integer"
  368. }
  369. }
  370. }
  371. }
  372. }
  373. }
  374. }
  375. }
  376. }
  377. }
  378. },
  379. "output": {
  380. "type": "structure",
  381. "members": {
  382. "batchUpdateDetectorErrorEntries": {
  383. "type": "list",
  384. "member": {
  385. "type": "structure",
  386. "members": {
  387. "messageId": {},
  388. "errorCode": {},
  389. "errorMessage": {}
  390. }
  391. }
  392. }
  393. }
  394. }
  395. },
  396. "DescribeAlarm": {
  397. "http": {
  398. "method": "GET",
  399. "requestUri": "/alarms/{alarmModelName}/keyValues/"
  400. },
  401. "input": {
  402. "type": "structure",
  403. "required": [
  404. "alarmModelName"
  405. ],
  406. "members": {
  407. "alarmModelName": {
  408. "location": "uri",
  409. "locationName": "alarmModelName"
  410. },
  411. "keyValue": {
  412. "location": "querystring",
  413. "locationName": "keyValue"
  414. }
  415. }
  416. },
  417. "output": {
  418. "type": "structure",
  419. "members": {
  420. "alarm": {
  421. "type": "structure",
  422. "members": {
  423. "alarmModelName": {},
  424. "alarmModelVersion": {},
  425. "keyValue": {},
  426. "alarmState": {
  427. "type": "structure",
  428. "members": {
  429. "stateName": {},
  430. "ruleEvaluation": {
  431. "type": "structure",
  432. "members": {
  433. "simpleRuleEvaluation": {
  434. "type": "structure",
  435. "members": {
  436. "inputPropertyValue": {},
  437. "operator": {},
  438. "thresholdValue": {}
  439. }
  440. }
  441. }
  442. },
  443. "customerAction": {
  444. "type": "structure",
  445. "members": {
  446. "actionName": {},
  447. "snoozeActionConfiguration": {
  448. "type": "structure",
  449. "members": {
  450. "snoozeDuration": {
  451. "type": "integer"
  452. },
  453. "note": {}
  454. }
  455. },
  456. "enableActionConfiguration": {
  457. "type": "structure",
  458. "members": {
  459. "note": {}
  460. }
  461. },
  462. "disableActionConfiguration": {
  463. "type": "structure",
  464. "members": {
  465. "note": {}
  466. }
  467. },
  468. "acknowledgeActionConfiguration": {
  469. "type": "structure",
  470. "members": {
  471. "note": {}
  472. }
  473. },
  474. "resetActionConfiguration": {
  475. "type": "structure",
  476. "members": {
  477. "note": {}
  478. }
  479. }
  480. }
  481. },
  482. "systemEvent": {
  483. "type": "structure",
  484. "members": {
  485. "eventType": {},
  486. "stateChangeConfiguration": {
  487. "type": "structure",
  488. "members": {
  489. "triggerType": {}
  490. }
  491. }
  492. }
  493. }
  494. }
  495. },
  496. "severity": {
  497. "type": "integer"
  498. },
  499. "creationTime": {
  500. "type": "timestamp"
  501. },
  502. "lastUpdateTime": {
  503. "type": "timestamp"
  504. }
  505. }
  506. }
  507. }
  508. }
  509. },
  510. "DescribeDetector": {
  511. "http": {
  512. "method": "GET",
  513. "requestUri": "/detectors/{detectorModelName}/keyValues/"
  514. },
  515. "input": {
  516. "type": "structure",
  517. "required": [
  518. "detectorModelName"
  519. ],
  520. "members": {
  521. "detectorModelName": {
  522. "location": "uri",
  523. "locationName": "detectorModelName"
  524. },
  525. "keyValue": {
  526. "location": "querystring",
  527. "locationName": "keyValue"
  528. }
  529. }
  530. },
  531. "output": {
  532. "type": "structure",
  533. "members": {
  534. "detector": {
  535. "type": "structure",
  536. "members": {
  537. "detectorModelName": {},
  538. "keyValue": {},
  539. "detectorModelVersion": {},
  540. "state": {
  541. "type": "structure",
  542. "required": [
  543. "stateName",
  544. "variables",
  545. "timers"
  546. ],
  547. "members": {
  548. "stateName": {},
  549. "variables": {
  550. "type": "list",
  551. "member": {
  552. "type": "structure",
  553. "required": [
  554. "name",
  555. "value"
  556. ],
  557. "members": {
  558. "name": {},
  559. "value": {}
  560. }
  561. }
  562. },
  563. "timers": {
  564. "type": "list",
  565. "member": {
  566. "type": "structure",
  567. "required": [
  568. "name",
  569. "timestamp"
  570. ],
  571. "members": {
  572. "name": {},
  573. "timestamp": {
  574. "type": "timestamp"
  575. }
  576. }
  577. }
  578. }
  579. }
  580. },
  581. "creationTime": {
  582. "type": "timestamp"
  583. },
  584. "lastUpdateTime": {
  585. "type": "timestamp"
  586. }
  587. }
  588. }
  589. }
  590. }
  591. },
  592. "ListAlarms": {
  593. "http": {
  594. "method": "GET",
  595. "requestUri": "/alarms/{alarmModelName}"
  596. },
  597. "input": {
  598. "type": "structure",
  599. "required": [
  600. "alarmModelName"
  601. ],
  602. "members": {
  603. "alarmModelName": {
  604. "location": "uri",
  605. "locationName": "alarmModelName"
  606. },
  607. "nextToken": {
  608. "location": "querystring",
  609. "locationName": "nextToken"
  610. },
  611. "maxResults": {
  612. "location": "querystring",
  613. "locationName": "maxResults",
  614. "type": "integer"
  615. }
  616. }
  617. },
  618. "output": {
  619. "type": "structure",
  620. "members": {
  621. "alarmSummaries": {
  622. "type": "list",
  623. "member": {
  624. "type": "structure",
  625. "members": {
  626. "alarmModelName": {},
  627. "alarmModelVersion": {},
  628. "keyValue": {},
  629. "stateName": {},
  630. "creationTime": {
  631. "type": "timestamp"
  632. },
  633. "lastUpdateTime": {
  634. "type": "timestamp"
  635. }
  636. }
  637. }
  638. },
  639. "nextToken": {}
  640. }
  641. }
  642. },
  643. "ListDetectors": {
  644. "http": {
  645. "method": "GET",
  646. "requestUri": "/detectors/{detectorModelName}"
  647. },
  648. "input": {
  649. "type": "structure",
  650. "required": [
  651. "detectorModelName"
  652. ],
  653. "members": {
  654. "detectorModelName": {
  655. "location": "uri",
  656. "locationName": "detectorModelName"
  657. },
  658. "stateName": {
  659. "location": "querystring",
  660. "locationName": "stateName"
  661. },
  662. "nextToken": {
  663. "location": "querystring",
  664. "locationName": "nextToken"
  665. },
  666. "maxResults": {
  667. "location": "querystring",
  668. "locationName": "maxResults",
  669. "type": "integer"
  670. }
  671. }
  672. },
  673. "output": {
  674. "type": "structure",
  675. "members": {
  676. "detectorSummaries": {
  677. "type": "list",
  678. "member": {
  679. "type": "structure",
  680. "members": {
  681. "detectorModelName": {},
  682. "keyValue": {},
  683. "detectorModelVersion": {},
  684. "state": {
  685. "type": "structure",
  686. "members": {
  687. "stateName": {}
  688. }
  689. },
  690. "creationTime": {
  691. "type": "timestamp"
  692. },
  693. "lastUpdateTime": {
  694. "type": "timestamp"
  695. }
  696. }
  697. }
  698. },
  699. "nextToken": {}
  700. }
  701. }
  702. }
  703. },
  704. "shapes": {
  705. "S9": {
  706. "type": "list",
  707. "member": {
  708. "type": "structure",
  709. "members": {
  710. "requestId": {},
  711. "errorCode": {},
  712. "errorMessage": {}
  713. }
  714. }
  715. }
  716. }
  717. }