Expand description
AWS 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. AWS 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.
AWS IoT Analytics automates the steps required to analyze data from IoT devices. AWS 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. AWS 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.
If you’re using the service, you’re probably looking for IotAnalyticsClient and IotAnalytics.
Structs§
- AddAttributes
Activity An activity that adds other attributes based on existing attributes in the message.
- Batch
PutMessage Error Entry Contains informations about errors.
- Batch
PutMessage Request - Batch
PutMessage Response - Cancel
Pipeline Reprocessing Request - Cancel
Pipeline Reprocessing Response - Channel
A collection of data from an MQTT topic. Channels archive the raw, unprocessed messages before publishing the data to a pipeline.
- Channel
Activity The activity that determines the source of the messages to be processed.
- Channel
Messages Specifies one or more sets of channel messages.
- Channel
Statistics Statistics information about the channel.
- Channel
Storage Where channel data is stored. You may choose one of
serviceManagedS3orcustomerManagedS3storage. If not specified, the default isserviceManagedS3. This cannot be changed after creation of the channel.- Channel
Storage Summary Where channel data is stored.
- Channel
Summary A summary of information about a channel.
- Column
Contains information about a column that stores your data.
- Container
Dataset Action Information required to run the
containerActionto produce dataset contents.- Create
Channel Request - Create
Channel Response - Create
Dataset Content Request - Create
Dataset Content Response - Create
Dataset Request - Create
Dataset Response - Create
Datastore Request - Create
Datastore Response - Create
Pipeline Request - Create
Pipeline Response - Customer
Managed Channel S3Storage Use this to store channel data in an S3 bucket that you manage. If customer managed storage is selected, the
retentionPeriodparameter is ignored. You cannot change the choice of service-managed or customer-managed S3 storage after the channel is created.- Customer
Managed Channel S3Storage Summary Used to store channel data in an S3 bucket that you manage.
- Customer
Managed Datastore S3Storage Use this to store data store data in an S3 bucket that you manage. When customer-managed storage is selected, the
retentionPeriodparameter is ignored. You cannot change the choice of service-managed or customer-managed S3 storage after the data store is created.- Customer
Managed Datastore S3Storage Summary Used to store data store data in an S3 bucket that you manage.
- Dataset
Information about a data set.
- Dataset
Action A
DatasetActionobject that specifies how data set contents are automatically created.- Dataset
Action Summary Information about the action that automatically creates the dataset's contents.
- Dataset
Content Delivery Destination The destination to which dataset contents are delivered.
- Dataset
Content Delivery Rule When dataset contents are created, they are delivered to destination specified here.
- Dataset
Content Status The state of the data set contents and the reason they are in this state.
- Dataset
Content Summary Summary information about dataset contents.
- Dataset
Content Version Value The dataset whose latest contents are used as input to the notebook or application.
- Dataset
Entry The reference to a data set entry.
- Dataset
Summary A summary of information about a data set.
- Dataset
Trigger The
DatasetTriggerthat specifies when the data set is automatically updated.- Datastore
Information about a data store.
- Datastore
Activity The datastore activity that specifies where to store the processed data.
- Datastore
Partition A single partition in a data store.
- Datastore
Partitions Contains information about partitions in a data store.
- Datastore
Statistics Statistical information about the data store.
- Datastore
Storage Where data store data is stored. You can choose one of
serviceManagedS3orcustomerManagedS3storage. If not specified, the default isserviceManagedS3. You cannot change this storage option after the data store is created.- Datastore
Storage Summary Where data store data is stored.
- Datastore
Summary A summary of information about a data store.
- Delete
Channel Request - Delete
Dataset Content Request - Delete
Dataset Request - Delete
Datastore Request - Delete
Pipeline Request - Delta
Time Used to limit data to that which has arrived since the last execution of the action.
- Delta
Time Session Window Configuration A structure that contains the configuration information of a delta time session window.
DeltaTimespecifies a time interval. You can useDeltaTimeto create dataset contents with data that has arrived in the data store since the last execution. For an example ofDeltaTime, see Creating a SQL dataset with a delta window (CLI) in the AWS IoT Analytics User Guide.- Describe
Channel Request - Describe
Channel Response - Describe
Dataset Request - Describe
Dataset Response - Describe
Datastore Request - Describe
Datastore Response - Describe
Logging Options Request - Describe
Logging Options Response - Describe
Pipeline Request - Describe
Pipeline Response - Device
Registry Enrich Activity An activity that adds data from the AWS IoT device registry to your message.
- Device
Shadow Enrich Activity An activity that adds information from the AWS IoT Device Shadow service to a message.
- Estimated
Resource Size The estimated size of the resource.
- File
Format Configuration Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON and Parquet.
The default file format is JSON. You can specify only one format.
You can't change the file format after you create the data store.
- Filter
Activity An activity that filters a message based on its attributes.
- GetDataset
Content Request - GetDataset
Content Response - Glue
Configuration Configuration information for coordination with AWS Glue, a fully managed extract, transform and load (ETL) service.
- IotAnalytics
Client - A client for the AWS IoT Analytics API.
- IotEvents
Destination Configuration Configuration information for delivery of dataset contents to AWS IoT Events.
- Json
Configuration Contains the configuration information of the JSON format.
- Lambda
Activity An activity that runs a Lambda function to modify the message.
- Late
Data Rule A structure that contains the name and configuration information of a late data rule.
- Late
Data Rule Configuration The information needed to configure a delta time session window.
- List
Channels Request - List
Channels Response - List
Dataset Contents Request - List
Dataset Contents Response - List
Datasets Request - List
Datasets Response - List
Datastores Request - List
Datastores Response - List
Pipelines Request - List
Pipelines Response - List
Tags ForResource Request - List
Tags ForResource Response - Logging
Options Information about logging options.
- Math
Activity An activity that computes an arithmetic expression using the message's attributes.
- Message
Information about a message.
- Output
File UriValue The value of the variable as a structure that specifies an output file URI.
- Parquet
Configuration Contains the configuration information of the Parquet format.
- Partition
A single partition.
- Pipeline
Contains information about a pipeline.
- Pipeline
Activity An activity that performs a transformation on a message.
- Pipeline
Summary A summary of information about a pipeline.
- PutLogging
Options Request - Query
Filter Information that is used to filter message data, to segregate it according to the timeframe in which it arrives.
- Remove
Attributes Activity An activity that removes attributes from a message.
- Reprocessing
Summary Information about pipeline reprocessing.
- Resource
Configuration The configuration of the resource used to execute the
containerAction.- Retention
Period How long, in days, message data is kept.
- RunPipeline
Activity Request - RunPipeline
Activity Response - S3Destination
Configuration Configuration information for delivery of dataset contents to Amazon Simple Storage Service (Amazon S3).
- Sample
Channel Data Request - Sample
Channel Data Response - Schedule
The schedule for when to trigger an update.
- Schema
Definition Information needed to define a schema.
- Select
Attributes Activity Creates a new message using only the specified attributes from the original message.
- Service
Managed Channel S3Storage Use this to store channel data in an S3 bucket managed by AWS IoT Analytics. You cannot change the choice of service-managed or customer-managed S3 storage after the channel is created.
- Service
Managed Channel S3Storage Summary Used to store channel data in an S3 bucket managed by AWS IoT Analytics.
- Service
Managed Datastore S3Storage Use this to store data store data in an S3 bucket managed by AWS IoT Analytics. You cannot change the choice of service-managed or customer-managed S3 storage after the data store is created.
- Service
Managed Datastore S3Storage Summary Used to store data store data in an S3 bucket managed by AWS IoT Analytics.
- SqlQuery
Dataset Action The SQL query to modify the message.
- Start
Pipeline Reprocessing Request - Start
Pipeline Reprocessing Response - Tag
A set of key-value pairs that are used to manage the resource.
- TagResource
Request - TagResource
Response - Timestamp
Partition A partition defined by a timestamp.
- Triggering
Dataset Information about the dataset whose content generation triggers the new dataset content generation.
- Untag
Resource Request - Untag
Resource Response - Update
Channel Request - Update
Dataset Request - Update
Datastore Request - Update
Pipeline Request - Variable
An instance of a variable to be passed to the
containerActionexecution. Each variable must have a name and a value given by one ofstringValue,datasetContentVersionValue, oroutputFileUriValue.- Versioning
Configuration Information about the versioning of dataset contents.
Enums§
- Batch
PutMessage Error - Errors returned by BatchPutMessage
- Cancel
Pipeline Reprocessing Error - Errors returned by CancelPipelineReprocessing
- Create
Channel Error - Errors returned by CreateChannel
- Create
Dataset Content Error - Errors returned by CreateDatasetContent
- Create
Dataset Error - Errors returned by CreateDataset
- Create
Datastore Error - Errors returned by CreateDatastore
- Create
Pipeline Error - Errors returned by CreatePipeline
- Delete
Channel Error - Errors returned by DeleteChannel
- Delete
Dataset Content Error - Errors returned by DeleteDatasetContent
- Delete
Dataset Error - Errors returned by DeleteDataset
- Delete
Datastore Error - Errors returned by DeleteDatastore
- Delete
Pipeline Error - Errors returned by DeletePipeline
- Describe
Channel Error - Errors returned by DescribeChannel
- Describe
Dataset Error - Errors returned by DescribeDataset
- Describe
Datastore Error - Errors returned by DescribeDatastore
- Describe
Logging Options Error - Errors returned by DescribeLoggingOptions
- Describe
Pipeline Error - Errors returned by DescribePipeline
- GetDataset
Content Error - Errors returned by GetDatasetContent
- List
Channels Error - Errors returned by ListChannels
- List
Dataset Contents Error - Errors returned by ListDatasetContents
- List
Datasets Error - Errors returned by ListDatasets
- List
Datastores Error - Errors returned by ListDatastores
- List
Pipelines Error - Errors returned by ListPipelines
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- PutLogging
Options Error - Errors returned by PutLoggingOptions
- RunPipeline
Activity Error - Errors returned by RunPipelineActivity
- Sample
Channel Data Error - Errors returned by SampleChannelData
- Start
Pipeline Reprocessing Error - Errors returned by StartPipelineReprocessing
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
Channel Error - Errors returned by UpdateChannel
- Update
Dataset Error - Errors returned by UpdateDataset
- Update
Datastore Error - Errors returned by UpdateDatastore
- Update
Pipeline Error - Errors returned by UpdatePipeline
Traits§
- IotAnalytics
- Trait representing the capabilities of the AWS IoT Analytics API. AWS IoT Analytics clients implement this trait.