GSP
Quick Navigator
Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::IoTAnalytics(3) User Contributed Perl Documentation Paws::IoTAnalytics(3)

Paws::IoTAnalytics - Perl Interface to AWS AWS IoT Analytics

  use Paws;
  my $obj = Paws->service('IoTAnalytics');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

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.

For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27>

Each argument is described in detail in: Paws::IoTAnalytics::BatchPutMessage

Returns: a Paws::IoTAnalytics::BatchPutMessageResponse instance

Sends messages to a channel.

Each argument is described in detail in: Paws::IoTAnalytics::CancelPipelineReprocessing

Returns: a Paws::IoTAnalytics::CancelPipelineReprocessingResponse instance

Cancels the reprocessing of data through the pipeline.

[ChannelStorage => Paws::IoTAnalytics::ChannelStorage]
[RetentionPeriod => Paws::IoTAnalytics::RetentionPeriod]
[Tags => ArrayRef[Paws::IoTAnalytics::Tag]]

Each argument is described in detail in: Paws::IoTAnalytics::CreateChannel

Returns: a Paws::IoTAnalytics::CreateChannelResponse instance

Creates a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.

[ContentDeliveryRules => ArrayRef[Paws::IoTAnalytics::DatasetContentDeliveryRule]]
[LateDataRules => ArrayRef[Paws::IoTAnalytics::LateDataRule]]
[RetentionPeriod => Paws::IoTAnalytics::RetentionPeriod]
[Tags => ArrayRef[Paws::IoTAnalytics::Tag]]
[Triggers => ArrayRef[Paws::IoTAnalytics::DatasetTrigger]]
[VersioningConfiguration => Paws::IoTAnalytics::VersioningConfiguration]

Each argument is described in detail in: Paws::IoTAnalytics::CreateDataset

Returns: a Paws::IoTAnalytics::CreateDatasetResponse instance

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.

[VersionId => Str]

Each argument is described in detail in: Paws::IoTAnalytics::CreateDatasetContent

Returns: a Paws::IoTAnalytics::CreateDatasetContentResponse instance

Creates the content of a data set by applying a "queryAction" (a SQL query) or a "containerAction" (executing a containerized application).

[DatastorePartitions => Paws::IoTAnalytics::DatastorePartitions]
[DatastoreStorage => Paws::IoTAnalytics::DatastoreStorage]
[FileFormatConfiguration => Paws::IoTAnalytics::FileFormatConfiguration]
[RetentionPeriod => Paws::IoTAnalytics::RetentionPeriod]
[Tags => ArrayRef[Paws::IoTAnalytics::Tag]]

Each argument is described in detail in: Paws::IoTAnalytics::CreateDatastore

Returns: a Paws::IoTAnalytics::CreateDatastoreResponse instance

Creates a data store, which is a repository for messages. Only data stores that are used to save pipeline data can be configured with "ParquetConfiguration".

[Tags => ArrayRef[Paws::IoTAnalytics::Tag]]

Each argument is described in detail in: Paws::IoTAnalytics::CreatePipeline

Returns: a Paws::IoTAnalytics::CreatePipelineResponse instance

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.

Each argument is described in detail in: Paws::IoTAnalytics::DeleteChannel

Returns: nothing

Deletes the specified channel.

Each argument is described in detail in: Paws::IoTAnalytics::DeleteDataset

Returns: nothing

Deletes the specified dataset.

You do not have to delete the content of the dataset before you perform this operation.

[VersionId => Str]

Each argument is described in detail in: Paws::IoTAnalytics::DeleteDatasetContent

Returns: nothing

Deletes the content of the specified dataset.

Each argument is described in detail in: Paws::IoTAnalytics::DeleteDatastore

Returns: nothing

Deletes the specified data store.

Each argument is described in detail in: Paws::IoTAnalytics::DeletePipeline

Returns: nothing

Deletes the specified pipeline.

[IncludeStatistics => Bool]

Each argument is described in detail in: Paws::IoTAnalytics::DescribeChannel

Returns: a Paws::IoTAnalytics::DescribeChannelResponse instance

Retrieves information about a channel.

Each argument is described in detail in: Paws::IoTAnalytics::DescribeDataset

Returns: a Paws::IoTAnalytics::DescribeDatasetResponse instance

Retrieves information about a dataset.

[IncludeStatistics => Bool]

Each argument is described in detail in: Paws::IoTAnalytics::DescribeDatastore

Returns: a Paws::IoTAnalytics::DescribeDatastoreResponse instance

Retrieves information about a data store.

Each argument is described in detail in: Paws::IoTAnalytics::DescribeLoggingOptions

Returns: a Paws::IoTAnalytics::DescribeLoggingOptionsResponse instance

Retrieves the current settings of the AWS IoT Analytics logging options.

Each argument is described in detail in: Paws::IoTAnalytics::DescribePipeline

Returns: a Paws::IoTAnalytics::DescribePipelineResponse instance

Retrieves information about a pipeline.

[VersionId => Str]

Each argument is described in detail in: Paws::IoTAnalytics::GetDatasetContent

Returns: a Paws::IoTAnalytics::GetDatasetContentResponse instance

Retrieves the contents of a data set as presigned URIs.

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::IoTAnalytics::ListChannels

Returns: a Paws::IoTAnalytics::ListChannelsResponse instance

Retrieves a list of channels.

[MaxResults => Int]
[NextToken => Str]
[ScheduledBefore => Str]
[ScheduledOnOrAfter => Str]

Each argument is described in detail in: Paws::IoTAnalytics::ListDatasetContents

Returns: a Paws::IoTAnalytics::ListDatasetContentsResponse instance

Lists information about data set contents that have been created.

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::IoTAnalytics::ListDatasets

Returns: a Paws::IoTAnalytics::ListDatasetsResponse instance

Retrieves information about data sets.

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::IoTAnalytics::ListDatastores

Returns: a Paws::IoTAnalytics::ListDatastoresResponse instance

Retrieves a list of data stores.

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::IoTAnalytics::ListPipelines

Returns: a Paws::IoTAnalytics::ListPipelinesResponse instance

Retrieves a list of pipelines.

Each argument is described in detail in: Paws::IoTAnalytics::ListTagsForResource

Returns: a Paws::IoTAnalytics::ListTagsForResourceResponse instance

Lists the tags (metadata) that you have assigned to the resource.

Each argument is described in detail in: Paws::IoTAnalytics::PutLoggingOptions

Returns: nothing

Sets or updates the AWS 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.

Each argument is described in detail in: Paws::IoTAnalytics::RunPipelineActivity

Returns: a Paws::IoTAnalytics::RunPipelineActivityResponse instance

Simulates the results of running a pipeline activity on a message payload.

[EndTime => Str]
[MaxMessages => Int]
[StartTime => Str]

Each argument is described in detail in: Paws::IoTAnalytics::SampleChannelData

Returns: a Paws::IoTAnalytics::SampleChannelDataResponse instance

Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10 messages can be retrieved.

[ChannelMessages => Paws::IoTAnalytics::ChannelMessages]
[EndTime => Str]
[StartTime => Str]

Each argument is described in detail in: Paws::IoTAnalytics::StartPipelineReprocessing

Returns: a Paws::IoTAnalytics::StartPipelineReprocessingResponse instance

Starts the reprocessing of raw message data through the pipeline.

Each argument is described in detail in: Paws::IoTAnalytics::TagResource

Returns: a Paws::IoTAnalytics::TagResourceResponse instance

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.

Each argument is described in detail in: Paws::IoTAnalytics::UntagResource

Returns: a Paws::IoTAnalytics::UntagResourceResponse instance

Removes the given tags (metadata) from the resource.

[ChannelStorage => Paws::IoTAnalytics::ChannelStorage]
[RetentionPeriod => Paws::IoTAnalytics::RetentionPeriod]

Each argument is described in detail in: Paws::IoTAnalytics::UpdateChannel

Returns: nothing

Updates the settings of a channel.

[ContentDeliveryRules => ArrayRef[Paws::IoTAnalytics::DatasetContentDeliveryRule]]
[LateDataRules => ArrayRef[Paws::IoTAnalytics::LateDataRule]]
[RetentionPeriod => Paws::IoTAnalytics::RetentionPeriod]
[Triggers => ArrayRef[Paws::IoTAnalytics::DatasetTrigger]]
[VersioningConfiguration => Paws::IoTAnalytics::VersioningConfiguration]

Each argument is described in detail in: Paws::IoTAnalytics::UpdateDataset

Returns: nothing

Updates the settings of a data set.

[DatastoreStorage => Paws::IoTAnalytics::DatastoreStorage]
[FileFormatConfiguration => Paws::IoTAnalytics::FileFormatConfiguration]
[RetentionPeriod => Paws::IoTAnalytics::RetentionPeriod]

Each argument is described in detail in: Paws::IoTAnalytics::UpdateDatastore

Returns: nothing

Updates the settings of a data store.

Each argument is described in detail in: Paws::IoTAnalytics::UpdatePipeline

Returns: nothing

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.

Paginator methods are helpers that repetively call methods that return partial results

If passed a sub as first parameter, it will call the sub for each element found in :

 - channelSummaries, passing the object as the first parameter, and the string 'channelSummaries' as the second parameter

If not, it will return a a Paws::IoTAnalytics::ListChannelsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - datasetContentSummaries, passing the object as the first parameter, and the string 'datasetContentSummaries' as the second parameter

If not, it will return a a Paws::IoTAnalytics::ListDatasetContentsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - datasetSummaries, passing the object as the first parameter, and the string 'datasetSummaries' as the second parameter

If not, it will return a a Paws::IoTAnalytics::ListDatasetsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - datastoreSummaries, passing the object as the first parameter, and the string 'datastoreSummaries' as the second parameter

If not, it will return a a Paws::IoTAnalytics::ListDatastoresResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - pipelineSummaries, passing the object as the first parameter, and the string 'pipelineSummaries' as the second parameter

If not, it will return a a Paws::IoTAnalytics::ListPipelinesResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

This service class forms part of Paws

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2
Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.