Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- DescribePipeline
- DescribeDataset
- ListChannels
- PutLoggingOptions
- DeleteChannel
- UpdateChannel
- SampleChannelData
- CancelPipelineReprocessing
- CreateDatastore
- UpdatePipeline
- DeletePipeline
- DeleteDataset
- UpdateDataset
- ListPipelines
- DeleteDatastore
- UpdateDatastore
- CreateDataset
- BatchPutMessage
- ListDatastores
- CreateDatasetContent
- CreateChannel
- DeleteDatasetContent
- DescribeDatastore
- GetDatasetContent
- ListDatasets
- RunPipelineActivity
- DescribeChannel
- CreatePipeline
- StartPipelineReprocessing
- DescribeLoggingOptions
- Types
- ChannelStatus
- DatasetContentState
- DatasetStatus
- DatastoreStatus
- LoggingLevel
- ReprocessingStatus
- AddAttributesActivity
- BatchPutMessageErrorEntry
- Channel
- ChannelActivity
- ChannelSummary
- Dataset
- DatasetAction
- DatasetContentStatus
- DatasetEntry
- DatasetSummary
- DatasetTrigger
- Datastore
- DatastoreActivity
- DatastoreSummary
- DeviceRegistryEnrichActivity
- DeviceShadowEnrichActivity
- FilterActivity
- LambdaActivity
- LoggingOptions
- MathActivity
- Message
- Pipeline
- PipelineActivity
- PipelineSummary
- RemoveAttributesActivity
- ReprocessingSummary
- RetentionPeriod
- Schedule
- SelectAttributesActivity
- SqlQueryDatasetAction
AWS IoT Analytics provides advanced data analysis for AWS IoT. It allows you to collect large amounts of device data, process messages, store them, and then query the data and run sophisticated analytics to make accurate decisions in your IoT applications and machine learning use cases. 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 each of 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 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.
- ioTAnalytics :: Service
- _InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.IoTAnalytics.DescribePipeline
- module Network.AWS.IoTAnalytics.DescribeDataset
- module Network.AWS.IoTAnalytics.ListChannels
- module Network.AWS.IoTAnalytics.PutLoggingOptions
- module Network.AWS.IoTAnalytics.DeleteChannel
- module Network.AWS.IoTAnalytics.UpdateChannel
- module Network.AWS.IoTAnalytics.SampleChannelData
- module Network.AWS.IoTAnalytics.CancelPipelineReprocessing
- module Network.AWS.IoTAnalytics.CreateDatastore
- module Network.AWS.IoTAnalytics.UpdatePipeline
- module Network.AWS.IoTAnalytics.DeletePipeline
- module Network.AWS.IoTAnalytics.DeleteDataset
- module Network.AWS.IoTAnalytics.UpdateDataset
- module Network.AWS.IoTAnalytics.ListPipelines
- module Network.AWS.IoTAnalytics.DeleteDatastore
- module Network.AWS.IoTAnalytics.UpdateDatastore
- module Network.AWS.IoTAnalytics.CreateDataset
- module Network.AWS.IoTAnalytics.BatchPutMessage
- module Network.AWS.IoTAnalytics.ListDatastores
- module Network.AWS.IoTAnalytics.CreateDatasetContent
- module Network.AWS.IoTAnalytics.CreateChannel
- module Network.AWS.IoTAnalytics.DeleteDatasetContent
- module Network.AWS.IoTAnalytics.DescribeDatastore
- module Network.AWS.IoTAnalytics.GetDatasetContent
- module Network.AWS.IoTAnalytics.ListDatasets
- module Network.AWS.IoTAnalytics.RunPipelineActivity
- module Network.AWS.IoTAnalytics.DescribeChannel
- module Network.AWS.IoTAnalytics.CreatePipeline
- module Network.AWS.IoTAnalytics.StartPipelineReprocessing
- module Network.AWS.IoTAnalytics.DescribeLoggingOptions
- data ChannelStatus
- data DatasetContentState
- data DatasetStatus
- data DatastoreStatus
- data LoggingLevel = Error'
- data ReprocessingStatus
- data AddAttributesActivity
- addAttributesActivity :: Text -> AddAttributesActivity
- aaaNext :: Lens' AddAttributesActivity (Maybe Text)
- aaaName :: Lens' AddAttributesActivity Text
- aaaAttributes :: Lens' AddAttributesActivity (HashMap Text Text)
- data BatchPutMessageErrorEntry
- batchPutMessageErrorEntry :: BatchPutMessageErrorEntry
- bpmeeErrorCode :: Lens' BatchPutMessageErrorEntry (Maybe Text)
- bpmeeErrorMessage :: Lens' BatchPutMessageErrorEntry (Maybe Text)
- bpmeeMessageId :: Lens' BatchPutMessageErrorEntry (Maybe Text)
- data Channel
- channel :: Channel
- cCreationTime :: Lens' Channel (Maybe UTCTime)
- cStatus :: Lens' Channel (Maybe ChannelStatus)
- cArn :: Lens' Channel (Maybe Text)
- cRetentionPeriod :: Lens' Channel (Maybe RetentionPeriod)
- cName :: Lens' Channel (Maybe Text)
- cLastUpdateTime :: Lens' Channel (Maybe UTCTime)
- data ChannelActivity
- channelActivity :: Text -> Text -> ChannelActivity
- caNext :: Lens' ChannelActivity (Maybe Text)
- caName :: Lens' ChannelActivity Text
- caChannelName :: Lens' ChannelActivity Text
- data ChannelSummary
- channelSummary :: ChannelSummary
- csCreationTime :: Lens' ChannelSummary (Maybe UTCTime)
- csStatus :: Lens' ChannelSummary (Maybe ChannelStatus)
- csChannelName :: Lens' ChannelSummary (Maybe Text)
- csLastUpdateTime :: Lens' ChannelSummary (Maybe UTCTime)
- data Dataset
- dataset :: Dataset
- dCreationTime :: Lens' Dataset (Maybe UTCTime)
- dStatus :: Lens' Dataset (Maybe DatasetStatus)
- dArn :: Lens' Dataset (Maybe Text)
- dActions :: Lens' Dataset (Maybe (NonEmpty DatasetAction))
- dTriggers :: Lens' Dataset [DatasetTrigger]
- dName :: Lens' Dataset (Maybe Text)
- dLastUpdateTime :: Lens' Dataset (Maybe UTCTime)
- data DatasetAction
- datasetAction :: DatasetAction
- daQueryAction :: Lens' DatasetAction (Maybe SqlQueryDatasetAction)
- daActionName :: Lens' DatasetAction (Maybe Text)
- data DatasetContentStatus
- datasetContentStatus :: DatasetContentStatus
- dcsState :: Lens' DatasetContentStatus (Maybe DatasetContentState)
- dcsReason :: Lens' DatasetContentStatus (Maybe Text)
- data DatasetEntry
- datasetEntry :: DatasetEntry
- deEntryName :: Lens' DatasetEntry (Maybe Text)
- deDataURI :: Lens' DatasetEntry (Maybe Text)
- data DatasetSummary
- datasetSummary :: DatasetSummary
- dssCreationTime :: Lens' DatasetSummary (Maybe UTCTime)
- dssStatus :: Lens' DatasetSummary (Maybe DatasetStatus)
- dssDatasetName :: Lens' DatasetSummary (Maybe Text)
- dssLastUpdateTime :: Lens' DatasetSummary (Maybe UTCTime)
- data DatasetTrigger
- datasetTrigger :: DatasetTrigger
- dtSchedule :: Lens' DatasetTrigger (Maybe Schedule)
- data Datastore
- datastore :: Datastore
- datCreationTime :: Lens' Datastore (Maybe UTCTime)
- datStatus :: Lens' Datastore (Maybe DatastoreStatus)
- datArn :: Lens' Datastore (Maybe Text)
- datRetentionPeriod :: Lens' Datastore (Maybe RetentionPeriod)
- datName :: Lens' Datastore (Maybe Text)
- datLastUpdateTime :: Lens' Datastore (Maybe UTCTime)
- data DatastoreActivity
- datastoreActivity :: Text -> Text -> DatastoreActivity
- daName :: Lens' DatastoreActivity Text
- daDatastoreName :: Lens' DatastoreActivity Text
- data DatastoreSummary
- datastoreSummary :: DatastoreSummary
- dsCreationTime :: Lens' DatastoreSummary (Maybe UTCTime)
- dsStatus :: Lens' DatastoreSummary (Maybe DatastoreStatus)
- dsDatastoreName :: Lens' DatastoreSummary (Maybe Text)
- dsLastUpdateTime :: Lens' DatastoreSummary (Maybe UTCTime)
- data DeviceRegistryEnrichActivity
- deviceRegistryEnrichActivity :: Text -> Text -> Text -> Text -> DeviceRegistryEnrichActivity
- dreaNext :: Lens' DeviceRegistryEnrichActivity (Maybe Text)
- dreaName :: Lens' DeviceRegistryEnrichActivity Text
- dreaAttribute :: Lens' DeviceRegistryEnrichActivity Text
- dreaThingName :: Lens' DeviceRegistryEnrichActivity Text
- dreaRoleARN :: Lens' DeviceRegistryEnrichActivity Text
- data DeviceShadowEnrichActivity
- deviceShadowEnrichActivity :: Text -> Text -> Text -> Text -> DeviceShadowEnrichActivity
- dseaNext :: Lens' DeviceShadowEnrichActivity (Maybe Text)
- dseaName :: Lens' DeviceShadowEnrichActivity Text
- dseaAttribute :: Lens' DeviceShadowEnrichActivity Text
- dseaThingName :: Lens' DeviceShadowEnrichActivity Text
- dseaRoleARN :: Lens' DeviceShadowEnrichActivity Text
- data FilterActivity
- filterActivity :: Text -> Text -> FilterActivity
- faNext :: Lens' FilterActivity (Maybe Text)
- faName :: Lens' FilterActivity Text
- faFilter :: Lens' FilterActivity Text
- data LambdaActivity
- lambdaActivity :: Text -> Text -> Natural -> LambdaActivity
- laNext :: Lens' LambdaActivity (Maybe Text)
- laName :: Lens' LambdaActivity Text
- laLambdaName :: Lens' LambdaActivity Text
- laBatchSize :: Lens' LambdaActivity Natural
- data LoggingOptions
- loggingOptions :: Text -> LoggingLevel -> Bool -> LoggingOptions
- loRoleARN :: Lens' LoggingOptions Text
- loLevel :: Lens' LoggingOptions LoggingLevel
- loEnabled :: Lens' LoggingOptions Bool
- data MathActivity
- mathActivity :: Text -> Text -> Text -> MathActivity
- maNext :: Lens' MathActivity (Maybe Text)
- maName :: Lens' MathActivity Text
- maAttribute :: Lens' MathActivity Text
- maMath :: Lens' MathActivity Text
- data Message
- message :: Text -> ByteString -> Message
- mMessageId :: Lens' Message Text
- mPayload :: Lens' Message ByteString
- data Pipeline
- pipeline :: Pipeline
- pCreationTime :: Lens' Pipeline (Maybe UTCTime)
- pArn :: Lens' Pipeline (Maybe Text)
- pActivities :: Lens' Pipeline (Maybe (NonEmpty PipelineActivity))
- pName :: Lens' Pipeline (Maybe Text)
- pReprocessingSummaries :: Lens' Pipeline [ReprocessingSummary]
- pLastUpdateTime :: Lens' Pipeline (Maybe UTCTime)
- data PipelineActivity
- pipelineActivity :: PipelineActivity
- paSelectAttributes :: Lens' PipelineActivity (Maybe SelectAttributesActivity)
- paChannel :: Lens' PipelineActivity (Maybe ChannelActivity)
- paAddAttributes :: Lens' PipelineActivity (Maybe AddAttributesActivity)
- paDeviceRegistryEnrich :: Lens' PipelineActivity (Maybe DeviceRegistryEnrichActivity)
- paRemoveAttributes :: Lens' PipelineActivity (Maybe RemoveAttributesActivity)
- paLambda :: Lens' PipelineActivity (Maybe LambdaActivity)
- paDatastore :: Lens' PipelineActivity (Maybe DatastoreActivity)
- paDeviceShadowEnrich :: Lens' PipelineActivity (Maybe DeviceShadowEnrichActivity)
- paFilter :: Lens' PipelineActivity (Maybe FilterActivity)
- paMath :: Lens' PipelineActivity (Maybe MathActivity)
- data PipelineSummary
- pipelineSummary :: PipelineSummary
- psCreationTime :: Lens' PipelineSummary (Maybe UTCTime)
- psPipelineName :: Lens' PipelineSummary (Maybe Text)
- psReprocessingSummaries :: Lens' PipelineSummary [ReprocessingSummary]
- psLastUpdateTime :: Lens' PipelineSummary (Maybe UTCTime)
- data RemoveAttributesActivity
- removeAttributesActivity :: Text -> NonEmpty Text -> RemoveAttributesActivity
- raaNext :: Lens' RemoveAttributesActivity (Maybe Text)
- raaName :: Lens' RemoveAttributesActivity Text
- raaAttributes :: Lens' RemoveAttributesActivity (NonEmpty Text)
- data ReprocessingSummary
- reprocessingSummary :: ReprocessingSummary
- rsCreationTime :: Lens' ReprocessingSummary (Maybe UTCTime)
- rsStatus :: Lens' ReprocessingSummary (Maybe ReprocessingStatus)
- rsId :: Lens' ReprocessingSummary (Maybe Text)
- data RetentionPeriod
- retentionPeriod :: RetentionPeriod
- rpUnlimited :: Lens' RetentionPeriod (Maybe Bool)
- rpNumberOfDays :: Lens' RetentionPeriod (Maybe Natural)
- data Schedule
- schedule :: Schedule
- sExpression :: Lens' Schedule (Maybe Text)
- data SelectAttributesActivity
- selectAttributesActivity :: Text -> NonEmpty Text -> SelectAttributesActivity
- saaNext :: Lens' SelectAttributesActivity (Maybe Text)
- saaName :: Lens' SelectAttributesActivity Text
- saaAttributes :: Lens' SelectAttributesActivity (NonEmpty Text)
- data SqlQueryDatasetAction
- sqlQueryDatasetAction :: Text -> SqlQueryDatasetAction
- sqdaSqlQuery :: Lens' SqlQueryDatasetAction Text
Service Configuration
ioTAnalytics :: Service Source #
API version 2017-11-27
of the Amazon IoT Analytics SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by IoTAnalytics
.
InvalidRequestException
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was not valid.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A resource with the same name already exists.
ThrottlingException
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was denied due to request throttling.
InternalFailureException
_InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError Source #
There was an internal failure.
ServiceUnavailableException
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The service is temporarily unavailable.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A resource with the specified name could not be found.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The command caused an internal limit to be exceeded.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
DescribePipeline
DescribeDataset
ListChannels
PutLoggingOptions
DeleteChannel
UpdateChannel
SampleChannelData
CancelPipelineReprocessing
CreateDatastore
UpdatePipeline
DeletePipeline
DeleteDataset
UpdateDataset
ListPipelines
DeleteDatastore
UpdateDatastore
CreateDataset
BatchPutMessage
ListDatastores
CreateDatasetContent
CreateChannel
DeleteDatasetContent
DescribeDatastore
GetDatasetContent
ListDatasets
RunPipelineActivity
DescribeChannel
CreatePipeline
StartPipelineReprocessing
DescribeLoggingOptions
Types
ChannelStatus
data ChannelStatus Source #
DatasetContentState
data DatasetContentState Source #
DatasetStatus
data DatasetStatus Source #
DatastoreStatus
data DatastoreStatus Source #
LoggingLevel
data LoggingLevel Source #
ReprocessingStatus
data ReprocessingStatus Source #
AddAttributesActivity
data AddAttributesActivity Source #
An activity that adds other attributes based on existing attributes in the message.
See: addAttributesActivity
smart constructor.
addAttributesActivity Source #
Creates a value of AddAttributesActivity
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aaaNext
- The next activity in the pipeline.aaaName
- The name of theaddAttributes
activity.aaaAttributes
- A list of 1-50 AttributeNameMapping objects that map an existing attribute to a new attribute.
aaaAttributes :: Lens' AddAttributesActivity (HashMap Text Text) Source #
A list of 1-50 AttributeNameMapping objects that map an existing attribute to a new attribute.
BatchPutMessageErrorEntry
data BatchPutMessageErrorEntry Source #
Contains informations about errors.
See: batchPutMessageErrorEntry
smart constructor.
batchPutMessageErrorEntry :: BatchPutMessageErrorEntry Source #
Creates a value of BatchPutMessageErrorEntry
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bpmeeErrorCode
- The code associated with the error.bpmeeErrorMessage
- The message associated with the error.bpmeeMessageId
- The ID of the message that caused the error. (See the value corresponding to the "messageId" key in the message object.)
bpmeeErrorCode :: Lens' BatchPutMessageErrorEntry (Maybe Text) Source #
The code associated with the error.
bpmeeErrorMessage :: Lens' BatchPutMessageErrorEntry (Maybe Text) Source #
The message associated with the error.
bpmeeMessageId :: Lens' BatchPutMessageErrorEntry (Maybe Text) Source #
The ID of the message that caused the error. (See the value corresponding to the "messageId" key in the message object.)
Channel
A collection of data from an MQTT topic. Channels archive the raw, unprocessed messages before publishing the data to a pipeline.
See: channel
smart constructor.
Creates a value of Channel
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cCreationTime
- When the channel was created.cStatus
- The status of the channel.cArn
- The ARN of the channel.cRetentionPeriod
- How long, in days, message data is kept for the channel.cName
- The name of the channel.cLastUpdateTime
- When the channel was last updated.
cRetentionPeriod :: Lens' Channel (Maybe RetentionPeriod) Source #
How long, in days, message data is kept for the channel.
ChannelActivity
data ChannelActivity Source #
The activity that determines the source of the messages to be processed.
See: channelActivity
smart constructor.
Creates a value of ChannelActivity
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
caNext
- The next activity in the pipeline.caName
- The name of thechannel
activity.caChannelName
- The name of the channel from which the messages are processed.
caChannelName :: Lens' ChannelActivity Text Source #
The name of the channel from which the messages are processed.
ChannelSummary
data ChannelSummary Source #
A summary of information about a channel.
See: channelSummary
smart constructor.
channelSummary :: ChannelSummary Source #
Creates a value of ChannelSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
csCreationTime
- When the channel was created.csStatus
- The status of the channel.csChannelName
- The name of the channel.csLastUpdateTime
- The last time the channel was updated.
csCreationTime :: Lens' ChannelSummary (Maybe UTCTime) Source #
When the channel was created.
csStatus :: Lens' ChannelSummary (Maybe ChannelStatus) Source #
The status of the channel.
csChannelName :: Lens' ChannelSummary (Maybe Text) Source #
The name of the channel.
csLastUpdateTime :: Lens' ChannelSummary (Maybe UTCTime) Source #
The last time the channel was updated.
Dataset
Information about a data set.
See: dataset
smart constructor.
Creates a value of Dataset
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dCreationTime
- When the data set was created.dStatus
- The status of the data set.dArn
- The ARN of the data set.dActions
- The DatasetAction objects that create the data set.dTriggers
- The DatasetTrigger objects that specify when the data set is automatically updated.dName
- The name of the data set.dLastUpdateTime
- The last time the data set was updated.
dActions :: Lens' Dataset (Maybe (NonEmpty DatasetAction)) Source #
The DatasetAction objects that create the data set.
dTriggers :: Lens' Dataset [DatasetTrigger] Source #
The DatasetTrigger objects that specify when the data set is automatically updated.
DatasetAction
data DatasetAction Source #
A DatasetAction object specifying the query that creates the data set content.
See: datasetAction
smart constructor.
datasetAction :: DatasetAction Source #
Creates a value of DatasetAction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
daQueryAction
- An SqlQueryDatasetAction object that contains the SQL query to modify the message.daActionName
- The name of the data set action.
daQueryAction :: Lens' DatasetAction (Maybe SqlQueryDatasetAction) Source #
An SqlQueryDatasetAction object that contains the SQL query to modify the message.
daActionName :: Lens' DatasetAction (Maybe Text) Source #
The name of the data set action.
DatasetContentStatus
data DatasetContentStatus Source #
The state of the data set and the reason it is in this state.
See: datasetContentStatus
smart constructor.
dcsReason :: Lens' DatasetContentStatus (Maybe Text) Source #
The reason the data set is in this state.
DatasetEntry
data DatasetEntry Source #
The reference to a data set entry.
See: datasetEntry
smart constructor.
datasetEntry :: DatasetEntry Source #
Creates a value of DatasetEntry
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
deEntryName
- The name of the data set item.deDataURI
- The pre-signed URI of the data set item.
deEntryName :: Lens' DatasetEntry (Maybe Text) Source #
The name of the data set item.
DatasetSummary
data DatasetSummary Source #
A summary of information about a data set.
See: datasetSummary
smart constructor.
datasetSummary :: DatasetSummary Source #
Creates a value of DatasetSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dssCreationTime
- The time the data set was created.dssStatus
- The status of the data set.dssDatasetName
- The name of the data set.dssLastUpdateTime
- The last time the data set was updated.
dssCreationTime :: Lens' DatasetSummary (Maybe UTCTime) Source #
The time the data set was created.
dssStatus :: Lens' DatasetSummary (Maybe DatasetStatus) Source #
The status of the data set.
dssDatasetName :: Lens' DatasetSummary (Maybe Text) Source #
The name of the data set.
dssLastUpdateTime :: Lens' DatasetSummary (Maybe UTCTime) Source #
The last time the data set was updated.
DatasetTrigger
data DatasetTrigger Source #
The DatasetTrigger that specifies when the data set is automatically updated.
See: datasetTrigger
smart constructor.
datasetTrigger :: DatasetTrigger Source #
Creates a value of DatasetTrigger
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dtSchedule
- The Schedule when the trigger is initiated.
dtSchedule :: Lens' DatasetTrigger (Maybe Schedule) Source #
The Schedule when the trigger is initiated.
Datastore
Information about a data store.
See: datastore
smart constructor.
datastore :: Datastore Source #
Creates a value of Datastore
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
datCreationTime
- When the data store was created.datStatus
- The status of a data store: * CREATING * The data store is being created. * ACTIVE * The data store has been created and can be used. * DELETING * The data store is being deleted.datArn
- The ARN of the data store.datRetentionPeriod
- How long, in days, message data is kept for the data store.datName
- The name of the data store.datLastUpdateTime
- The last time the data store was updated.
datStatus :: Lens' Datastore (Maybe DatastoreStatus) Source #
The status of a data store: * CREATING * The data store is being created. * ACTIVE * The data store has been created and can be used. * DELETING * The data store is being deleted.
datRetentionPeriod :: Lens' Datastore (Maybe RetentionPeriod) Source #
How long, in days, message data is kept for the data store.
datLastUpdateTime :: Lens' Datastore (Maybe UTCTime) Source #
The last time the data store was updated.
DatastoreActivity
data DatastoreActivity Source #
The datastore
activity that specifies where to store the processed data.
See: datastoreActivity
smart constructor.
Creates a value of DatastoreActivity
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
daName
- The name of thedatastore
activity.daDatastoreName
- The name of the data store where processed messages are stored.
daDatastoreName :: Lens' DatastoreActivity Text Source #
The name of the data store where processed messages are stored.
DatastoreSummary
data DatastoreSummary Source #
A summary of information about a data store.
See: datastoreSummary
smart constructor.
datastoreSummary :: DatastoreSummary Source #
Creates a value of DatastoreSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dsCreationTime
- When the data store was created.dsStatus
- The status of the data store.dsDatastoreName
- The name of the data store.dsLastUpdateTime
- The last time the data store was updated.
dsCreationTime :: Lens' DatastoreSummary (Maybe UTCTime) Source #
When the data store was created.
dsStatus :: Lens' DatastoreSummary (Maybe DatastoreStatus) Source #
The status of the data store.
dsDatastoreName :: Lens' DatastoreSummary (Maybe Text) Source #
The name of the data store.
dsLastUpdateTime :: Lens' DatastoreSummary (Maybe UTCTime) Source #
The last time the data store was updated.
DeviceRegistryEnrichActivity
data DeviceRegistryEnrichActivity Source #
An activity that adds data from the AWS IoT device registry to your message.
See: deviceRegistryEnrichActivity
smart constructor.
deviceRegistryEnrichActivity Source #
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> DeviceRegistryEnrichActivity |
Creates a value of DeviceRegistryEnrichActivity
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dreaNext
- The next activity in the pipeline.dreaName
- The name of thedeviceRegistryEnrich
activity.dreaAttribute
- The name of the attribute that is added to the message.dreaThingName
- The name of the IoT device whose registry information is added to the message.dreaRoleARN
- The ARN of the role that allows access to the device's registry information.
dreaNext :: Lens' DeviceRegistryEnrichActivity (Maybe Text) Source #
The next activity in the pipeline.
dreaName :: Lens' DeviceRegistryEnrichActivity Text Source #
The name of the deviceRegistryEnrich
activity.
dreaAttribute :: Lens' DeviceRegistryEnrichActivity Text Source #
The name of the attribute that is added to the message.
dreaThingName :: Lens' DeviceRegistryEnrichActivity Text Source #
The name of the IoT device whose registry information is added to the message.
dreaRoleARN :: Lens' DeviceRegistryEnrichActivity Text Source #
The ARN of the role that allows access to the device's registry information.
DeviceShadowEnrichActivity
data DeviceShadowEnrichActivity Source #
An activity that adds information from the AWS IoT Device Shadows service to a message.
See: deviceShadowEnrichActivity
smart constructor.
deviceShadowEnrichActivity Source #
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> DeviceShadowEnrichActivity |
Creates a value of DeviceShadowEnrichActivity
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dseaNext
- The next activity in the pipeline.dseaName
- The name of thedeviceShadowEnrich
activity.dseaAttribute
- The name of the attribute that is added to the message.dseaThingName
- The name of the IoT device whose shadow information is added to the message.dseaRoleARN
- The ARN of the role that allows access to the device's shadow.
dseaNext :: Lens' DeviceShadowEnrichActivity (Maybe Text) Source #
The next activity in the pipeline.
dseaName :: Lens' DeviceShadowEnrichActivity Text Source #
The name of the deviceShadowEnrich
activity.
dseaAttribute :: Lens' DeviceShadowEnrichActivity Text Source #
The name of the attribute that is added to the message.
dseaThingName :: Lens' DeviceShadowEnrichActivity Text Source #
The name of the IoT device whose shadow information is added to the message.
dseaRoleARN :: Lens' DeviceShadowEnrichActivity Text Source #
The ARN of the role that allows access to the device's shadow.
FilterActivity
data FilterActivity Source #
An activity that filters a message based on its attributes.
See: filterActivity
smart constructor.
:: Text | |
-> Text | |
-> FilterActivity |
Creates a value of FilterActivity
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
faFilter :: Lens' FilterActivity Text Source #
An expression that looks like an SQL WHERE clause that must return a Boolean value.
LambdaActivity
data LambdaActivity Source #
An activity that runs a Lambda function to modify the message.
See: lambdaActivity
smart constructor.
Creates a value of LambdaActivity
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
laNext
- The next activity in the pipeline.laName
- The name of thelambda
activity.laLambdaName
- The name of the Lambda function that is run on the message.laBatchSize
- The number of messages passed to the Lambda function for processing. The AWS Lambda function must be able to process all of these messages within five minutes, which is the maximum timeout duration for Lambda functions.
laLambdaName :: Lens' LambdaActivity Text Source #
The name of the Lambda function that is run on the message.
laBatchSize :: Lens' LambdaActivity Natural Source #
The number of messages passed to the Lambda function for processing. The AWS Lambda function must be able to process all of these messages within five minutes, which is the maximum timeout duration for Lambda functions.
LoggingOptions
data LoggingOptions Source #
Information about logging options.
See: loggingOptions
smart constructor.
Creates a value of LoggingOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
loRoleARN :: Lens' LoggingOptions Text Source #
The ARN of the role that grants permission to AWS IoT Analytics to perform logging.
loLevel :: Lens' LoggingOptions LoggingLevel Source #
The logging level. Currently, only ERROR is supported.
MathActivity
data MathActivity Source #
An activity that computes an arithmetic expression using the message's attributes.
See: mathActivity
smart constructor.
:: Text | |
-> Text | |
-> Text | |
-> MathActivity |
Creates a value of MathActivity
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
maNext
- The next activity in the pipeline.maName
- The name of themath
activity.maAttribute
- The name of the attribute that will contain the result of the math operation.maMath
- An expression that uses one or more existing attributes and must return an integer value.
maAttribute :: Lens' MathActivity Text Source #
The name of the attribute that will contain the result of the math operation.
maMath :: Lens' MathActivity Text Source #
An expression that uses one or more existing attributes and must return an integer value.
Message
Information about a message.
See: message
smart constructor.
Creates a value of Message
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mMessageId
- The ID you wish to assign to the message.mPayload
- The payload of the message.-- Note: ThisLens
automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. ThisLens
accepts and returns only raw unencoded data.
mPayload :: Lens' Message ByteString Source #
The payload of the message.-- Note: This Lens
automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens
accepts and returns only raw unencoded data.
Pipeline
Contains information about a pipeline.
See: pipeline
smart constructor.
Creates a value of Pipeline
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pCreationTime
- When the pipeline was created.pArn
- The ARN of the pipeline.pActivities
- The activities that perform transformations on the messages.pName
- The name of the pipeline.pReprocessingSummaries
- A summary of information about the pipeline reprocessing.pLastUpdateTime
- The last time the pipeline was updated.
pActivities :: Lens' Pipeline (Maybe (NonEmpty PipelineActivity)) Source #
The activities that perform transformations on the messages.
pReprocessingSummaries :: Lens' Pipeline [ReprocessingSummary] Source #
A summary of information about the pipeline reprocessing.
PipelineActivity
data PipelineActivity Source #
An activity that performs a transformation on a message.
See: pipelineActivity
smart constructor.
pipelineActivity :: PipelineActivity Source #
Creates a value of PipelineActivity
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
paSelectAttributes
- Creates a new message using only the specified attributes from the original message.paChannel
- Determines the source of the messages to be processed.paAddAttributes
- Adds other attributes based on existing attributes in the message.paDeviceRegistryEnrich
- Adds data from the AWS IoT device registry to your message.paRemoveAttributes
- Removes attributes from a message.paLambda
- Runs a Lambda function to modify the message.paDatastore
- Specifies where to store the processed message data.paDeviceShadowEnrich
- Adds information from the AWS IoT Device Shadows service to a message.paFilter
- Filters a message based on its attributes.paMath
- Computes an arithmetic expression using the message's attributes and adds it to the message.
paSelectAttributes :: Lens' PipelineActivity (Maybe SelectAttributesActivity) Source #
Creates a new message using only the specified attributes from the original message.
paChannel :: Lens' PipelineActivity (Maybe ChannelActivity) Source #
Determines the source of the messages to be processed.
paAddAttributes :: Lens' PipelineActivity (Maybe AddAttributesActivity) Source #
Adds other attributes based on existing attributes in the message.
paDeviceRegistryEnrich :: Lens' PipelineActivity (Maybe DeviceRegistryEnrichActivity) Source #
Adds data from the AWS IoT device registry to your message.
paRemoveAttributes :: Lens' PipelineActivity (Maybe RemoveAttributesActivity) Source #
Removes attributes from a message.
paLambda :: Lens' PipelineActivity (Maybe LambdaActivity) Source #
Runs a Lambda function to modify the message.
paDatastore :: Lens' PipelineActivity (Maybe DatastoreActivity) Source #
Specifies where to store the processed message data.
paDeviceShadowEnrich :: Lens' PipelineActivity (Maybe DeviceShadowEnrichActivity) Source #
Adds information from the AWS IoT Device Shadows service to a message.
paFilter :: Lens' PipelineActivity (Maybe FilterActivity) Source #
Filters a message based on its attributes.
paMath :: Lens' PipelineActivity (Maybe MathActivity) Source #
Computes an arithmetic expression using the message's attributes and adds it to the message.
PipelineSummary
data PipelineSummary Source #
A summary of information about a pipeline.
See: pipelineSummary
smart constructor.
pipelineSummary :: PipelineSummary Source #
Creates a value of PipelineSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
psCreationTime
- When the pipeline was created.psPipelineName
- The name of the pipeline.psReprocessingSummaries
- A summary of information about the pipeline reprocessing.psLastUpdateTime
- When the pipeline was last updated.
psCreationTime :: Lens' PipelineSummary (Maybe UTCTime) Source #
When the pipeline was created.
psPipelineName :: Lens' PipelineSummary (Maybe Text) Source #
The name of the pipeline.
psReprocessingSummaries :: Lens' PipelineSummary [ReprocessingSummary] Source #
A summary of information about the pipeline reprocessing.
psLastUpdateTime :: Lens' PipelineSummary (Maybe UTCTime) Source #
When the pipeline was last updated.
RemoveAttributesActivity
data RemoveAttributesActivity Source #
An activity that removes attributes from a message.
See: removeAttributesActivity
smart constructor.
removeAttributesActivity Source #
Creates a value of RemoveAttributesActivity
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
raaNext
- The next activity in the pipeline.raaName
- The name of theremoveAttributes
activity.raaAttributes
- A list of 1-50 attributes to remove from the message.
raaAttributes :: Lens' RemoveAttributesActivity (NonEmpty Text) Source #
A list of 1-50 attributes to remove from the message.
ReprocessingSummary
data ReprocessingSummary Source #
Information about pipeline reprocessing.
See: reprocessingSummary
smart constructor.
reprocessingSummary :: ReprocessingSummary Source #
Creates a value of ReprocessingSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rsCreationTime
- The time the pipeline reprocessing was created.rsStatus
- The status of the pipeline reprocessing.rsId
- ThereprocessingId
returned by StartPipelineReprocessing.
rsCreationTime :: Lens' ReprocessingSummary (Maybe UTCTime) Source #
The time the pipeline reprocessing was created.
rsStatus :: Lens' ReprocessingSummary (Maybe ReprocessingStatus) Source #
The status of the pipeline reprocessing.
rsId :: Lens' ReprocessingSummary (Maybe Text) Source #
The reprocessingId
returned by StartPipelineReprocessing.
RetentionPeriod
data RetentionPeriod Source #
How long, in days, message data is kept.
See: retentionPeriod
smart constructor.
retentionPeriod :: RetentionPeriod Source #
Creates a value of RetentionPeriod
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rpUnlimited
- If true, message data is kept indefinitely.rpNumberOfDays
- The number of days that message data is kept. The "unlimited" parameter must be false.
rpUnlimited :: Lens' RetentionPeriod (Maybe Bool) Source #
If true, message data is kept indefinitely.
rpNumberOfDays :: Lens' RetentionPeriod (Maybe Natural) Source #
The number of days that message data is kept. The "unlimited" parameter must be false.
Schedule
The schedule for when to trigger an update.
See: schedule
smart constructor.
Creates a value of Schedule
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sExpression
- The expression that defines when to trigger an update. For more information, see Schedule Expressions for Rules in the Amazon CloudWatch documentation.
sExpression :: Lens' Schedule (Maybe Text) Source #
The expression that defines when to trigger an update. For more information, see Schedule Expressions for Rules in the Amazon CloudWatch documentation.
SelectAttributesActivity
data SelectAttributesActivity Source #
Creates a new message using only the specified attributes from the original message.
See: selectAttributesActivity
smart constructor.
selectAttributesActivity Source #
Creates a value of SelectAttributesActivity
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
saaNext
- The next activity in the pipeline.saaName
- The name of theselectAttributes
activity.saaAttributes
- A list of the attributes to select from the message.
saaAttributes :: Lens' SelectAttributesActivity (NonEmpty Text) Source #
A list of the attributes to select from the message.
SqlQueryDatasetAction
data SqlQueryDatasetAction Source #
The SQL query to modify the message.
See: sqlQueryDatasetAction
smart constructor.
sqlQueryDatasetAction Source #
Creates a value of SqlQueryDatasetAction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sqdaSqlQuery
- An SQL query string.
sqdaSqlQuery :: Lens' SqlQueryDatasetAction Text Source #
An SQL query string.