docs-2.json 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152
  1. {
  2. "version": "2.0",
  3. "service": "<fullname>AWS IoT</fullname> <p>AWS IoT-Data enables secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. It implements a broker for applications and things to publish messages over HTTP (Publish) and retrieve, update, and delete thing shadows. A thing shadow is a persistent representation of your things and their state in the AWS cloud.</p>",
  4. "operations": {
  5. "DeleteThingShadow": "<p>Deletes the thing shadow for the specified thing.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/API_DeleteThingShadow.html\">DeleteThingShadow</a> in the <i>AWS IoT Developer Guide</i>.</p>",
  6. "GetThingShadow": "<p>Gets the thing shadow for the specified thing.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/API_GetThingShadow.html\">GetThingShadow</a> in the <i>AWS IoT Developer Guide</i>.</p>",
  7. "Publish": "<p>Publishes state information.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/protocols.html#http\">HTTP Protocol</a> in the <i>AWS IoT Developer Guide</i>.</p>",
  8. "UpdateThingShadow": "<p>Updates the thing shadow for the specified thing.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/API_UpdateThingShadow.html\">UpdateThingShadow</a> in the <i>AWS IoT Developer Guide</i>.</p>"
  9. },
  10. "shapes": {
  11. "ConflictException": {
  12. "base": "<p>The specified version does not match the version of the document.</p>",
  13. "refs": {
  14. }
  15. },
  16. "DeleteThingShadowRequest": {
  17. "base": "<p>The input for the DeleteThingShadow operation.</p>",
  18. "refs": {
  19. }
  20. },
  21. "DeleteThingShadowResponse": {
  22. "base": "<p>The output from the DeleteThingShadow operation.</p>",
  23. "refs": {
  24. }
  25. },
  26. "ErrorMessage": {
  27. "base": null,
  28. "refs": {
  29. "ConflictException$message": "<p>The message for the exception.</p>",
  30. "MethodNotAllowedException$message": "<p>The message for the exception.</p>",
  31. "RequestEntityTooLargeException$message": "<p>The message for the exception.</p>"
  32. }
  33. },
  34. "GetThingShadowRequest": {
  35. "base": "<p>The input for the GetThingShadow operation.</p>",
  36. "refs": {
  37. }
  38. },
  39. "GetThingShadowResponse": {
  40. "base": "<p>The output from the GetThingShadow operation.</p>",
  41. "refs": {
  42. }
  43. },
  44. "InternalFailureException": {
  45. "base": "<p>An unexpected error has occurred.</p>",
  46. "refs": {
  47. }
  48. },
  49. "InvalidRequestException": {
  50. "base": "<p>The request is not valid.</p>",
  51. "refs": {
  52. }
  53. },
  54. "JsonDocument": {
  55. "base": null,
  56. "refs": {
  57. "DeleteThingShadowResponse$payload": "<p>The state information, in JSON format.</p>",
  58. "GetThingShadowResponse$payload": "<p>The state information, in JSON format.</p>",
  59. "UpdateThingShadowRequest$payload": "<p>The state information, in JSON format.</p>",
  60. "UpdateThingShadowResponse$payload": "<p>The state information, in JSON format.</p>"
  61. }
  62. },
  63. "MethodNotAllowedException": {
  64. "base": "<p>The specified combination of HTTP verb and URI is not supported.</p>",
  65. "refs": {
  66. }
  67. },
  68. "Payload": {
  69. "base": null,
  70. "refs": {
  71. "PublishRequest$payload": "<p>The state information, in JSON format.</p>"
  72. }
  73. },
  74. "PublishRequest": {
  75. "base": "<p>The input for the Publish operation.</p>",
  76. "refs": {
  77. }
  78. },
  79. "Qos": {
  80. "base": null,
  81. "refs": {
  82. "PublishRequest$qos": "<p>The Quality of Service (QoS) level.</p>"
  83. }
  84. },
  85. "RequestEntityTooLargeException": {
  86. "base": "<p>The payload exceeds the maximum size allowed.</p>",
  87. "refs": {
  88. }
  89. },
  90. "ResourceNotFoundException": {
  91. "base": "<p>The specified resource does not exist.</p>",
  92. "refs": {
  93. }
  94. },
  95. "ServiceUnavailableException": {
  96. "base": "<p>The service is temporarily unavailable.</p>",
  97. "refs": {
  98. }
  99. },
  100. "ThingName": {
  101. "base": null,
  102. "refs": {
  103. "DeleteThingShadowRequest$thingName": "<p>The name of the thing.</p>",
  104. "GetThingShadowRequest$thingName": "<p>The name of the thing.</p>",
  105. "UpdateThingShadowRequest$thingName": "<p>The name of the thing.</p>"
  106. }
  107. },
  108. "ThrottlingException": {
  109. "base": "<p>The rate exceeds the limit.</p>",
  110. "refs": {
  111. }
  112. },
  113. "Topic": {
  114. "base": null,
  115. "refs": {
  116. "PublishRequest$topic": "<p>The name of the MQTT topic.</p>"
  117. }
  118. },
  119. "UnauthorizedException": {
  120. "base": "<p>You are not authorized to perform this operation.</p>",
  121. "refs": {
  122. }
  123. },
  124. "UnsupportedDocumentEncodingException": {
  125. "base": "<p>The document encoding is not supported.</p>",
  126. "refs": {
  127. }
  128. },
  129. "UpdateThingShadowRequest": {
  130. "base": "<p>The input for the UpdateThingShadow operation.</p>",
  131. "refs": {
  132. }
  133. },
  134. "UpdateThingShadowResponse": {
  135. "base": "<p>The output from the UpdateThingShadow operation.</p>",
  136. "refs": {
  137. }
  138. },
  139. "errorMessage": {
  140. "base": null,
  141. "refs": {
  142. "InternalFailureException$message": "<p>The message for the exception.</p>",
  143. "InvalidRequestException$message": "<p>The message for the exception.</p>",
  144. "ResourceNotFoundException$message": "<p>The message for the exception.</p>",
  145. "ServiceUnavailableException$message": "<p>The message for the exception.</p>",
  146. "ThrottlingException$message": "<p>The message for the exception.</p>",
  147. "UnauthorizedException$message": "<p>The message for the exception.</p>",
  148. "UnsupportedDocumentEncodingException$message": "<p>The message for the exception.</p>"
  149. }
  150. }
  151. }
  152. }