IoTAnalytics class

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.

Constructors

IoTAnalytics({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

batchPutMessage({required String channelName, required List<Message> messages}) → Future<BatchPutMessageResponse>
Sends messages to a channel.
cancelPipelineReprocessing({required String pipelineName, required String reprocessingId}) → Future<void>
Cancels the reprocessing of data through the pipeline.
close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createChannel({required String channelName, ChannelStorage? channelStorage, RetentionPeriod? retentionPeriod, List<Tag>? tags}) → Future<CreateChannelResponse>
Creates a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.
createDataset({required List<DatasetAction> actions, required String datasetName, List<DatasetContentDeliveryRule>? contentDeliveryRules, List<LateDataRule>? lateDataRules, RetentionPeriod? retentionPeriod, List<Tag>? tags, List<DatasetTrigger>? triggers, VersioningConfiguration? versioningConfiguration}) → Future<CreateDatasetResponse>
Creates 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.
createDatasetContent({required String datasetName, String? versionId}) → Future<CreateDatasetContentResponse>
Creates the content of a data set by applying a queryAction (a SQL query) or a containerAction (executing a containerized application).
createDatastore({required String datastoreName, DatastoreStorage? datastoreStorage, FileFormatConfiguration? fileFormatConfiguration, RetentionPeriod? retentionPeriod, List<Tag>? tags}) → Future<CreateDatastoreResponse>
Creates a data store, which is a repository for messages.
createPipeline({required List<PipelineActivity> pipelineActivities, required String pipelineName, List<Tag>? tags}) → Future<CreatePipelineResponse>
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.
deleteChannel({required String channelName}) → Future<void>
Deletes the specified channel.
deleteDataset({required String datasetName}) → Future<void>
Deletes the specified dataset.
deleteDatasetContent({required String datasetName, String? versionId}) → Future<void>
Deletes the content of the specified dataset.
deleteDatastore({required String datastoreName}) → Future<void>
Deletes the specified data store.
deletePipeline({required String pipelineName}) → Future<void>
Deletes the specified pipeline.
describeChannel({required String channelName, bool? includeStatistics}) → Future<DescribeChannelResponse>
Retrieves information about a channel.
describeDataset({required String datasetName}) → Future<DescribeDatasetResponse>
Retrieves information about a dataset.
describeDatastore({required String datastoreName, bool? includeStatistics}) → Future<DescribeDatastoreResponse>
Retrieves information about a data store.
describeLoggingOptions() → Future<DescribeLoggingOptionsResponse>
Retrieves the current settings of the AWS IoT Analytics logging options.
describePipeline({required String pipelineName}) → Future<DescribePipelineResponse>
Retrieves information about a pipeline.
getDatasetContent({required String datasetName, String? versionId}) → Future<GetDatasetContentResponse>
Retrieves the contents of a data set as presigned URIs.
listChannels({int? maxResults, String? nextToken}) → Future<ListChannelsResponse>
Retrieves a list of channels.
listDatasetContents({required String datasetName, int? maxResults, String? nextToken, DateTime? scheduledBefore, DateTime? scheduledOnOrAfter}) → Future<ListDatasetContentsResponse>
Lists information about data set contents that have been created.
listDatasets({int? maxResults, String? nextToken}) → Future<ListDatasetsResponse>
Retrieves information about data sets.
listDatastores({int? maxResults, String? nextToken}) → Future<ListDatastoresResponse>
Retrieves a list of data stores.
listPipelines({int? maxResults, String? nextToken}) → Future<ListPipelinesResponse>
Retrieves a list of pipelines.
listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>
Lists the tags (metadata) that you have assigned to the resource.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
putLoggingOptions({required LoggingOptions loggingOptions}) → Future<void>
Sets or updates the AWS IoT Analytics logging options.
runPipelineActivity({required List<Uint8List> payloads, required PipelineActivity pipelineActivity}) → Future<RunPipelineActivityResponse>
Simulates the results of running a pipeline activity on a message payload.
sampleChannelData({required String channelName, DateTime? endTime, int? maxMessages, DateTime? startTime}) → Future<SampleChannelDataResponse>
Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10 messages can be retrieved.
startPipelineReprocessing({required String pipelineName, ChannelMessages? channelMessages, DateTime? endTime, DateTime? startTime}) → Future<StartPipelineReprocessingResponse>
Starts the reprocessing of raw message data through the pipeline.
tagResource({required String resourceArn, required List<Tag> tags}) → Future<void>
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
toString() → String
A string representation of this object.
inherited
untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>
Removes the given tags (metadata) from the resource.
updateChannel({required String channelName, ChannelStorage? channelStorage, RetentionPeriod? retentionPeriod}) → Future<void>
Updates the settings of a channel.
updateDataset({required List<DatasetAction> actions, required String datasetName, List<DatasetContentDeliveryRule>? contentDeliveryRules, List<LateDataRule>? lateDataRules, RetentionPeriod? retentionPeriod, List<DatasetTrigger>? triggers, VersioningConfiguration? versioningConfiguration}) → Future<void>
Updates the settings of a data set.
updateDatastore({required String datastoreName, DatastoreStorage? datastoreStorage, FileFormatConfiguration? fileFormatConfiguration, RetentionPeriod? retentionPeriod}) → Future<void>
Updates the settings of a data store.
updatePipeline({required List<PipelineActivity> pipelineActivities, required String pipelineName}) → Future<void>
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.

Operators

operator ==(Object other) → bool
The equality operator.
inherited