# AWS IoT Data Plane API

> AWS IoT Data Plane API on Apizie: 7 endpoints (Gets the shadow for the specified thing. Requires permission to access the GetThingShadow action. For more…, Updates the shadow for the specified thing. Requires permission to access the UpdateThingShadow action. For…, Deletes the shadow for the specified thing. Requires permission to access the DeleteThingShadow action. For…, Gets the details of a single retained message for the specified topic. This action returns the message…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:amazonaws-iot-data/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-iot-data`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://zieapi.vercel.app/api/cloud/amazonaws-iot-data
- OpenAPI: https://zieapi.vercel.app/api/cloud/amazonaws-iot-data/openapi.json

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…

## Endpoints

### Gets the shadow for the specified thing. Requires permission to access the GetThingShadow action. For more…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iot-data/get-thing-shadow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| thingName | string | yes | The name of the thing. |
| name | string | no | The name of the shadow. |

### Updates the shadow for the specified thing. Requires permission to access the UpdateThingShadow action. For…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iot-data/update-thing-shadow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| thingName | string | yes | The name of the thing. |
| name | string | no | The name of the shadow. |
| body | object | yes | JSON request body |

### Deletes the shadow for the specified thing. Requires permission to access the DeleteThingShadow action. For…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iot-data/delete-thing-shadow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| thingName | string | yes | The name of the thing. |
| name | string | no | The name of the shadow. |

### Gets the details of a single retained message for the specified topic. This action returns the message…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iot-data/get-retained-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| topic | string | yes | The topic name of the retained message to retrieve. |

### Lists the shadows for the specified thing. Requires permission to access the ListNamedShadowsForThing action.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iot-data/list-named-shadows-for-thing` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| thingName | string | yes | The name of the thing. |
| nextToken | string | no | The token to retrieve the next set of results. |
| pageSize | integer | no | The result page size. |

### Lists summary information about the retained messages stored for the account. This action returns only the…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iot-data/list-retained-messages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| nextToken | string | no | To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results. |
| maxResults | integer | no | The maximum number of results to return at one time. |

### Publishes an MQTT message. Requires permission to access the Publish action. For more information about MQTT…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iot-data/publish` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| topic | string | yes | The name of the MQTT topic. |
| qos | integer | no | The Quality of Service (QoS) level. The default QoS level is 0. |
| retain | boolean | no | A Boolean value that determines whether to set the RETAIN flag when the message is published. Setting the RETAIN flag causes the message… |
| x-amz-mqtt5-user-properties | string | no | A JSON string that contains an array of JSON objects. If you don’t use Amazon Web Services SDK or CLI, you must encode the JSON string to… |
| x-amz-mqtt5-payload-format-indicator | string | no | An Enum string value that indicates whether the payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API. |
| contentType | string | no | A UTF-8 encoded string that describes the content of the publishing message. |
| responseTopic | string | no | A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic which the… |
| x-amz-mqtt5-correlation-data | string | no | The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's… |
| messageExpiry | integer | no | A user-defined integer value that represents the message expiry interval in seconds. If absent, the message doesn't expire. For more… |
| body | object | yes | JSON request body |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:amazonaws-iot-data/get-thing-shadow" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the AWS IoT Data Plane API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/cloud:amazonaws-iot-data/get-thing-shadow with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the AWS IoT Data Plane API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. AWS IoT Data Plane itself also needs your own key from amazonaws.com.

### Can AI agents use the AWS IoT Data Plane API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-iot-data.

### What is the status of the AWS IoT Data Plane API?
Needs your own provider key (bring your own key)