github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/iot-data/2015-05-28/docs-2.json (about)

     1  {
     2    "version": "2.0",
     3    "service": "<fullname>IoT data</fullname> <p>IoT data enables secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud. It implements a broker for applications and things to publish messages over HTTP (Publish) and retrieve, update, and delete shadows. A shadow is a persistent representation of your things and their state in the Amazon Web Services cloud.</p> <p>Find the endpoint address for actions in IoT data by running this CLI command:</p> <p> <code>aws iot describe-endpoint --endpoint-type iot:Data-ATS</code> </p> <p>The service name used by <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Amazon Web ServicesSignature Version 4</a> to sign requests is: <i>iotdevicegateway</i>.</p>",
     4    "operations": {
     5      "DeleteThingShadow": "<p>Deletes the shadow for the specified thing.</p> <p>Requires permission to access the <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions\">DeleteThingShadow</a> action.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/API_DeleteThingShadow.html\">DeleteThingShadow</a> in the IoT Developer Guide.</p>",
     6      "GetRetainedMessage": "<p>Gets the details of a single retained message for the specified topic.</p> <p>This action returns the message payload of the retained message, which can incur messaging costs. To list only the topic names of the retained messages, call <a href=\"/iot/latest/developerguide/API_iotdata_ListRetainedMessages.html\">ListRetainedMessages</a>.</p> <p>Requires permission to access the <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotfleethubfordevicemanagement.html#awsiotfleethubfordevicemanagement-actions-as-permissions\">GetRetainedMessage</a> action.</p> <p>For more information about messaging costs, see <a href=\"http://aws.amazon.com/iot-core/pricing/#Messaging\">IoT Core pricing - Messaging</a>.</p>",
     7      "GetThingShadow": "<p>Gets the shadow for the specified thing.</p> <p>Requires permission to access the <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions\">GetThingShadow</a> action.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/API_GetThingShadow.html\">GetThingShadow</a> in the IoT Developer Guide.</p>",
     8      "ListNamedShadowsForThing": "<p>Lists the shadows for the specified thing.</p> <p>Requires permission to access the <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions\">ListNamedShadowsForThing</a> action.</p>",
     9      "ListRetainedMessages": "<p>Lists summary information about the retained messages stored for the account.</p> <p>This action returns only the topic names of the retained messages. It doesn't return any message payloads. Although this action doesn't return a message payload, it can still incur messaging costs.</p> <p>To get the message payload of a retained message, call <a href=\"https://docs.aws.amazon.com/iot/latest/developerguide/API_iotdata_GetRetainedMessage.html\">GetRetainedMessage</a> with the topic name of the retained message.</p> <p>Requires permission to access the <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotfleethubfordevicemanagement.html#awsiotfleethubfordevicemanagement-actions-as-permissions\">ListRetainedMessages</a> action.</p> <p>For more information about messaging costs, see <a href=\"http://aws.amazon.com/iot-core/pricing/#Messaging\">IoT Core pricing - Messaging</a>.</p>",
    10      "Publish": "<p>Publishes an MQTT message.</p> <p>Requires permission to access the <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions\">Publish</a> action.</p> <p>For more information about MQTT messages, see <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html\">MQTT Protocol</a> in the IoT Developer Guide.</p> <p>For more information about messaging costs, see <a href=\"http://aws.amazon.com/iot-core/pricing/#Messaging\">IoT Core pricing - Messaging</a>.</p>",
    11      "UpdateThingShadow": "<p>Updates the shadow for the specified thing.</p> <p>Requires permission to access the <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions\">UpdateThingShadow</a> action.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/API_UpdateThingShadow.html\">UpdateThingShadow</a> in the IoT Developer Guide.</p>"
    12    },
    13    "shapes": {
    14      "ConflictException": {
    15        "base": "<p>The specified version does not match the version of the document.</p>",
    16        "refs": {
    17        }
    18      },
    19      "DeleteThingShadowRequest": {
    20        "base": "<p>The input for the DeleteThingShadow operation.</p>",
    21        "refs": {
    22        }
    23      },
    24      "DeleteThingShadowResponse": {
    25        "base": "<p>The output from the DeleteThingShadow operation.</p>",
    26        "refs": {
    27        }
    28      },
    29      "GetRetainedMessageRequest": {
    30        "base": "<p>The input for the GetRetainedMessage operation.</p>",
    31        "refs": {
    32        }
    33      },
    34      "GetRetainedMessageResponse": {
    35        "base": "<p>The output from the GetRetainedMessage operation.</p>",
    36        "refs": {
    37        }
    38      },
    39      "GetThingShadowRequest": {
    40        "base": "<p>The input for the GetThingShadow operation.</p>",
    41        "refs": {
    42        }
    43      },
    44      "GetThingShadowResponse": {
    45        "base": "<p>The output from the GetThingShadow operation.</p>",
    46        "refs": {
    47        }
    48      },
    49      "InternalFailureException": {
    50        "base": "<p>An unexpected error has occurred.</p>",
    51        "refs": {
    52        }
    53      },
    54      "InvalidRequestException": {
    55        "base": "<p>The request is not valid.</p>",
    56        "refs": {
    57        }
    58      },
    59      "JsonDocument": {
    60        "base": null,
    61        "refs": {
    62          "DeleteThingShadowResponse$payload": "<p>The state information, in JSON format.</p>",
    63          "GetThingShadowResponse$payload": "<p>The state information, in JSON format.</p>",
    64          "UpdateThingShadowRequest$payload": "<p>The state information, in JSON format.</p>",
    65          "UpdateThingShadowResponse$payload": "<p>The state information, in JSON format.</p>"
    66        }
    67      },
    68      "ListNamedShadowsForThingRequest": {
    69        "base": null,
    70        "refs": {
    71        }
    72      },
    73      "ListNamedShadowsForThingResponse": {
    74        "base": null,
    75        "refs": {
    76        }
    77      },
    78      "ListRetainedMessagesRequest": {
    79        "base": null,
    80        "refs": {
    81        }
    82      },
    83      "ListRetainedMessagesResponse": {
    84        "base": null,
    85        "refs": {
    86        }
    87      },
    88      "MaxResults": {
    89        "base": null,
    90        "refs": {
    91          "ListRetainedMessagesRequest$maxResults": "<p>The maximum number of results to return at one time.</p>"
    92        }
    93      },
    94      "MethodNotAllowedException": {
    95        "base": "<p>The specified combination of HTTP verb and URI is not supported.</p>",
    96        "refs": {
    97        }
    98      },
    99      "NamedShadowList": {
   100        "base": null,
   101        "refs": {
   102          "ListNamedShadowsForThingResponse$results": "<p>The list of shadows for the specified thing.</p>"
   103        }
   104      },
   105      "NextToken": {
   106        "base": null,
   107        "refs": {
   108          "ListNamedShadowsForThingRequest$nextToken": "<p>The token to retrieve the next set of results.</p>",
   109          "ListNamedShadowsForThingResponse$nextToken": "<p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>",
   110          "ListRetainedMessagesRequest$nextToken": "<p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response; otherwise <b>null</b> to receive the first set of results.</p>",
   111          "ListRetainedMessagesResponse$nextToken": "<p>The token for the next set of results, or null if there are no additional results.</p>"
   112        }
   113      },
   114      "PageSize": {
   115        "base": null,
   116        "refs": {
   117          "ListNamedShadowsForThingRequest$pageSize": "<p>The result page size.</p>"
   118        }
   119      },
   120      "Payload": {
   121        "base": null,
   122        "refs": {
   123          "GetRetainedMessageResponse$payload": "<p>The Base64-encoded message payload of the retained message body.</p>",
   124          "PublishRequest$payload": "<p>The message body. MQTT accepts text, binary, and empty (null) message payloads.</p> <p>Publishing an empty (null) payload with <b>retain</b> = <code>true</code> deletes the retained message identified by <b>topic</b> from IoT Core.</p>"
   125        }
   126      },
   127      "PayloadSize": {
   128        "base": null,
   129        "refs": {
   130          "RetainedMessageSummary$payloadSize": "<p>The size of the retained message's payload in bytes.</p>"
   131        }
   132      },
   133      "PublishRequest": {
   134        "base": "<p>The input for the Publish operation.</p>",
   135        "refs": {
   136        }
   137      },
   138      "Qos": {
   139        "base": null,
   140        "refs": {
   141          "GetRetainedMessageResponse$qos": "<p>The quality of service (QoS) level used to publish the retained message.</p>",
   142          "PublishRequest$qos": "<p>The Quality of Service (QoS) level.</p>",
   143          "RetainedMessageSummary$qos": "<p>The quality of service (QoS) level used to publish the retained message.</p>"
   144        }
   145      },
   146      "RequestEntityTooLargeException": {
   147        "base": "<p>The payload exceeds the maximum size allowed.</p>",
   148        "refs": {
   149        }
   150      },
   151      "ResourceNotFoundException": {
   152        "base": "<p>The specified resource does not exist.</p>",
   153        "refs": {
   154        }
   155      },
   156      "Retain": {
   157        "base": null,
   158        "refs": {
   159          "PublishRequest$retain": "<p>A Boolean value that determines whether to set the RETAIN flag when the message is published.</p> <p>Setting the RETAIN flag causes the message to be retained and sent to new subscribers to the topic.</p> <p>Valid values: <code>true</code> | <code>false</code> </p> <p>Default value: <code>false</code> </p>"
   160        }
   161      },
   162      "RetainedMessageList": {
   163        "base": null,
   164        "refs": {
   165          "ListRetainedMessagesResponse$retainedTopics": "<p>A summary list the account's retained messages. The information returned doesn't include the message payloads of the retained messages.</p>"
   166        }
   167      },
   168      "RetainedMessageSummary": {
   169        "base": "<p>Information about a single retained message.</p>",
   170        "refs": {
   171          "RetainedMessageList$member": null
   172        }
   173      },
   174      "ServiceUnavailableException": {
   175        "base": "<p>The service is temporarily unavailable.</p>",
   176        "refs": {
   177        }
   178      },
   179      "ShadowName": {
   180        "base": null,
   181        "refs": {
   182          "DeleteThingShadowRequest$shadowName": "<p>The name of the shadow.</p>",
   183          "GetThingShadowRequest$shadowName": "<p>The name of the shadow.</p>",
   184          "NamedShadowList$member": null,
   185          "UpdateThingShadowRequest$shadowName": "<p>The name of the shadow.</p>"
   186        }
   187      },
   188      "ThingName": {
   189        "base": null,
   190        "refs": {
   191          "DeleteThingShadowRequest$thingName": "<p>The name of the thing.</p>",
   192          "GetThingShadowRequest$thingName": "<p>The name of the thing.</p>",
   193          "ListNamedShadowsForThingRequest$thingName": "<p>The name of the thing.</p>",
   194          "UpdateThingShadowRequest$thingName": "<p>The name of the thing.</p>"
   195        }
   196      },
   197      "ThrottlingException": {
   198        "base": "<p>The rate exceeds the limit.</p>",
   199        "refs": {
   200        }
   201      },
   202      "Timestamp": {
   203        "base": null,
   204        "refs": {
   205          "GetRetainedMessageResponse$lastModifiedTime": "<p>The Epoch date and time, in milliseconds, when the retained message was stored by IoT.</p>",
   206          "ListNamedShadowsForThingResponse$timestamp": "<p>The Epoch date and time the response was generated by IoT.</p>",
   207          "RetainedMessageSummary$lastModifiedTime": "<p>The Epoch date and time, in milliseconds, when the retained message was stored by IoT.</p>"
   208        }
   209      },
   210      "Topic": {
   211        "base": null,
   212        "refs": {
   213          "GetRetainedMessageRequest$topic": "<p>The topic name of the retained message to retrieve.</p>",
   214          "GetRetainedMessageResponse$topic": "<p>The topic name to which the retained message was published.</p>",
   215          "PublishRequest$topic": "<p>The name of the MQTT topic.</p>",
   216          "RetainedMessageSummary$topic": "<p>The topic name to which the retained message was published.</p>"
   217        }
   218      },
   219      "UnauthorizedException": {
   220        "base": "<p>You are not authorized to perform this operation.</p>",
   221        "refs": {
   222        }
   223      },
   224      "UnsupportedDocumentEncodingException": {
   225        "base": "<p>The document encoding is not supported.</p>",
   226        "refs": {
   227        }
   228      },
   229      "UpdateThingShadowRequest": {
   230        "base": "<p>The input for the UpdateThingShadow operation.</p>",
   231        "refs": {
   232        }
   233      },
   234      "UpdateThingShadowResponse": {
   235        "base": "<p>The output from the UpdateThingShadow operation.</p>",
   236        "refs": {
   237        }
   238      },
   239      "errorMessage": {
   240        "base": null,
   241        "refs": {
   242          "ConflictException$message": "<p>The message for the exception.</p>",
   243          "InternalFailureException$message": "<p>The message for the exception.</p>",
   244          "InvalidRequestException$message": "<p>The message for the exception.</p>",
   245          "MethodNotAllowedException$message": "<p>The message for the exception.</p>",
   246          "RequestEntityTooLargeException$message": "<p>The message for the exception.</p>",
   247          "ResourceNotFoundException$message": "<p>The message for the exception.</p>",
   248          "ServiceUnavailableException$message": "<p>The message for the exception.</p>",
   249          "ThrottlingException$message": "<p>The message for the exception.</p>",
   250          "UnauthorizedException$message": "<p>The message for the exception.</p>",
   251          "UnsupportedDocumentEncodingException$message": "<p>The message for the exception.</p>"
   252        }
   253      }
   254    }
   255  }