Amazon Web Services, Inc.

AWS IoT Analytics

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…

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 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 through integration with Jupyter Notebooks and data visualization through integration with Amazon QuickSight. Traditional analytics and business intelligence tools are designed to process structured data. IoT data often comes from devices that record noisy processes (such as temperature, motion, or sound). As a result the data from these devices can have significant gaps, corrupted messages, and false readings that must be cleaned up before analysis can occur. Also, IoT data is often only meaningful in the context of other data from external sources. IoT Analytics automates the steps required to analyze data from IoT devices. IoT Analytics filters, transforms, and enriches IoT data before storing it in a time-series data store for analysis. You can set up the service to collect only the data you need from your devices, apply mathematical transforms to process the data, and enrich the data with device-specific metadata such as device type and location before storing it. Then, you can analyze your data by running queries using the built-in SQL query engine, or perform more complex analytics and machine learning inference. IoT Analytics includes pre-built models for common IoT use cases so you can answer questions like which devices are about to fail or which customers are at risk of abandoning their wearable devices.

Endpoints 34

  • POSTBatchPutMessage/messages/batchSends messages to a channel.
  • DELETECancelPipelineReprocessing/pipelines/:pipelineName/reprocessing/:reprocessingIdCancels the reprocessing of data through the pipeline.
  • GETListChannels/channels?nextToken=string&maxResults=1Retrieves a list of channels.
  • POSTCreateChannel/channelsUsed to create a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.
  • GETListDatasets/datasets?nextToken=string&maxResults=1Retrieves information about datasets.
  • POSTCreateDataset/datasetsUsed to create a dataset. A dataset stores data retrieved from a data store by applying a <code>queryAction</code> (a SQL query) or a…
  • GETGetDatasetContent/datasets/:datasetName/content?versionId=stringRetrieves the contents of a dataset as presigned URIs.
  • POSTCreateDatasetContent/datasets/:datasetName/contentCreates the content of a dataset by applying a <code>queryAction</code> (a SQL query) or a <code>containerAction</code> (executing a containerized application).
  • DELETEDeleteDatasetContent/datasets/:datasetName/content?versionId=stringDeletes the content of the specified dataset.
  • GETListDatastores/datastores?nextToken=string&maxResults=1Retrieves a list of data stores.
  • POSTCreateDatastore/datastoresCreates a data store, which is a repository for messages.
  • GETListPipelines/pipelines?nextToken=string&maxResults=1Retrieves a list of pipelines.
  • POSTCreatePipeline/pipelinesCreates a pipeline. A pipeline consumes messages from a channel and allows you to process the messages before storing them in a data store. You must specify…
  • GETDescribeChannel/channels/:channelName?includeStatistics=trueRetrieves information about a channel.
  • PUTUpdateChannel/channels/:channelNameUsed to update the settings of a channel.
  • DELETEDeleteChannel/channels/:channelNameDeletes the specified channel.
  • GETDescribeDataset/datasets/:datasetNameRetrieves information about a dataset.
  • PUTUpdateDataset/datasets/:datasetNameUpdates the settings of a dataset.
  • DELETEDeleteDataset/datasets/:datasetName<p>Deletes the specified dataset.</p> <p>You do not have to delete the content of the dataset before you perform this operation.</p>
  • GETDescribeDatastore/datastores/:datastoreName?includeStatistics=trueRetrieves information about a data store.
  • PUTUpdateDatastore/datastores/:datastoreNameUsed to update the settings of a data store.
  • DELETEDeleteDatastore/datastores/:datastoreNameDeletes the specified data store.
  • GETDescribePipeline/pipelines/:pipelineNameRetrieves information about a pipeline.
  • PUTUpdatePipeline/pipelines/:pipelineNameUpdates the settings of a pipeline. You must specify both a <code>channel</code> and a <code>datastore</code> activity and, optionally, as many as 23…
  • DELETEDeletePipeline/pipelines/:pipelineNameDeletes the specified pipeline.
  • GETDescribeLoggingOptions/loggingRetrieves the current settings of the IoT Analytics logging options.
  • PUTPutLoggingOptions/logging<p>Sets or updates the IoT Analytics logging options.</p> <p>If you update the value of any <code>loggingOptions</code> field, it takes up to one minute for…
  • GETListDatasetContents/datasets/:datasetName/contents?nextToken=string&maxResults=1&scheduledOnOrAfter=2024-01-01T00:00:00Z&scheduledBefore=2024-01-01T00:00:00ZLists information about dataset contents that have been created.
  • GETListTagsForResource/tags#resourceArn?resourceArn=stringLists the tags (metadata) that you have assigned to the resource.
  • POSTTagResource/tags#resourceArn?resourceArn=stringAdds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
  • POSTRunPipelineActivity/pipelineactivities/runSimulates the results of running a pipeline activity on a message payload.
  • GETSampleChannelData/channels/:channelName/sample?maxMessages=1&startTime=2024-01-01T00:00:00Z&endTime=2024-01-01T00:00:00ZRetrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10 messages can be retrieved.
  • POSTStartPipelineReprocessing/pipelines/:pipelineName/reprocessingStarts the reprocessing of raw message data through the pipeline.
  • DELETEUntagResource/tags#resourceArn&tagKeys?resourceArn=string&tagKeys=stringRemoves the given tags (metadata) from the resource.

API details

Base URL
http://iotanalytics.{region}.amazonaws.com
https://iotanalytics.{region}.amazonaws.com
http://iotanalytics.{region}.amazonaws.com.cn
https://iotanalytics.{region}.amazonaws.com.cn
Authentication
An API key in the Authorization header
Operations
34 operations on 18 pathsGET 13POST 9DELETE 7PUT 5
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 2017-11-27
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the AWS IoT Analytics 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 Analytics collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “BatchPutMessage” (POST /messages/batch), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS IoT Analytics?

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… It is listed under Data & analytics and has 34 endpoints.

Who publishes the AWS IoT Analytics?

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 Analytics?

Its description lists 4 base URLs: http://iotanalytics.{region}.amazonaws.com, https://iotanalytics.{region}.amazonaws.com, http://iotanalytics.{region}.amazonaws.com.cn, https://iotanalytics.{region}.amazonaws.com.cn. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the AWS IoT Analytics?

With an API key in the Authorization header.

How many endpoints does the AWS IoT Analytics have?

34 operations on 18 paths (13 GET, 9 POST, 7 DELETE, 5 PUT).

Is forking the AWS IoT Analytics 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.