# AWS IoT Analytics API

> AWS IoT Analytics API on Apizie: 34 endpoints (Sends messages to a channel., Cancels the reprocessing of data through the pipeline., Retrieves a list of channels., Used to create a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed…, …) 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-iotanalytics/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

IoT Analytics allows you to collect large amounts of device data, process messages, and store them. You can then query the data and run sophisticated analytics on it. IoT Analytics enables advanced data exploration…

## Endpoints

### Sends messages to a channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/batch-put-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Cancels the reprocessing of data through the pipeline.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/cancel-pipeline-reprocessing` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| pipelineName | string | yes | The name of pipeline for which data reprocessing is canceled. |
| reprocessingId | string | yes | The ID of the reprocessing task (returned by StartPipelineReprocessing ). |

### Retrieves a list of channels.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/list-channels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| nextToken | string | no | The token for the next set of results. |
| maxResults | integer | no | The maximum number of results to return in this request. The default value is 100. |

### Used to create a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/create-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Retrieves information about datasets.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/list-datasets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| nextToken | string | no | The token for the next set of results. |
| maxResults | integer | no | The maximum number of results to return in this request. The default value is 100. |

### Used to create a dataset. A dataset stores data retrieved from a data store by applying a queryAction (a SQL…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/create-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Retrieves the contents of a dataset as presigned URIs.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/get-dataset-content` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| datasetName | string | yes | The name of the dataset whose contents are retrieved. |
| versionId | string | no | The version of the dataset whose contents are retrieved. You can also use the strings "$LATEST" or "$LATEST_SUCCEEDED" to retrieve the… |

### Creates the content of a dataset by applying a queryAction (a SQL query) or a containerAction (executing a…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/create-dataset-content` (byok)

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

### Deletes the content of the specified dataset.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/delete-dataset-content` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| datasetName | string | yes | The name of the dataset whose content is deleted. |
| versionId | string | no | The version of the dataset whose content is deleted. You can also use the strings "$LATEST" or "$LATEST_SUCCEEDED" to delete the latest or… |

### Retrieves a list of data stores.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/list-datastores` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| nextToken | string | no | The token for the next set of results. |
| maxResults | integer | no | The maximum number of results to return in this request. The default value is 100. |

### Creates a data store, which is a repository for messages.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/create-datastore` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Retrieves a list of pipelines.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/list-pipelines` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| nextToken | string | no | The token for the next set of results. |
| maxResults | integer | no | The maximum number of results to return in this request. The default value is 100. |

### Creates a pipeline. A pipeline consumes messages from a channel and allows you to process the messages…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/create-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Retrieves information about a channel.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/describe-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| channelName | string | yes | The name of the channel whose information is retrieved. |
| includeStatistics | boolean | no | If true, additional statistical information about the channel is included in the response. This feature can't be used with a channel whose… |

### Used to update the settings of a channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/update-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| channelName | string | yes | The name of the channel to be updated. |
| body | object | yes | JSON request body |

### Deletes the specified channel.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/delete-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| channelName | string | yes | The name of the channel to delete. |

### Retrieves information about a dataset.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/describe-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| datasetName | string | yes | The name of the dataset whose information is retrieved. |

### Updates the settings of a dataset.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/update-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| datasetName | string | yes | The name of the dataset to update. |
| body | object | yes | JSON request body |

### Deletes the specified dataset. You do not have to delete the content of the dataset before you perform this…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/delete-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| datasetName | string | yes | The name of the dataset to delete. |

### Retrieves information about a data store.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/describe-datastore` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| datastoreName | string | yes | The name of the data store |
| includeStatistics | boolean | no | If true, additional statistical information about the data store is included in the response. This feature can't be used with a data store… |

### Used to update the settings of a data store.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/update-datastore` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| datastoreName | string | yes | The name of the data store to be updated. |
| body | object | yes | JSON request body |

### Deletes the specified data store.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/delete-datastore` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| datastoreName | string | yes | The name of the data store to delete. |

### Retrieves information about a pipeline.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/describe-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| pipelineName | string | yes | The name of the pipeline whose information is retrieved. |

### Updates the settings of a pipeline. You must specify both a channel and a datastore activity and,…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/update-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| pipelineName | string | yes | The name of the pipeline to update. |
| body | object | yes | JSON request body |

### Deletes the specified pipeline.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/delete-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| pipelineName | string | yes | The name of the pipeline to delete. |

### Retrieves the current settings of the IoT Analytics logging options.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/describe-logging-options` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |

### Sets or updates the IoT Analytics logging options. If you update the value of any loggingOptions field, it…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/put-logging-options` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Lists information about dataset contents that have been created.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/list-dataset-contents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| datasetName | string | yes | The name of the dataset whose contents information you want to list. |
| nextToken | string | no | The token for the next set of results. |
| maxResults | integer | no | The maximum number of results to return in this request. |
| scheduledOnOrAfter | string | no | A filter to limit results to those dataset contents whose creation is scheduled on or after the given time. See the field… |
| scheduledBefore | string | no | A filter to limit results to those dataset contents whose creation is scheduled before the given time. See the field triggers.schedule in… |

### Lists the tags (metadata) that you have assigned to the resource.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/list-tags-for-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The ARN of the resource whose tags you want to list. |

### Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/tag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The ARN of the resource whose tags you want to modify. |
| body | object | yes | JSON request body |

### Simulates the results of running a pipeline activity on a message payload.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/run-pipeline-activity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/sample-channel-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| channelName | string | yes | The name of the channel whose message samples are retrieved. |
| maxMessages | integer | no | The number of sample messages to be retrieved. The limit is 10. The default is also 10. |
| startTime | string | no | The start of the time window from which sample messages are retrieved. |
| endTime | string | no | The end of the time window from which sample messages are retrieved. |

### Starts the reprocessing of raw message data through the pipeline.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/start-pipeline-reprocessing` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| pipelineName | string | yes | The name of the pipeline on which to start reprocessing. |
| body | object | yes | JSON request body |

### Removes the given tags (metadata) from the resource.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/untag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The ARN of the resource whose tags you want to remove. |
| tagKeys | array | yes | The keys of those tags which you want to remove. |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/batch-put-message" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the AWS IoT Analytics API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotanalytics/batch-put-message with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the AWS IoT Analytics 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-iotanalytics.

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