Amazon Web Services, Inc.

AWS IoT Data Plane

IoT data IoT data enables secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart…

Data & analytics#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

IoT data
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.
Find the endpoint address for actions in IoT data by running this CLI command:

aws iot describe-endpoint --endpoint-type iot:Data-ATS

The service name used by Amazon Web ServicesSignature Version 4
to sign requests is: iotdevicegateway .

Endpoints 11

  • GETGet connection/connections/:clientId?includeSocketInformation=trueRetrieves connection information for the specified MQTT client. Requires permission to access the GetConnection action.
  • DELETEDelete connection/connections/:clientId?cleanSession=true&preventWillMessage=trueDisconnects a connected MQTT client from Amazon Web Services IoT Core. When you disconnect a client, Amazon Web Services IoT Core closes the client's network…
  • GETGet thing shadow/things/:thingName/shadow?name=stringGets the shadow for the specified thing. Requires permission to access the GetThingShadow action. For more information, see GetThingShadow in the IoT…
  • POSTUpdate thing shadow/things/:thingName/shadow?name=stringUpdates the shadow for the specified thing. Requires permission to access the UpdateThingShadow action. For more information, see UpdateThingShadow in the IoT…
  • DELETEDelete thing shadow/things/:thingName/shadow?name=stringDeletes the shadow for the specified thing. Requires permission to access the DeleteThingShadow action. For more information, see DeleteThingShadow in the IoT…
  • GETGet retained message/retainedMessage/:topicGets the details of a single retained message for the specified topic. This action returns the message payload of the retained message, which can incur…
  • GETList named shadows for thing/api/things/shadow/ListNamedShadowsForThing/:thingName?nextToken=string&pageSize=0Lists the shadows for the specified thing. Requires permission to access the ListNamedShadowsForThing action.
  • GETList retained messages/retainedMessage?nextToken=string&maxResults=0Lists summary information about the retained messages stored for the account. This action returns only the topic names of the retained messages. It doesn't…
  • GETList subscriptions/connections/:clientId/subscriptions?nextToken=string&maxResults=0Returns a list of all subscriptions for MQTT clients with active sessions, including offline clients with persistent sessions. Requires permission to access…
  • POSTPublish/topics/:topic?qos=0&retain=truePublishes an MQTT message. Requires permission to access the Publish action. For more information about MQTT messages, see MQTT Protocol in the IoT Developer…
  • POSTSend direct message/connections/:clientId/messages?topic=string&contentType=string&responseTopic=string&confirmation=true&timeout=0Sends an MQTT message directly to a specific client identified by its client ID. SendDirectMessage targets a single client ID. The receiving client does not…

API details

Base URL
https://data-ats.iot.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
11 operations on 8 pathsGET 6POST 3DELETE 2
Description format
AWS Smithy model, API version 2015-05-28

How to test the AWS IoT Data Plane in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS IoT Data Plane collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get connection” (GET /connections/:clientId?includeSocketInformation=true), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS IoT Data Plane?

IoT data IoT data enables secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart… It is listed under Data & analytics and has 11 endpoints.

Who publishes the AWS IoT Data Plane?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS IoT Data Plane?

Requests go to https://data-ats.iot.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS IoT Data Plane?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS IoT Data Plane have?

11 operations on 8 paths (6 GET, 3 POST, 2 DELETE).

Is forking the AWS IoT Data Plane free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.