View Source AWS.IoTAnalytics (aws-elixir v1.0.0)
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.
Summary
Functions
Sends messages to a channel.
Cancels the reprocessing of data through the pipeline.
Used to create a channel.
Used to create a dataset.
Creates the content of a dataset by applying a queryAction (a SQL query) or a
containerAction (executing a containerized application).
Creates a data store, which is a repository for messages.
Creates a pipeline.
Deletes the specified channel.
Deletes the specified dataset.
Deletes the content of the specified dataset.
Deletes the specified data store.
Deletes the specified pipeline.
Retrieves information about a channel.
Retrieves information about a dataset.
Retrieves information about a data store.
Retrieves the current settings of the IoT Analytics logging options.
Retrieves information about a pipeline.
Retrieves the contents of a dataset as presigned URIs.
Retrieves a list of channels.
Lists information about dataset contents that have been created.
Retrieves information about datasets.
Retrieves a list of data stores.
Retrieves a list of pipelines.
Lists the tags (metadata) that you have assigned to the resource.
Sets or updates the IoT Analytics logging options.
Simulates the results of running a pipeline activity on a message payload.
Retrieves a sample of messages from the specified channel ingested during the specified timeframe.
Starts the reprocessing of raw message data through the pipeline.
Adds to or modifies the tags of the given resource.
Removes the given tags (metadata) from the resource.
Used to update the settings of a channel.
Updates the settings of a dataset.
Used to update the settings of a data store.
Updates the settings of a pipeline.
Functions
Sends messages to a channel.
cancel_pipeline_reprocessing(client, pipeline_name, reprocessing_id, input, options \\ [])
View SourceCancels the reprocessing of data through the pipeline.
Used 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.
Used to create a dataset.
A dataset stores data retrieved from a data store by applying a
queryAction (a SQL query) or a containerAction (executing a
containerized application). This operation creates the skeleton of a dataset.
The dataset can
be populated manually by calling CreateDatasetContent or automatically
according
to a trigger you specify.
create_dataset_content(client, dataset_name, input, options \\ [])
View SourceCreates the content of a dataset by applying a queryAction (a SQL query) or a
containerAction (executing a containerized application).
Creates a data store, which is a repository for messages.
Creates 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 both a
channel
and a datastore activity and, optionally, as many as 23 additional activities
in
the pipelineActivities array.
Deletes the specified channel.
Deletes the specified dataset.
You do not have to delete the content of the dataset before you perform this operation.
delete_dataset_content(client, dataset_name, input, options \\ [])
View SourceDeletes the content of the specified dataset.
Deletes the specified data store.
Deletes the specified pipeline.
describe_channel(client, channel_name, include_statistics \\ nil, options \\ [])
View SourceRetrieves information about a channel.
Retrieves information about a dataset.
describe_datastore(client, datastore_name, include_statistics \\ nil, options \\ [])
View SourceRetrieves information about a data store.
Retrieves the current settings of the IoT Analytics logging options.
Retrieves information about a pipeline.
get_dataset_content(client, dataset_name, version_id \\ nil, options \\ [])
View SourceRetrieves the contents of a dataset as presigned URIs.
list_channels(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceRetrieves a list of channels.
list_dataset_contents(client, dataset_name, max_results \\ nil, next_token \\ nil, scheduled_before \\ nil, scheduled_on_or_after \\ nil, options \\ [])
View SourceLists information about dataset contents that have been created.
list_datasets(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceRetrieves information about datasets.
list_datastores(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceRetrieves a list of data stores.
list_pipelines(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceRetrieves a list of pipelines.
Lists the tags (metadata) that you have assigned to the resource.
Sets or updates the IoT Analytics logging options.
If you update the value of any loggingOptions field, it takes up to one
minute for the change to take effect. Also, if you change the policy attached to
the role you
specified in the roleArn field (for example, to correct an invalid policy), it
takes up to five minutes for that change to take effect.
Simulates the results of running a pipeline activity on a message payload.
sample_channel_data(client, channel_name, end_time \\ nil, max_messages \\ nil, start_time \\ nil, options \\ [])
View SourceRetrieves a sample of messages from the specified channel ingested during the specified timeframe.
Up to 10 messages can be retrieved.
start_pipeline_reprocessing(client, pipeline_name, input, options \\ [])
View SourceStarts the reprocessing of raw message data through the pipeline.
Adds to or modifies the tags of the given resource.
Tags are metadata that can be used to manage a resource.
Removes the given tags (metadata) from the resource.
Used to update the settings of a channel.
Updates the settings of a dataset.
Used to update the settings of a data store.
Updates the settings of a pipeline.
You must specify both a channel and a
datastore activity and, optionally, as many as 23 additional activities in the
pipelineActivities array.