| Copyright | (c) 2013-2021 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 |
Amazonka.IoTAnalytics
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- DescribePipeline
- DescribeDataset
- ListChannels (Paginated)
- ListDatasetContents (Paginated)
- PutLoggingOptions
- ListTagsForResource
- DeleteChannel
- UpdateChannel
- SampleChannelData
- CancelPipelineReprocessing
- CreateDatastore
- UpdatePipeline
- DeletePipeline
- DeleteDataset
- UpdateDataset
- ListPipelines (Paginated)
- DeleteDatastore
- UpdateDatastore
- CreateDataset
- BatchPutMessage
- ListDatastores (Paginated)
- CreateDatasetContent
- CreateChannel
- DeleteDatasetContent
- DescribeDatastore
- GetDatasetContent
- TagResource
- ListDatasets (Paginated)
- UntagResource
- RunPipelineActivity
- DescribeChannel
- CreatePipeline
- StartPipelineReprocessing
- DescribeLoggingOptions
- Types
- ChannelStatus
- ComputeType
- DatasetActionType
- DatasetContentState
- DatasetStatus
- DatastoreStatus
- FileFormatType
- LoggingLevel
- ReprocessingStatus
- AddAttributesActivity
- BatchPutMessageErrorEntry
- Channel
- ChannelActivity
- ChannelMessages
- ChannelStatistics
- ChannelStorage
- ChannelStorageSummary
- ChannelSummary
- Column
- ContainerDatasetAction
- CustomerManagedChannelS3Storage
- CustomerManagedChannelS3StorageSummary
- CustomerManagedDatastoreS3Storage
- CustomerManagedDatastoreS3StorageSummary
- Dataset
- DatasetAction
- DatasetActionSummary
- DatasetContentDeliveryDestination
- DatasetContentDeliveryRule
- DatasetContentStatus
- DatasetContentSummary
- DatasetContentVersionValue
- DatasetEntry
- DatasetSummary
- DatasetTrigger
- Datastore
- DatastoreActivity
- DatastoreIotSiteWiseMultiLayerStorage
- DatastoreIotSiteWiseMultiLayerStorageSummary
- DatastorePartition
- DatastorePartitions
- DatastoreStatistics
- DatastoreStorage
- DatastoreStorageSummary
- DatastoreSummary
- DeltaTime
- DeltaTimeSessionWindowConfiguration
- DeviceRegistryEnrichActivity
- DeviceShadowEnrichActivity
- EstimatedResourceSize
- FileFormatConfiguration
- FilterActivity
- GlueConfiguration
- IotEventsDestinationConfiguration
- IotSiteWiseCustomerManagedDatastoreS3Storage
- IotSiteWiseCustomerManagedDatastoreS3StorageSummary
- JsonConfiguration
- LambdaActivity
- LateDataRule
- LateDataRuleConfiguration
- LoggingOptions
- MathActivity
- Message
- OutputFileUriValue
- ParquetConfiguration
- Partition
- Pipeline
- PipelineActivity
- PipelineSummary
- QueryFilter
- RemoveAttributesActivity
- ReprocessingSummary
- ResourceConfiguration
- RetentionPeriod
- S3DestinationConfiguration
- Schedule
- SchemaDefinition
- SelectAttributesActivity
- ServiceManagedChannelS3Storage
- ServiceManagedChannelS3StorageSummary
- ServiceManagedDatastoreS3Storage
- ServiceManagedDatastoreS3StorageSummary
- SqlQueryDatasetAction
- Tag
- TimestampPartition
- TriggeringDataset
- Variable
- VersioningConfiguration
Description
Derived from API version 2017-11-27 of the AWS service descriptions, licensed under Apache 2.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.
Synopsis
- defaultService :: 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
- data DescribePipeline = DescribePipeline' Text
- newDescribePipeline :: Text -> DescribePipeline
- data DescribePipelineResponse = DescribePipelineResponse' (Maybe Pipeline) Int
- newDescribePipelineResponse :: Int -> DescribePipelineResponse
- data DescribeDataset = DescribeDataset' Text
- newDescribeDataset :: Text -> DescribeDataset
- data DescribeDatasetResponse = DescribeDatasetResponse' (Maybe Dataset) Int
- newDescribeDatasetResponse :: Int -> DescribeDatasetResponse
- data ListChannels = ListChannels' (Maybe Text) (Maybe Natural)
- newListChannels :: ListChannels
- data ListChannelsResponse = ListChannelsResponse' (Maybe [ChannelSummary]) (Maybe Text) Int
- newListChannelsResponse :: Int -> ListChannelsResponse
- data ListDatasetContents = ListDatasetContents' (Maybe Text) (Maybe POSIX) (Maybe Natural) (Maybe POSIX) Text
- newListDatasetContents :: Text -> ListDatasetContents
- data ListDatasetContentsResponse = ListDatasetContentsResponse' (Maybe [DatasetContentSummary]) (Maybe Text) Int
- newListDatasetContentsResponse :: Int -> ListDatasetContentsResponse
- data PutLoggingOptions = PutLoggingOptions' LoggingOptions
- newPutLoggingOptions :: LoggingOptions -> PutLoggingOptions
- data PutLoggingOptionsResponse = PutLoggingOptionsResponse' {
- newPutLoggingOptionsResponse :: PutLoggingOptionsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (NonEmpty Tag)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data DeleteChannel = DeleteChannel' Text
- newDeleteChannel :: Text -> DeleteChannel
- data DeleteChannelResponse = DeleteChannelResponse' {
- newDeleteChannelResponse :: DeleteChannelResponse
- data UpdateChannel = UpdateChannel' (Maybe RetentionPeriod) (Maybe ChannelStorage) Text
- newUpdateChannel :: Text -> UpdateChannel
- data UpdateChannelResponse = UpdateChannelResponse' {
- newUpdateChannelResponse :: UpdateChannelResponse
- data SampleChannelData = SampleChannelData' (Maybe POSIX) (Maybe Natural) (Maybe POSIX) Text
- newSampleChannelData :: Text -> SampleChannelData
- data SampleChannelDataResponse = SampleChannelDataResponse' (Maybe (NonEmpty Base64)) Int
- newSampleChannelDataResponse :: Int -> SampleChannelDataResponse
- data CancelPipelineReprocessing = CancelPipelineReprocessing' Text Text
- newCancelPipelineReprocessing :: Text -> Text -> CancelPipelineReprocessing
- data CancelPipelineReprocessingResponse = CancelPipelineReprocessingResponse' Int
- newCancelPipelineReprocessingResponse :: Int -> CancelPipelineReprocessingResponse
- data CreateDatastore = CreateDatastore' (Maybe FileFormatConfiguration) (Maybe DatastorePartitions) (Maybe RetentionPeriod) (Maybe DatastoreStorage) (Maybe (NonEmpty Tag)) Text
- newCreateDatastore :: Text -> CreateDatastore
- data CreateDatastoreResponse = CreateDatastoreResponse' (Maybe Text) (Maybe Text) (Maybe RetentionPeriod) Int
- newCreateDatastoreResponse :: Int -> CreateDatastoreResponse
- data UpdatePipeline = UpdatePipeline' Text (NonEmpty PipelineActivity)
- newUpdatePipeline :: Text -> NonEmpty PipelineActivity -> UpdatePipeline
- data UpdatePipelineResponse = UpdatePipelineResponse' {
- newUpdatePipelineResponse :: UpdatePipelineResponse
- data DeletePipeline = DeletePipeline' Text
- newDeletePipeline :: Text -> DeletePipeline
- data DeletePipelineResponse = DeletePipelineResponse' {
- newDeletePipelineResponse :: DeletePipelineResponse
- data DeleteDataset = DeleteDataset' Text
- newDeleteDataset :: Text -> DeleteDataset
- data DeleteDatasetResponse = DeleteDatasetResponse' {
- newDeleteDatasetResponse :: DeleteDatasetResponse
- data UpdateDataset = UpdateDataset' (Maybe VersioningConfiguration) (Maybe [DatasetTrigger]) (Maybe RetentionPeriod) (Maybe (NonEmpty LateDataRule)) (Maybe [DatasetContentDeliveryRule]) Text (NonEmpty DatasetAction)
- newUpdateDataset :: Text -> NonEmpty DatasetAction -> UpdateDataset
- data UpdateDatasetResponse = UpdateDatasetResponse' {
- newUpdateDatasetResponse :: UpdateDatasetResponse
- data ListPipelines = ListPipelines' (Maybe Text) (Maybe Natural)
- newListPipelines :: ListPipelines
- data ListPipelinesResponse = ListPipelinesResponse' (Maybe [PipelineSummary]) (Maybe Text) Int
- newListPipelinesResponse :: Int -> ListPipelinesResponse
- data DeleteDatastore = DeleteDatastore' Text
- newDeleteDatastore :: Text -> DeleteDatastore
- data DeleteDatastoreResponse = DeleteDatastoreResponse' {
- newDeleteDatastoreResponse :: DeleteDatastoreResponse
- data UpdateDatastore = UpdateDatastore' (Maybe FileFormatConfiguration) (Maybe RetentionPeriod) (Maybe DatastoreStorage) Text
- newUpdateDatastore :: Text -> UpdateDatastore
- data UpdateDatastoreResponse = UpdateDatastoreResponse' {
- newUpdateDatastoreResponse :: UpdateDatastoreResponse
- data CreateDataset = CreateDataset' (Maybe VersioningConfiguration) (Maybe [DatasetTrigger]) (Maybe RetentionPeriod) (Maybe (NonEmpty LateDataRule)) (Maybe [DatasetContentDeliveryRule]) (Maybe (NonEmpty Tag)) Text (NonEmpty DatasetAction)
- newCreateDataset :: Text -> NonEmpty DatasetAction -> CreateDataset
- data CreateDatasetResponse = CreateDatasetResponse' (Maybe Text) (Maybe RetentionPeriod) (Maybe Text) Int
- newCreateDatasetResponse :: Int -> CreateDatasetResponse
- data BatchPutMessage = BatchPutMessage' Text [Message]
- newBatchPutMessage :: Text -> BatchPutMessage
- data BatchPutMessageResponse = BatchPutMessageResponse' (Maybe [BatchPutMessageErrorEntry]) Int
- newBatchPutMessageResponse :: Int -> BatchPutMessageResponse
- data ListDatastores = ListDatastores' (Maybe Text) (Maybe Natural)
- newListDatastores :: ListDatastores
- data ListDatastoresResponse = ListDatastoresResponse' (Maybe Text) (Maybe [DatastoreSummary]) Int
- newListDatastoresResponse :: Int -> ListDatastoresResponse
- data CreateDatasetContent = CreateDatasetContent' (Maybe Text) Text
- newCreateDatasetContent :: Text -> CreateDatasetContent
- data CreateDatasetContentResponse = CreateDatasetContentResponse' (Maybe Text) Int
- newCreateDatasetContentResponse :: Int -> CreateDatasetContentResponse
- data CreateChannel = CreateChannel' (Maybe RetentionPeriod) (Maybe ChannelStorage) (Maybe (NonEmpty Tag)) Text
- newCreateChannel :: Text -> CreateChannel
- data CreateChannelResponse = CreateChannelResponse' (Maybe Text) (Maybe RetentionPeriod) (Maybe Text) Int
- newCreateChannelResponse :: Int -> CreateChannelResponse
- data DeleteDatasetContent = DeleteDatasetContent' (Maybe Text) Text
- newDeleteDatasetContent :: Text -> DeleteDatasetContent
- data DeleteDatasetContentResponse = DeleteDatasetContentResponse' {
- newDeleteDatasetContentResponse :: DeleteDatasetContentResponse
- data DescribeDatastore = DescribeDatastore' (Maybe Bool) Text
- newDescribeDatastore :: Text -> DescribeDatastore
- data DescribeDatastoreResponse = DescribeDatastoreResponse' (Maybe Datastore) (Maybe DatastoreStatistics) Int
- newDescribeDatastoreResponse :: Int -> DescribeDatastoreResponse
- data GetDatasetContent = GetDatasetContent' (Maybe Text) Text
- newGetDatasetContent :: Text -> GetDatasetContent
- data GetDatasetContentResponse = GetDatasetContentResponse' (Maybe DatasetContentStatus) (Maybe [DatasetEntry]) (Maybe POSIX) Int
- newGetDatasetContentResponse :: Int -> GetDatasetContentResponse
- data TagResource = TagResource' Text (NonEmpty Tag)
- newTagResource :: Text -> NonEmpty Tag -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data ListDatasets = ListDatasets' (Maybe Text) (Maybe Natural)
- newListDatasets :: ListDatasets
- data ListDatasetsResponse = ListDatasetsResponse' (Maybe Text) (Maybe [DatasetSummary]) Int
- newListDatasetsResponse :: Int -> ListDatasetsResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data RunPipelineActivity = RunPipelineActivity' PipelineActivity (NonEmpty Base64)
- newRunPipelineActivity :: PipelineActivity -> NonEmpty ByteString -> RunPipelineActivity
- data RunPipelineActivityResponse = RunPipelineActivityResponse' (Maybe Text) (Maybe (NonEmpty Base64)) Int
- newRunPipelineActivityResponse :: Int -> RunPipelineActivityResponse
- data DescribeChannel = DescribeChannel' (Maybe Bool) Text
- newDescribeChannel :: Text -> DescribeChannel
- data DescribeChannelResponse = DescribeChannelResponse' (Maybe Channel) (Maybe ChannelStatistics) Int
- newDescribeChannelResponse :: Int -> DescribeChannelResponse
- data CreatePipeline = CreatePipeline' (Maybe (NonEmpty Tag)) Text (NonEmpty PipelineActivity)
- newCreatePipeline :: Text -> NonEmpty PipelineActivity -> CreatePipeline
- data CreatePipelineResponse = CreatePipelineResponse' (Maybe Text) (Maybe Text) Int
- newCreatePipelineResponse :: Int -> CreatePipelineResponse
- data StartPipelineReprocessing = StartPipelineReprocessing' (Maybe POSIX) (Maybe POSIX) (Maybe ChannelMessages) Text
- newStartPipelineReprocessing :: Text -> StartPipelineReprocessing
- data StartPipelineReprocessingResponse = StartPipelineReprocessingResponse' (Maybe Text) Int
- newStartPipelineReprocessingResponse :: Int -> StartPipelineReprocessingResponse
- data DescribeLoggingOptions = DescribeLoggingOptions' {
- newDescribeLoggingOptions :: DescribeLoggingOptions
- data DescribeLoggingOptionsResponse = DescribeLoggingOptionsResponse' (Maybe LoggingOptions) Int
- newDescribeLoggingOptionsResponse :: Int -> DescribeLoggingOptionsResponse
- newtype ChannelStatus where
- ChannelStatus' { }
- pattern ChannelStatus_ACTIVE :: ChannelStatus
- pattern ChannelStatus_CREATING :: ChannelStatus
- pattern ChannelStatus_DELETING :: ChannelStatus
- newtype ComputeType where
- ComputeType' { }
- pattern ComputeType_ACU_1 :: ComputeType
- pattern ComputeType_ACU_2 :: ComputeType
- newtype DatasetActionType where
- DatasetActionType' { }
- pattern DatasetActionType_CONTAINER :: DatasetActionType
- pattern DatasetActionType_QUERY :: DatasetActionType
- newtype DatasetContentState where
- newtype DatasetStatus where
- DatasetStatus' { }
- pattern DatasetStatus_ACTIVE :: DatasetStatus
- pattern DatasetStatus_CREATING :: DatasetStatus
- pattern DatasetStatus_DELETING :: DatasetStatus
- newtype DatastoreStatus where
- DatastoreStatus' { }
- pattern DatastoreStatus_ACTIVE :: DatastoreStatus
- pattern DatastoreStatus_CREATING :: DatastoreStatus
- pattern DatastoreStatus_DELETING :: DatastoreStatus
- newtype FileFormatType where
- FileFormatType' { }
- pattern FileFormatType_JSON :: FileFormatType
- pattern FileFormatType_PARQUET :: FileFormatType
- newtype LoggingLevel where
- LoggingLevel' { }
- pattern LoggingLevel_ERROR :: LoggingLevel
- newtype ReprocessingStatus where
- ReprocessingStatus' { }
- pattern ReprocessingStatus_CANCELLED :: ReprocessingStatus
- pattern ReprocessingStatus_FAILED :: ReprocessingStatus
- pattern ReprocessingStatus_RUNNING :: ReprocessingStatus
- pattern ReprocessingStatus_SUCCEEDED :: ReprocessingStatus
- data AddAttributesActivity = AddAttributesActivity' (Maybe Text) Text (HashMap Text Text)
- newAddAttributesActivity :: Text -> AddAttributesActivity
- data BatchPutMessageErrorEntry = BatchPutMessageErrorEntry' (Maybe Text) (Maybe Text) (Maybe Text)
- newBatchPutMessageErrorEntry :: BatchPutMessageErrorEntry
- data Channel = Channel' (Maybe POSIX) (Maybe ChannelStatus) (Maybe POSIX) (Maybe Text) (Maybe ChannelStorage) (Maybe RetentionPeriod) (Maybe Text) (Maybe POSIX)
- newChannel :: Channel
- data ChannelActivity = ChannelActivity' (Maybe Text) Text Text
- newChannelActivity :: Text -> Text -> ChannelActivity
- data ChannelMessages = ChannelMessages' (Maybe (NonEmpty Text))
- newChannelMessages :: ChannelMessages
- data ChannelStatistics = ChannelStatistics' (Maybe EstimatedResourceSize)
- newChannelStatistics :: ChannelStatistics
- data ChannelStorage = ChannelStorage' (Maybe ServiceManagedChannelS3Storage) (Maybe CustomerManagedChannelS3Storage)
- newChannelStorage :: ChannelStorage
- data ChannelStorageSummary = ChannelStorageSummary' (Maybe ServiceManagedChannelS3StorageSummary) (Maybe CustomerManagedChannelS3StorageSummary)
- newChannelStorageSummary :: ChannelStorageSummary
- data ChannelSummary = ChannelSummary' (Maybe POSIX) (Maybe ChannelStatus) (Maybe POSIX) (Maybe Text) (Maybe ChannelStorageSummary) (Maybe POSIX)
- newChannelSummary :: ChannelSummary
- data Column = Column' Text Text
- newColumn :: Text -> Text -> Column
- data ContainerDatasetAction = ContainerDatasetAction' (Maybe [Variable]) Text Text ResourceConfiguration
- newContainerDatasetAction :: Text -> Text -> ResourceConfiguration -> ContainerDatasetAction
- data CustomerManagedChannelS3Storage = CustomerManagedChannelS3Storage' (Maybe Text) Text Text
- newCustomerManagedChannelS3Storage :: Text -> Text -> CustomerManagedChannelS3Storage
- data CustomerManagedChannelS3StorageSummary = CustomerManagedChannelS3StorageSummary' (Maybe Text) (Maybe Text) (Maybe Text)
- newCustomerManagedChannelS3StorageSummary :: CustomerManagedChannelS3StorageSummary
- data CustomerManagedDatastoreS3Storage = CustomerManagedDatastoreS3Storage' (Maybe Text) Text Text
- newCustomerManagedDatastoreS3Storage :: Text -> Text -> CustomerManagedDatastoreS3Storage
- data CustomerManagedDatastoreS3StorageSummary = CustomerManagedDatastoreS3StorageSummary' (Maybe Text) (Maybe Text) (Maybe Text)
- newCustomerManagedDatastoreS3StorageSummary :: CustomerManagedDatastoreS3StorageSummary
- data Dataset = Dataset' (Maybe POSIX) (Maybe DatasetStatus) (Maybe VersioningConfiguration) (Maybe Text) (Maybe (NonEmpty DatasetAction)) (Maybe [DatasetTrigger]) (Maybe RetentionPeriod) (Maybe (NonEmpty LateDataRule)) (Maybe Text) (Maybe [DatasetContentDeliveryRule]) (Maybe POSIX)
- newDataset :: Dataset
- data DatasetAction = DatasetAction' (Maybe SqlQueryDatasetAction) (Maybe Text) (Maybe ContainerDatasetAction)
- newDatasetAction :: DatasetAction
- data DatasetActionSummary = DatasetActionSummary' (Maybe Text) (Maybe DatasetActionType)
- newDatasetActionSummary :: DatasetActionSummary
- data DatasetContentDeliveryDestination = DatasetContentDeliveryDestination' (Maybe S3DestinationConfiguration) (Maybe IotEventsDestinationConfiguration)
- newDatasetContentDeliveryDestination :: DatasetContentDeliveryDestination
- data DatasetContentDeliveryRule = DatasetContentDeliveryRule' (Maybe Text) DatasetContentDeliveryDestination
- newDatasetContentDeliveryRule :: DatasetContentDeliveryDestination -> DatasetContentDeliveryRule
- data DatasetContentStatus = DatasetContentStatus' (Maybe DatasetContentState) (Maybe Text)
- newDatasetContentStatus :: DatasetContentStatus
- data DatasetContentSummary = DatasetContentSummary' (Maybe POSIX) (Maybe DatasetContentStatus) (Maybe POSIX) (Maybe POSIX) (Maybe Text)
- newDatasetContentSummary :: DatasetContentSummary
- data DatasetContentVersionValue = DatasetContentVersionValue' Text
- newDatasetContentVersionValue :: Text -> DatasetContentVersionValue
- data DatasetEntry = DatasetEntry' (Maybe Text) (Maybe Text)
- newDatasetEntry :: DatasetEntry
- data DatasetSummary = DatasetSummary' (Maybe POSIX) (Maybe DatasetStatus) (Maybe (NonEmpty DatasetActionSummary)) (Maybe [DatasetTrigger]) (Maybe Text) (Maybe POSIX)
- newDatasetSummary :: DatasetSummary
- data DatasetTrigger = DatasetTrigger' (Maybe TriggeringDataset) (Maybe Schedule)
- newDatasetTrigger :: DatasetTrigger
- data Datastore = Datastore' (Maybe POSIX) (Maybe DatastoreStatus) (Maybe POSIX) (Maybe Text) (Maybe FileFormatConfiguration) (Maybe DatastorePartitions) (Maybe DatastoreStorage) (Maybe RetentionPeriod) (Maybe Text) (Maybe POSIX)
- newDatastore :: Datastore
- data DatastoreActivity = DatastoreActivity' Text Text
- newDatastoreActivity :: Text -> Text -> DatastoreActivity
- data DatastoreIotSiteWiseMultiLayerStorage = DatastoreIotSiteWiseMultiLayerStorage' IotSiteWiseCustomerManagedDatastoreS3Storage
- newDatastoreIotSiteWiseMultiLayerStorage :: IotSiteWiseCustomerManagedDatastoreS3Storage -> DatastoreIotSiteWiseMultiLayerStorage
- data DatastoreIotSiteWiseMultiLayerStorageSummary = DatastoreIotSiteWiseMultiLayerStorageSummary' (Maybe IotSiteWiseCustomerManagedDatastoreS3StorageSummary)
- newDatastoreIotSiteWiseMultiLayerStorageSummary :: DatastoreIotSiteWiseMultiLayerStorageSummary
- data DatastorePartition = DatastorePartition' (Maybe Partition) (Maybe TimestampPartition)
- newDatastorePartition :: DatastorePartition
- data DatastorePartitions = DatastorePartitions' (Maybe [DatastorePartition])
- newDatastorePartitions :: DatastorePartitions
- data DatastoreStatistics = DatastoreStatistics' (Maybe EstimatedResourceSize)
- newDatastoreStatistics :: DatastoreStatistics
- data DatastoreStorage = DatastoreStorage' (Maybe ServiceManagedDatastoreS3Storage) (Maybe CustomerManagedDatastoreS3Storage) (Maybe DatastoreIotSiteWiseMultiLayerStorage)
- newDatastoreStorage :: DatastoreStorage
- data DatastoreStorageSummary = DatastoreStorageSummary' (Maybe ServiceManagedDatastoreS3StorageSummary) (Maybe CustomerManagedDatastoreS3StorageSummary) (Maybe DatastoreIotSiteWiseMultiLayerStorageSummary)
- newDatastoreStorageSummary :: DatastoreStorageSummary
- data DatastoreSummary = DatastoreSummary' (Maybe POSIX) (Maybe DatastoreStatus) (Maybe POSIX) (Maybe Text) (Maybe DatastorePartitions) (Maybe FileFormatType) (Maybe POSIX) (Maybe DatastoreStorageSummary)
- newDatastoreSummary :: DatastoreSummary
- data DeltaTime = DeltaTime' Int Text
- newDeltaTime :: Int -> Text -> DeltaTime
- data DeltaTimeSessionWindowConfiguration = DeltaTimeSessionWindowConfiguration' Natural
- newDeltaTimeSessionWindowConfiguration :: Natural -> DeltaTimeSessionWindowConfiguration
- data DeviceRegistryEnrichActivity = DeviceRegistryEnrichActivity' (Maybe Text) Text Text Text Text
- newDeviceRegistryEnrichActivity :: Text -> Text -> Text -> Text -> DeviceRegistryEnrichActivity
- data DeviceShadowEnrichActivity = DeviceShadowEnrichActivity' (Maybe Text) Text Text Text Text
- newDeviceShadowEnrichActivity :: Text -> Text -> Text -> Text -> DeviceShadowEnrichActivity
- data EstimatedResourceSize = EstimatedResourceSize' (Maybe POSIX) (Maybe Double)
- newEstimatedResourceSize :: EstimatedResourceSize
- data FileFormatConfiguration = FileFormatConfiguration' (Maybe JsonConfiguration) (Maybe ParquetConfiguration)
- newFileFormatConfiguration :: FileFormatConfiguration
- data FilterActivity = FilterActivity' (Maybe Text) Text Text
- newFilterActivity :: Text -> Text -> FilterActivity
- data GlueConfiguration = GlueConfiguration' Text Text
- newGlueConfiguration :: Text -> Text -> GlueConfiguration
- data IotEventsDestinationConfiguration = IotEventsDestinationConfiguration' Text Text
- newIotEventsDestinationConfiguration :: Text -> Text -> IotEventsDestinationConfiguration
- data IotSiteWiseCustomerManagedDatastoreS3Storage = IotSiteWiseCustomerManagedDatastoreS3Storage' (Maybe Text) Text
- newIotSiteWiseCustomerManagedDatastoreS3Storage :: Text -> IotSiteWiseCustomerManagedDatastoreS3Storage
- data IotSiteWiseCustomerManagedDatastoreS3StorageSummary = IotSiteWiseCustomerManagedDatastoreS3StorageSummary' (Maybe Text) (Maybe Text)
- newIotSiteWiseCustomerManagedDatastoreS3StorageSummary :: IotSiteWiseCustomerManagedDatastoreS3StorageSummary
- data JsonConfiguration = JsonConfiguration' {
- newJsonConfiguration :: JsonConfiguration
- data LambdaActivity = LambdaActivity' (Maybe Text) Text Text Natural
- newLambdaActivity :: Text -> Text -> Natural -> LambdaActivity
- data LateDataRule = LateDataRule' (Maybe Text) LateDataRuleConfiguration
- newLateDataRule :: LateDataRuleConfiguration -> LateDataRule
- data LateDataRuleConfiguration = LateDataRuleConfiguration' (Maybe DeltaTimeSessionWindowConfiguration)
- newLateDataRuleConfiguration :: LateDataRuleConfiguration
- data LoggingOptions = LoggingOptions' Text LoggingLevel Bool
- newLoggingOptions :: Text -> LoggingLevel -> Bool -> LoggingOptions
- data MathActivity = MathActivity' (Maybe Text) Text Text Text
- newMathActivity :: Text -> Text -> Text -> MathActivity
- data Message = Message' Text Base64
- newMessage :: Text -> ByteString -> Message
- data OutputFileUriValue = OutputFileUriValue' Text
- newOutputFileUriValue :: Text -> OutputFileUriValue
- data ParquetConfiguration = ParquetConfiguration' (Maybe SchemaDefinition)
- newParquetConfiguration :: ParquetConfiguration
- data Partition = Partition' Text
- newPartition :: Text -> Partition
- data Pipeline = Pipeline' (Maybe POSIX) (Maybe Text) (Maybe (NonEmpty PipelineActivity)) (Maybe Text) (Maybe [ReprocessingSummary]) (Maybe POSIX)
- newPipeline :: Pipeline
- data PipelineActivity = PipelineActivity' (Maybe SelectAttributesActivity) (Maybe ChannelActivity) (Maybe AddAttributesActivity) (Maybe DeviceRegistryEnrichActivity) (Maybe RemoveAttributesActivity) (Maybe LambdaActivity) (Maybe DatastoreActivity) (Maybe DeviceShadowEnrichActivity) (Maybe FilterActivity) (Maybe MathActivity)
- newPipelineActivity :: PipelineActivity
- data PipelineSummary = PipelineSummary' (Maybe POSIX) (Maybe Text) (Maybe [ReprocessingSummary]) (Maybe POSIX)
- newPipelineSummary :: PipelineSummary
- data QueryFilter = QueryFilter' (Maybe DeltaTime)
- newQueryFilter :: QueryFilter
- data RemoveAttributesActivity = RemoveAttributesActivity' (Maybe Text) Text (NonEmpty Text)
- newRemoveAttributesActivity :: Text -> NonEmpty Text -> RemoveAttributesActivity
- data ReprocessingSummary = ReprocessingSummary' (Maybe POSIX) (Maybe ReprocessingStatus) (Maybe Text)
- newReprocessingSummary :: ReprocessingSummary
- data ResourceConfiguration = ResourceConfiguration' ComputeType Natural
- newResourceConfiguration :: ComputeType -> Natural -> ResourceConfiguration
- data RetentionPeriod = RetentionPeriod' (Maybe Bool) (Maybe Natural)
- newRetentionPeriod :: RetentionPeriod
- data S3DestinationConfiguration = S3DestinationConfiguration' (Maybe GlueConfiguration) Text Text Text
- newS3DestinationConfiguration :: Text -> Text -> Text -> S3DestinationConfiguration
- data Schedule = Schedule' (Maybe Text)
- newSchedule :: Schedule
- data SchemaDefinition = SchemaDefinition' (Maybe [Column])
- newSchemaDefinition :: SchemaDefinition
- data SelectAttributesActivity = SelectAttributesActivity' (Maybe Text) Text (NonEmpty Text)
- newSelectAttributesActivity :: Text -> NonEmpty Text -> SelectAttributesActivity
- data ServiceManagedChannelS3Storage = ServiceManagedChannelS3Storage' {
- newServiceManagedChannelS3Storage :: ServiceManagedChannelS3Storage
- data ServiceManagedChannelS3StorageSummary = ServiceManagedChannelS3StorageSummary' {
- newServiceManagedChannelS3StorageSummary :: ServiceManagedChannelS3StorageSummary
- data ServiceManagedDatastoreS3Storage = ServiceManagedDatastoreS3Storage' {
- newServiceManagedDatastoreS3Storage :: ServiceManagedDatastoreS3Storage
- data ServiceManagedDatastoreS3StorageSummary = ServiceManagedDatastoreS3StorageSummary' {
- newServiceManagedDatastoreS3StorageSummary :: ServiceManagedDatastoreS3StorageSummary
- data SqlQueryDatasetAction = SqlQueryDatasetAction' (Maybe [QueryFilter]) Text
- newSqlQueryDatasetAction :: Text -> SqlQueryDatasetAction
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data TimestampPartition = TimestampPartition' (Maybe Text) Text
- newTimestampPartition :: Text -> TimestampPartition
- data TriggeringDataset = TriggeringDataset' Text
- newTriggeringDataset :: Text -> TriggeringDataset
- data Variable = Variable' (Maybe OutputFileUriValue) (Maybe Double) (Maybe Text) (Maybe DatasetContentVersionValue) Text
- newVariable :: Text -> Variable
- data VersioningConfiguration = VersioningConfiguration' (Maybe Bool) (Maybe Natural)
- newVersioningConfiguration :: VersioningConfiguration
Service Configuration
defaultService :: 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
data DescribePipeline Source #
See: newDescribePipeline smart constructor.
Constructors
| DescribePipeline' Text |
Instances
Arguments
| :: Text | |
| -> DescribePipeline |
Create a value of DescribePipeline with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pipelineName:DescribePipeline', describePipeline_pipelineName - The name of the pipeline whose information is retrieved.
data DescribePipelineResponse Source #
See: newDescribePipelineResponse smart constructor.
Constructors
| DescribePipelineResponse' (Maybe Pipeline) Int |
Instances
newDescribePipelineResponse Source #
Create a value of DescribePipelineResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pipeline:DescribePipelineResponse', describePipelineResponse_pipeline - A Pipeline object that contains information about the pipeline.
$sel:httpStatus:DescribePipelineResponse', describePipelineResponse_httpStatus - The response's http status code.
DescribeDataset
data DescribeDataset Source #
See: newDescribeDataset smart constructor.
Constructors
| DescribeDataset' Text |
Instances
Arguments
| :: Text | |
| -> DescribeDataset |
Create a value of DescribeDataset with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:datasetName:DescribeDataset', describeDataset_datasetName - The name of the dataset whose information is retrieved.
data DescribeDatasetResponse Source #
See: newDescribeDatasetResponse smart constructor.
Constructors
| DescribeDatasetResponse' (Maybe Dataset) Int |
Instances
newDescribeDatasetResponse Source #
Create a value of DescribeDatasetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataset:DescribeDatasetResponse', describeDatasetResponse_dataset - An object that contains information about the dataset.
$sel:httpStatus:DescribeDatasetResponse', describeDatasetResponse_httpStatus - The response's http status code.
ListChannels (Paginated)
data ListChannels Source #
See: newListChannels smart constructor.
Constructors
| ListChannels' (Maybe Text) (Maybe Natural) |
Instances
newListChannels :: ListChannels Source #
Create a value of ListChannels with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListChannels', listChannels_nextToken - The token for the next set of results.
$sel:maxResults:ListChannels', listChannels_maxResults - The maximum number of results to return in this request.
The default value is 100.
data ListChannelsResponse Source #
See: newListChannelsResponse smart constructor.
Constructors
| ListChannelsResponse' (Maybe [ChannelSummary]) (Maybe Text) Int |
Instances
newListChannelsResponse Source #
Arguments
| :: Int | |
| -> ListChannelsResponse |
Create a value of ListChannelsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelSummaries:ListChannelsResponse', listChannelsResponse_channelSummaries - A list of ChannelSummary objects.
$sel:nextToken:ListChannels', listChannelsResponse_nextToken - The token to retrieve the next set of results, or null if there are no
more results.
$sel:httpStatus:ListChannelsResponse', listChannelsResponse_httpStatus - The response's http status code.
ListDatasetContents (Paginated)
data ListDatasetContents Source #
See: newListDatasetContents smart constructor.
Instances
newListDatasetContents Source #
Arguments
| :: Text | |
| -> ListDatasetContents |
Create a value of ListDatasetContents with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListDatasetContents', listDatasetContents_nextToken - The token for the next set of results.
$sel:scheduledBefore:ListDatasetContents', listDatasetContents_scheduledBefore - A filter to limit results to those dataset contents whose creation is
scheduled before the given time. See the field triggers.schedule in
the CreateDataset request. (timestamp)
$sel:maxResults:ListDatasetContents', listDatasetContents_maxResults - The maximum number of results to return in this request.
$sel:scheduledOnOrAfter:ListDatasetContents', listDatasetContents_scheduledOnOrAfter - A filter to limit results to those dataset contents whose creation is
scheduled on or after the given time. See the field triggers.schedule
in the CreateDataset request. (timestamp)
$sel:datasetName:ListDatasetContents', listDatasetContents_datasetName - The name of the dataset whose contents information you want to list.
data ListDatasetContentsResponse Source #
See: newListDatasetContentsResponse smart constructor.
Constructors
| ListDatasetContentsResponse' (Maybe [DatasetContentSummary]) (Maybe Text) Int |
Instances
newListDatasetContentsResponse Source #
Create a value of ListDatasetContentsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:datasetContentSummaries:ListDatasetContentsResponse', listDatasetContentsResponse_datasetContentSummaries - Summary information about dataset contents that have been created.
$sel:nextToken:ListDatasetContents', listDatasetContentsResponse_nextToken - The token to retrieve the next set of results, or null if there are no
more results.
$sel:httpStatus:ListDatasetContentsResponse', listDatasetContentsResponse_httpStatus - The response's http status code.
PutLoggingOptions
data PutLoggingOptions Source #
See: newPutLoggingOptions smart constructor.
Constructors
| PutLoggingOptions' LoggingOptions |
Instances
Create a value of PutLoggingOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:loggingOptions:PutLoggingOptions', putLoggingOptions_loggingOptions - The new values of the IoT Analytics logging options.
data PutLoggingOptionsResponse Source #
See: newPutLoggingOptionsResponse smart constructor.
Constructors
| PutLoggingOptionsResponse' | |
Instances
newPutLoggingOptionsResponse :: PutLoggingOptionsResponse Source #
Create a value of PutLoggingOptionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The ARN of the resource whose tags you want to list.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Constructors
| ListTagsForResourceResponse' (Maybe (NonEmpty Tag)) Int |
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - The tags (metadata) that you have assigned to the resource.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
DeleteChannel
data DeleteChannel Source #
See: newDeleteChannel smart constructor.
Constructors
| DeleteChannel' Text |
Instances
Arguments
| :: Text | |
| -> DeleteChannel |
Create a value of DeleteChannel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelName:DeleteChannel', deleteChannel_channelName - The name of the channel to delete.
data DeleteChannelResponse Source #
See: newDeleteChannelResponse smart constructor.
Constructors
| DeleteChannelResponse' | |
Instances
newDeleteChannelResponse :: DeleteChannelResponse Source #
Create a value of DeleteChannelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateChannel
data UpdateChannel Source #
See: newUpdateChannel smart constructor.
Constructors
| UpdateChannel' (Maybe RetentionPeriod) (Maybe ChannelStorage) Text |
Instances
Arguments
| :: Text | |
| -> UpdateChannel |
Create a value of UpdateChannel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:retentionPeriod:UpdateChannel', updateChannel_retentionPeriod - How long, in days, message data is kept for the channel. The retention
period can't be updated if the channel's Amazon S3 storage is
customer-managed.
$sel:channelStorage:UpdateChannel', updateChannel_channelStorage - Where channel data is stored. You can choose one of serviceManagedS3
or customerManagedS3 storage. If not specified, the default is
serviceManagedS3. You can't change this storage option after the
channel is created.
$sel:channelName:UpdateChannel', updateChannel_channelName - The name of the channel to be updated.
data UpdateChannelResponse Source #
See: newUpdateChannelResponse smart constructor.
Constructors
| UpdateChannelResponse' | |
Instances
newUpdateChannelResponse :: UpdateChannelResponse Source #
Create a value of UpdateChannelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
SampleChannelData
data SampleChannelData Source #
See: newSampleChannelData smart constructor.
Instances
Arguments
| :: Text | |
| -> SampleChannelData |
Create a value of SampleChannelData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:startTime:SampleChannelData', sampleChannelData_startTime - The start of the time window from which sample messages are retrieved.
$sel:maxMessages:SampleChannelData', sampleChannelData_maxMessages - The number of sample messages to be retrieved. The limit is 10. The
default is also 10.
$sel:endTime:SampleChannelData', sampleChannelData_endTime - The end of the time window from which sample messages are retrieved.
$sel:channelName:SampleChannelData', sampleChannelData_channelName - The name of the channel whose message samples are retrieved.
data SampleChannelDataResponse Source #
See: newSampleChannelDataResponse smart constructor.
Constructors
| SampleChannelDataResponse' (Maybe (NonEmpty Base64)) Int |
Instances
newSampleChannelDataResponse Source #
Create a value of SampleChannelDataResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:payloads:SampleChannelDataResponse', sampleChannelDataResponse_payloads - The list of message samples. Each sample message is returned as a
base64-encoded string.
$sel:httpStatus:SampleChannelDataResponse', sampleChannelDataResponse_httpStatus - The response's http status code.
CancelPipelineReprocessing
data CancelPipelineReprocessing Source #
See: newCancelPipelineReprocessing smart constructor.
Constructors
| CancelPipelineReprocessing' Text Text |
Instances
newCancelPipelineReprocessing Source #
Arguments
| :: Text | |
| -> Text | |
| -> CancelPipelineReprocessing |
Create a value of CancelPipelineReprocessing with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pipelineName:CancelPipelineReprocessing', cancelPipelineReprocessing_pipelineName - The name of pipeline for which data reprocessing is canceled.
$sel:reprocessingId:CancelPipelineReprocessing', cancelPipelineReprocessing_reprocessingId - The ID of the reprocessing task (returned by
StartPipelineReprocessing).
data CancelPipelineReprocessingResponse Source #
See: newCancelPipelineReprocessingResponse smart constructor.
Constructors
| CancelPipelineReprocessingResponse' Int |
Instances
newCancelPipelineReprocessingResponse Source #
Arguments
| :: Int | |
| -> CancelPipelineReprocessingResponse |
Create a value of CancelPipelineReprocessingResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CancelPipelineReprocessingResponse', cancelPipelineReprocessingResponse_httpStatus - The response's http status code.
CreateDatastore
data CreateDatastore Source #
See: newCreateDatastore smart constructor.
Constructors
| CreateDatastore' (Maybe FileFormatConfiguration) (Maybe DatastorePartitions) (Maybe RetentionPeriod) (Maybe DatastoreStorage) (Maybe (NonEmpty Tag)) Text |
Instances
Arguments
| :: Text | |
| -> CreateDatastore |
Create a value of CreateDatastore with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileFormatConfiguration:CreateDatastore', createDatastore_fileFormatConfiguration - Contains the configuration information of file formats. 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.
$sel:datastorePartitions:CreateDatastore', createDatastore_datastorePartitions - Contains information about the partition dimensions in a data store.
$sel:retentionPeriod:CreateDatastore', createDatastore_retentionPeriod - How long, in days, message data is kept for the data store. When
customerManagedS3 storage is selected, this parameter is ignored.
$sel:datastoreStorage:CreateDatastore', createDatastore_datastoreStorage - Where data in a data store is stored.. You can choose serviceManagedS3
storage, customerManagedS3 storage, or iotSiteWiseMultiLayerStorage
storage. The default is serviceManagedS3. You can't change the choice
of Amazon S3 storage after your data store is created.
$sel:tags:CreateDatastore', createDatastore_tags - Metadata which can be used to manage the data store.
$sel:datastoreName:CreateDatastore', createDatastore_datastoreName - The name of the data store.
data CreateDatastoreResponse Source #
See: newCreateDatastoreResponse smart constructor.
Constructors
| CreateDatastoreResponse' (Maybe Text) (Maybe Text) (Maybe RetentionPeriod) Int |
Instances
newCreateDatastoreResponse Source #
Create a value of CreateDatastoreResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:datastoreArn:CreateDatastoreResponse', createDatastoreResponse_datastoreArn - The ARN of the data store.
$sel:datastoreName:CreateDatastore', createDatastoreResponse_datastoreName - The name of the data store.
$sel:retentionPeriod:CreateDatastore', createDatastoreResponse_retentionPeriod - How long, in days, message data is kept for the data store.
$sel:httpStatus:CreateDatastoreResponse', createDatastoreResponse_httpStatus - The response's http status code.
UpdatePipeline
data UpdatePipeline Source #
See: newUpdatePipeline smart constructor.
Constructors
| UpdatePipeline' Text (NonEmpty PipelineActivity) |
Instances
Arguments
| :: Text | |
| -> NonEmpty PipelineActivity | |
| -> UpdatePipeline |
Create a value of UpdatePipeline with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pipelineName:UpdatePipeline', updatePipeline_pipelineName - The name of the pipeline to update.
$sel:pipelineActivities:UpdatePipeline', updatePipeline_pipelineActivities - A list of PipelineActivity objects. Activities perform transformations
on your messages, such as removing, renaming or adding message
attributes; filtering messages based on attribute values; invoking your
Lambda functions on messages for advanced processing; or performing
mathematical transformations to normalize device data.
The list can be 2-25 PipelineActivity objects and must contain both a
channel and a datastore activity. Each entry in the list must
contain only one activity. For example:
pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]data UpdatePipelineResponse Source #
See: newUpdatePipelineResponse smart constructor.
Constructors
| UpdatePipelineResponse' | |
Instances
newUpdatePipelineResponse :: UpdatePipelineResponse Source #
Create a value of UpdatePipelineResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeletePipeline
data DeletePipeline Source #
See: newDeletePipeline smart constructor.
Constructors
| DeletePipeline' Text |
Instances
Arguments
| :: Text | |
| -> DeletePipeline |
Create a value of DeletePipeline with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pipelineName:DeletePipeline', deletePipeline_pipelineName - The name of the pipeline to delete.
data DeletePipelineResponse Source #
See: newDeletePipelineResponse smart constructor.
Constructors
| DeletePipelineResponse' | |
Instances
newDeletePipelineResponse :: DeletePipelineResponse Source #
Create a value of DeletePipelineResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteDataset
data DeleteDataset Source #
See: newDeleteDataset smart constructor.
Constructors
| DeleteDataset' Text |
Instances
Arguments
| :: Text | |
| -> DeleteDataset |
Create a value of DeleteDataset with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:datasetName:DeleteDataset', deleteDataset_datasetName - The name of the dataset to delete.
data DeleteDatasetResponse Source #
See: newDeleteDatasetResponse smart constructor.
Constructors
| DeleteDatasetResponse' | |
Instances
newDeleteDatasetResponse :: DeleteDatasetResponse Source #
Create a value of DeleteDatasetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateDataset
data UpdateDataset Source #
See: newUpdateDataset smart constructor.
Constructors
| UpdateDataset' (Maybe VersioningConfiguration) (Maybe [DatasetTrigger]) (Maybe RetentionPeriod) (Maybe (NonEmpty LateDataRule)) (Maybe [DatasetContentDeliveryRule]) Text (NonEmpty DatasetAction) |
Instances
Arguments
| :: Text | |
| -> NonEmpty DatasetAction | |
| -> UpdateDataset |
Create a value of UpdateDataset with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:versioningConfiguration:UpdateDataset', updateDataset_versioningConfiguration - Optional. How many versions of dataset contents are kept. If not
specified or set to null, only the latest version plus the latest
succeeded version (if they are different) are kept for the time period
specified by the retentionPeriod parameter. For more information, see
Keeping Multiple Versions of IoT Analytics datasets
in the IoT Analytics User Guide.
$sel:triggers:UpdateDataset', updateDataset_triggers - A list of DatasetTrigger objects. The list can be empty or can contain
up to five DatasetTrigger objects.
$sel:retentionPeriod:UpdateDataset', updateDataset_retentionPeriod - How long, in days, dataset contents are kept for the dataset.
$sel:lateDataRules:UpdateDataset', updateDataset_lateDataRules - A list of data rules that send notifications to CloudWatch, when data
arrives late. To specify lateDataRules, the dataset must use a
DeltaTimer
filter.
$sel:contentDeliveryRules:UpdateDataset', updateDataset_contentDeliveryRules - When dataset contents are created, they are delivered to destinations
specified here.
$sel:datasetName:UpdateDataset', updateDataset_datasetName - The name of the dataset to update.
$sel:actions:UpdateDataset', updateDataset_actions - A list of DatasetAction objects.
data UpdateDatasetResponse Source #
See: newUpdateDatasetResponse smart constructor.
Constructors
| UpdateDatasetResponse' | |
Instances
newUpdateDatasetResponse :: UpdateDatasetResponse Source #
Create a value of UpdateDatasetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListPipelines (Paginated)
data ListPipelines Source #
See: newListPipelines smart constructor.
Constructors
| ListPipelines' (Maybe Text) (Maybe Natural) |
Instances
newListPipelines :: ListPipelines Source #
Create a value of ListPipelines with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListPipelines', listPipelines_nextToken - The token for the next set of results.
$sel:maxResults:ListPipelines', listPipelines_maxResults - The maximum number of results to return in this request.
The default value is 100.
data ListPipelinesResponse Source #
See: newListPipelinesResponse smart constructor.
Constructors
| ListPipelinesResponse' (Maybe [PipelineSummary]) (Maybe Text) Int |
Instances
newListPipelinesResponse Source #
Create a value of ListPipelinesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pipelineSummaries:ListPipelinesResponse', listPipelinesResponse_pipelineSummaries - A list of PipelineSummary objects.
$sel:nextToken:ListPipelines', listPipelinesResponse_nextToken - The token to retrieve the next set of results, or null if there are no
more results.
$sel:httpStatus:ListPipelinesResponse', listPipelinesResponse_httpStatus - The response's http status code.
DeleteDatastore
data DeleteDatastore Source #
See: newDeleteDatastore smart constructor.
Constructors
| DeleteDatastore' Text |
Instances
Arguments
| :: Text | |
| -> DeleteDatastore |
Create a value of DeleteDatastore with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:datastoreName:DeleteDatastore', deleteDatastore_datastoreName - The name of the data store to delete.
data DeleteDatastoreResponse Source #
See: newDeleteDatastoreResponse smart constructor.
Constructors
| DeleteDatastoreResponse' | |
Instances
newDeleteDatastoreResponse :: DeleteDatastoreResponse Source #
Create a value of DeleteDatastoreResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateDatastore
data UpdateDatastore Source #
See: newUpdateDatastore smart constructor.
Constructors
| UpdateDatastore' (Maybe FileFormatConfiguration) (Maybe RetentionPeriod) (Maybe DatastoreStorage) Text |
Instances
Arguments
| :: Text | |
| -> UpdateDatastore |
Create a value of UpdateDatastore with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileFormatConfiguration:UpdateDatastore', updateDatastore_fileFormatConfiguration - Contains the configuration information of file formats. 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.
$sel:retentionPeriod:UpdateDatastore', updateDatastore_retentionPeriod - How long, in days, message data is kept for the data store. The
retention period can't be updated if the data store's Amazon S3
storage is customer-managed.
$sel:datastoreStorage:UpdateDatastore', updateDatastore_datastoreStorage - Where data in a data store is stored.. You can choose serviceManagedS3
storage, customerManagedS3 storage, or iotSiteWiseMultiLayerStorage
storage. The default is serviceManagedS3. You can't change the choice
of Amazon S3 storage after your data store is created.
$sel:datastoreName:UpdateDatastore', updateDatastore_datastoreName - The name of the data store to be updated.
data UpdateDatastoreResponse Source #
See: newUpdateDatastoreResponse smart constructor.
Constructors
| UpdateDatastoreResponse' | |
Instances
newUpdateDatastoreResponse :: UpdateDatastoreResponse Source #
Create a value of UpdateDatastoreResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
CreateDataset
data CreateDataset Source #
See: newCreateDataset smart constructor.
Constructors
Instances
Arguments
| :: Text | |
| -> NonEmpty DatasetAction | |
| -> CreateDataset |
Create a value of CreateDataset with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:versioningConfiguration:CreateDataset', createDataset_versioningConfiguration - Optional. How many versions of dataset contents are kept. If not
specified or set to null, only the latest version plus the latest
succeeded version (if they are different) are kept for the time period
specified by the retentionPeriod parameter. For more information, see
Keeping Multiple Versions of IoT Analytics datasets
in the IoT Analytics User Guide.
$sel:triggers:CreateDataset', createDataset_triggers - A list of triggers. A trigger causes dataset contents to be populated at
a specified time interval or when another dataset's contents are
created. The list of triggers can be empty or contain up to five
DataSetTrigger objects.
$sel:retentionPeriod:CreateDataset', createDataset_retentionPeriod - Optional. How long, in days, versions of dataset contents are kept for
the dataset. If not specified or set to null, versions of dataset
contents are retained for at most 90 days. The number of versions of
dataset contents retained is determined by the versioningConfiguration
parameter. For more information, see
Keeping Multiple Versions of IoT Analytics datasets
in the IoT Analytics User Guide.
$sel:lateDataRules:CreateDataset', createDataset_lateDataRules - A list of data rules that send notifications to CloudWatch, when data
arrives late. To specify lateDataRules, the dataset must use a
DeltaTimer
filter.
$sel:contentDeliveryRules:CreateDataset', createDataset_contentDeliveryRules - When dataset contents are created, they are delivered to destinations
specified here.
$sel:tags:CreateDataset', createDataset_tags - Metadata which can be used to manage the dataset.
$sel:datasetName:CreateDataset', createDataset_datasetName - The name of the dataset.
$sel:actions:CreateDataset', createDataset_actions - A list of actions that create the dataset contents.
data CreateDatasetResponse Source #
See: newCreateDatasetResponse smart constructor.
Constructors
| CreateDatasetResponse' (Maybe Text) (Maybe RetentionPeriod) (Maybe Text) Int |
Instances
newCreateDatasetResponse Source #
Create a value of CreateDatasetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:datasetArn:CreateDatasetResponse', createDatasetResponse_datasetArn - The ARN of the dataset.
$sel:retentionPeriod:CreateDataset', createDatasetResponse_retentionPeriod - How long, in days, dataset contents are kept for the dataset.
$sel:datasetName:CreateDataset', createDatasetResponse_datasetName - The name of the dataset.
$sel:httpStatus:CreateDatasetResponse', createDatasetResponse_httpStatus - The response's http status code.
BatchPutMessage
data BatchPutMessage Source #
See: newBatchPutMessage smart constructor.
Constructors
| BatchPutMessage' Text [Message] |
Instances
Arguments
| :: Text | |
| -> BatchPutMessage |
Create a value of BatchPutMessage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelName:BatchPutMessage', batchPutMessage_channelName - The name of the channel where the messages are sent.
$sel:messages:BatchPutMessage', batchPutMessage_messages - The list of messages to be sent. Each message has the format: {
"messageId": "string", "payload": "string"}.
The field names of message payloads (data) that you send to IoT Analytics:
- Must contain only alphanumeric characters and undescores (_). No other special characters are allowed.
- Must begin with an alphabetic character or single underscore (_).
- Cannot contain hyphens (-).
- In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".
- Cannot be more than 255 characters.
- Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)
For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in message payloads.
data BatchPutMessageResponse Source #
See: newBatchPutMessageResponse smart constructor.
Constructors
| BatchPutMessageResponse' (Maybe [BatchPutMessageErrorEntry]) Int |
Instances
newBatchPutMessageResponse Source #
Create a value of BatchPutMessageResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:batchPutMessageErrorEntries:BatchPutMessageResponse', batchPutMessageResponse_batchPutMessageErrorEntries - A list of any errors encountered when sending the messages to the
channel.
$sel:httpStatus:BatchPutMessageResponse', batchPutMessageResponse_httpStatus - The response's http status code.
ListDatastores (Paginated)
data ListDatastores Source #
See: newListDatastores smart constructor.
Constructors
| ListDatastores' (Maybe Text) (Maybe Natural) |
Instances
newListDatastores :: ListDatastores Source #
Create a value of ListDatastores with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListDatastores', listDatastores_nextToken - The token for the next set of results.
$sel:maxResults:ListDatastores', listDatastores_maxResults - The maximum number of results to return in this request.
The default value is 100.
data ListDatastoresResponse Source #
See: newListDatastoresResponse smart constructor.
Constructors
| ListDatastoresResponse' (Maybe Text) (Maybe [DatastoreSummary]) Int |
Instances
newListDatastoresResponse Source #
Create a value of ListDatastoresResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListDatastores', listDatastoresResponse_nextToken - The token to retrieve the next set of results, or null if there are no
more results.
$sel:datastoreSummaries:ListDatastoresResponse', listDatastoresResponse_datastoreSummaries - A list of DatastoreSummary objects.
$sel:httpStatus:ListDatastoresResponse', listDatastoresResponse_httpStatus - The response's http status code.
CreateDatasetContent
data CreateDatasetContent Source #
See: newCreateDatasetContent smart constructor.
Constructors
| CreateDatasetContent' (Maybe Text) Text |
Instances
newCreateDatasetContent Source #
Create a value of CreateDatasetContent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:versionId:CreateDatasetContent', createDatasetContent_versionId - The version ID of the dataset content. To specify versionId for a
dataset content, the dataset must use a
DeltaTimer
filter.
$sel:datasetName:CreateDatasetContent', createDatasetContent_datasetName - The name of the dataset.
data CreateDatasetContentResponse Source #
See: newCreateDatasetContentResponse smart constructor.
Constructors
| CreateDatasetContentResponse' (Maybe Text) Int |
Instances
newCreateDatasetContentResponse Source #
Create a value of CreateDatasetContentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:versionId:CreateDatasetContent', createDatasetContentResponse_versionId - The version ID of the dataset contents that are being created.
$sel:httpStatus:CreateDatasetContentResponse', createDatasetContentResponse_httpStatus - The response's http status code.
CreateChannel
data CreateChannel Source #
See: newCreateChannel smart constructor.
Constructors
| CreateChannel' (Maybe RetentionPeriod) (Maybe ChannelStorage) (Maybe (NonEmpty Tag)) Text |
Instances
Arguments
| :: Text | |
| -> CreateChannel |
Create a value of CreateChannel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:retentionPeriod:CreateChannel', createChannel_retentionPeriod - How long, in days, message data is kept for the channel. When
customerManagedS3 storage is selected, this parameter is ignored.
$sel:channelStorage:CreateChannel', createChannel_channelStorage - Where channel data is stored. You can choose one of serviceManagedS3
or customerManagedS3 storage. If not specified, the default is
serviceManagedS3. You can't change this storage option after the
channel is created.
$sel:tags:CreateChannel', createChannel_tags - Metadata which can be used to manage the channel.
$sel:channelName:CreateChannel', createChannel_channelName - The name of the channel.
data CreateChannelResponse Source #
See: newCreateChannelResponse smart constructor.
Constructors
| CreateChannelResponse' (Maybe Text) (Maybe RetentionPeriod) (Maybe Text) Int |
Instances
newCreateChannelResponse Source #
Create a value of CreateChannelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelArn:CreateChannelResponse', createChannelResponse_channelArn - The ARN of the channel.
$sel:retentionPeriod:CreateChannel', createChannelResponse_retentionPeriod - How long, in days, message data is kept for the channel.
$sel:channelName:CreateChannel', createChannelResponse_channelName - The name of the channel.
$sel:httpStatus:CreateChannelResponse', createChannelResponse_httpStatus - The response's http status code.
DeleteDatasetContent
data DeleteDatasetContent Source #
See: newDeleteDatasetContent smart constructor.
Constructors
| DeleteDatasetContent' (Maybe Text) Text |
Instances
newDeleteDatasetContent Source #
Create a value of DeleteDatasetContent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:versionId:DeleteDatasetContent', deleteDatasetContent_versionId - The version of the dataset whose content is deleted. You can also use
the strings "$LATEST" or "$LATEST_SUCCEEDED" to delete the latest or
latest successfully completed data set. If not specified,
"$LATEST_SUCCEEDED" is the default.
$sel:datasetName:DeleteDatasetContent', deleteDatasetContent_datasetName - The name of the dataset whose content is deleted.
data DeleteDatasetContentResponse Source #
See: newDeleteDatasetContentResponse smart constructor.
Constructors
| DeleteDatasetContentResponse' | |
Instances
| Eq DeleteDatasetContentResponse Source # | |
Defined in Amazonka.IoTAnalytics.DeleteDatasetContent Methods (==) :: DeleteDatasetContentResponse -> DeleteDatasetContentResponse -> Bool # (/=) :: DeleteDatasetContentResponse -> DeleteDatasetContentResponse -> Bool # | |
| Read DeleteDatasetContentResponse Source # | |
| Show DeleteDatasetContentResponse Source # | |
Defined in Amazonka.IoTAnalytics.DeleteDatasetContent Methods showsPrec :: Int -> DeleteDatasetContentResponse -> ShowS # show :: DeleteDatasetContentResponse -> String # showList :: [DeleteDatasetContentResponse] -> ShowS # | |
| Generic DeleteDatasetContentResponse Source # | |
Defined in Amazonka.IoTAnalytics.DeleteDatasetContent Associated Types type Rep DeleteDatasetContentResponse :: Type -> Type # | |
| NFData DeleteDatasetContentResponse Source # | |
Defined in Amazonka.IoTAnalytics.DeleteDatasetContent Methods rnf :: DeleteDatasetContentResponse -> () # | |
| type Rep DeleteDatasetContentResponse Source # | |
Defined in Amazonka.IoTAnalytics.DeleteDatasetContent | |
newDeleteDatasetContentResponse :: DeleteDatasetContentResponse Source #
Create a value of DeleteDatasetContentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeDatastore
data DescribeDatastore Source #
See: newDescribeDatastore smart constructor.
Constructors
| DescribeDatastore' (Maybe Bool) Text |
Instances
Arguments
| :: Text | |
| -> DescribeDatastore |
Create a value of DescribeDatastore with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:includeStatistics:DescribeDatastore', describeDatastore_includeStatistics - If true, additional statistical information about the data store is
included in the response. This feature can't be used with a data store
whose S3 storage is customer-managed.
$sel:datastoreName:DescribeDatastore', describeDatastore_datastoreName - The name of the data store
data DescribeDatastoreResponse Source #
See: newDescribeDatastoreResponse smart constructor.
Constructors
| DescribeDatastoreResponse' (Maybe Datastore) (Maybe DatastoreStatistics) Int |
Instances
newDescribeDatastoreResponse Source #
Create a value of DescribeDatastoreResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:datastore:DescribeDatastoreResponse', describeDatastoreResponse_datastore - Information about the data store.
$sel:statistics:DescribeDatastoreResponse', describeDatastoreResponse_statistics - Additional statistical information about the data store. Included if the
includeStatistics parameter is set to true in the request.
$sel:httpStatus:DescribeDatastoreResponse', describeDatastoreResponse_httpStatus - The response's http status code.
GetDatasetContent
data GetDatasetContent Source #
See: newGetDatasetContent smart constructor.
Constructors
| GetDatasetContent' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> GetDatasetContent |
Create a value of GetDatasetContent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:versionId:GetDatasetContent', getDatasetContent_versionId - The version of the dataset whose contents are retrieved. You can also
use the strings "$LATEST" or "$LATEST_SUCCEEDED" to retrieve the
contents of the latest or latest successfully completed dataset. If not
specified, "$LATEST_SUCCEEDED" is the default.
$sel:datasetName:GetDatasetContent', getDatasetContent_datasetName - The name of the dataset whose contents are retrieved.
data GetDatasetContentResponse Source #
See: newGetDatasetContentResponse smart constructor.
Constructors
| GetDatasetContentResponse' (Maybe DatasetContentStatus) (Maybe [DatasetEntry]) (Maybe POSIX) Int |
Instances
newGetDatasetContentResponse Source #
Create a value of GetDatasetContentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:GetDatasetContentResponse', getDatasetContentResponse_status - The status of the dataset content.
$sel:entries:GetDatasetContentResponse', getDatasetContentResponse_entries - A list of DatasetEntry objects.
$sel:timestamp:GetDatasetContentResponse', getDatasetContentResponse_timestamp - The time when the request was made.
$sel:httpStatus:GetDatasetContentResponse', getDatasetContentResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text (NonEmpty Tag) |
Instances
Create a value of TagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagResource', tagResource_resourceArn - The ARN of the resource whose tags you want to modify.
$sel:tags:TagResource', tagResource_tags - The new or modified tags for the resource.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
ListDatasets (Paginated)
data ListDatasets Source #
See: newListDatasets smart constructor.
Constructors
| ListDatasets' (Maybe Text) (Maybe Natural) |
Instances
newListDatasets :: ListDatasets Source #
Create a value of ListDatasets with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListDatasets', listDatasets_nextToken - The token for the next set of results.
$sel:maxResults:ListDatasets', listDatasets_maxResults - The maximum number of results to return in this request.
The default value is 100.
data ListDatasetsResponse Source #
See: newListDatasetsResponse smart constructor.
Constructors
| ListDatasetsResponse' (Maybe Text) (Maybe [DatasetSummary]) Int |
Instances
newListDatasetsResponse Source #
Arguments
| :: Int | |
| -> ListDatasetsResponse |
Create a value of ListDatasetsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListDatasets', listDatasetsResponse_nextToken - The token to retrieve the next set of results, or null if there are no
more results.
$sel:datasetSummaries:ListDatasetsResponse', listDatasetsResponse_datasetSummaries - A list of DatasetSummary objects.
$sel:httpStatus:ListDatasetsResponse', listDatasetsResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text (NonEmpty Text) |
Instances
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> UntagResource |
Create a value of UntagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:UntagResource', untagResource_resourceArn - The ARN of the resource whose tags you want to remove.
$sel:tagKeys:UntagResource', untagResource_tagKeys - The keys of those tags which you want to remove.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
RunPipelineActivity
data RunPipelineActivity Source #
See: newRunPipelineActivity smart constructor.
Constructors
| RunPipelineActivity' PipelineActivity (NonEmpty Base64) |
Instances
newRunPipelineActivity Source #
Arguments
| :: PipelineActivity | |
| -> NonEmpty ByteString | |
| -> RunPipelineActivity |
Create a value of RunPipelineActivity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pipelineActivity:RunPipelineActivity', runPipelineActivity_pipelineActivity - The pipeline activity that is run. This must not be a channel activity
or a data store activity because these activities are used in a pipeline
only to load the original message and to store the (possibly)
transformed message. If a Lambda activity is specified, only
short-running Lambda functions (those with a timeout of less than 30
seconds or less) can be used.
$sel:payloads:RunPipelineActivity', runPipelineActivity_payloads - The sample message payloads on which the pipeline activity is run.
data RunPipelineActivityResponse Source #
See: newRunPipelineActivityResponse smart constructor.
Instances
newRunPipelineActivityResponse Source #
Create a value of RunPipelineActivityResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:logResult:RunPipelineActivityResponse', runPipelineActivityResponse_logResult - In case the pipeline activity fails, the log message that is generated.
$sel:payloads:RunPipelineActivity', runPipelineActivityResponse_payloads - The enriched or transformed sample message payloads as base64-encoded
strings. (The results of running the pipeline activity on each input
sample message payload, encoded in base64.)
$sel:httpStatus:RunPipelineActivityResponse', runPipelineActivityResponse_httpStatus - The response's http status code.
DescribeChannel
data DescribeChannel Source #
See: newDescribeChannel smart constructor.
Constructors
| DescribeChannel' (Maybe Bool) Text |
Instances
Arguments
| :: Text | |
| -> DescribeChannel |
Create a value of DescribeChannel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:includeStatistics:DescribeChannel', describeChannel_includeStatistics - If true, additional statistical information about the channel is
included in the response. This feature can't be used with a channel
whose S3 storage is customer-managed.
$sel:channelName:DescribeChannel', describeChannel_channelName - The name of the channel whose information is retrieved.
data DescribeChannelResponse Source #
See: newDescribeChannelResponse smart constructor.
Constructors
| DescribeChannelResponse' (Maybe Channel) (Maybe ChannelStatistics) Int |
Instances
newDescribeChannelResponse Source #
Create a value of DescribeChannelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channel:DescribeChannelResponse', describeChannelResponse_channel - An object that contains information about the channel.
$sel:statistics:DescribeChannelResponse', describeChannelResponse_statistics - Statistics about the channel. Included if the includeStatistics
parameter is set to true in the request.
$sel:httpStatus:DescribeChannelResponse', describeChannelResponse_httpStatus - The response's http status code.
CreatePipeline
data CreatePipeline Source #
See: newCreatePipeline smart constructor.
Constructors
| CreatePipeline' (Maybe (NonEmpty Tag)) Text (NonEmpty PipelineActivity) |
Instances
Arguments
| :: Text | |
| -> NonEmpty PipelineActivity | |
| -> CreatePipeline |
Create a value of CreatePipeline with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreatePipeline', createPipeline_tags - Metadata which can be used to manage the pipeline.
$sel:pipelineName:CreatePipeline', createPipeline_pipelineName - The name of the pipeline.
$sel:pipelineActivities:CreatePipeline', createPipeline_pipelineActivities - A list of PipelineActivity objects. Activities perform transformations
on your messages, such as removing, renaming or adding message
attributes; filtering messages based on attribute values; invoking your
Lambda unctions on messages for advanced processing; or performing
mathematical transformations to normalize device data.
The list can be 2-25 PipelineActivity objects and must contain both a
channel and a datastore activity. Each entry in the list must
contain only one activity. For example:
pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]data CreatePipelineResponse Source #
See: newCreatePipelineResponse smart constructor.
Instances
newCreatePipelineResponse Source #
Create a value of CreatePipelineResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pipelineName:CreatePipeline', createPipelineResponse_pipelineName - The name of the pipeline.
$sel:pipelineArn:CreatePipelineResponse', createPipelineResponse_pipelineArn - The ARN of the pipeline.
$sel:httpStatus:CreatePipelineResponse', createPipelineResponse_httpStatus - The response's http status code.
StartPipelineReprocessing
data StartPipelineReprocessing Source #
See: newStartPipelineReprocessing smart constructor.
Constructors
| StartPipelineReprocessing' (Maybe POSIX) (Maybe POSIX) (Maybe ChannelMessages) Text |
Instances
newStartPipelineReprocessing Source #
Create a value of StartPipelineReprocessing with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:startTime:StartPipelineReprocessing', startPipelineReprocessing_startTime - The start time (inclusive) of raw message data that is reprocessed.
If you specify a value for the startTime parameter, you must not use
the channelMessages object.
$sel:endTime:StartPipelineReprocessing', startPipelineReprocessing_endTime - The end time (exclusive) of raw message data that is reprocessed.
If you specify a value for the endTime parameter, you must not use the
channelMessages object.
$sel:channelMessages:StartPipelineReprocessing', startPipelineReprocessing_channelMessages - Specifies one or more sets of channel messages that you want to
reprocess.
If you use the channelMessages object, you must not specify a value
for startTime and endTime.
$sel:pipelineName:StartPipelineReprocessing', startPipelineReprocessing_pipelineName - The name of the pipeline on which to start reprocessing.
data StartPipelineReprocessingResponse Source #
See: newStartPipelineReprocessingResponse smart constructor.
Constructors
| StartPipelineReprocessingResponse' (Maybe Text) Int |
Instances
newStartPipelineReprocessingResponse Source #
Arguments
| :: Int | |
| -> StartPipelineReprocessingResponse |
Create a value of StartPipelineReprocessingResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:reprocessingId:StartPipelineReprocessingResponse', startPipelineReprocessingResponse_reprocessingId - The ID of the pipeline reprocessing activity that was started.
$sel:httpStatus:StartPipelineReprocessingResponse', startPipelineReprocessingResponse_httpStatus - The response's http status code.
DescribeLoggingOptions
data DescribeLoggingOptions Source #
See: newDescribeLoggingOptions smart constructor.
Constructors
| DescribeLoggingOptions' | |
Instances
newDescribeLoggingOptions :: DescribeLoggingOptions Source #
Create a value of DescribeLoggingOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DescribeLoggingOptionsResponse Source #
See: newDescribeLoggingOptionsResponse smart constructor.
Constructors
| DescribeLoggingOptionsResponse' (Maybe LoggingOptions) Int |
Instances
newDescribeLoggingOptionsResponse Source #
Create a value of DescribeLoggingOptionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:loggingOptions:DescribeLoggingOptionsResponse', describeLoggingOptionsResponse_loggingOptions - The current settings of the IoT Analytics logging options.
$sel:httpStatus:DescribeLoggingOptionsResponse', describeLoggingOptionsResponse_httpStatus - The response's http status code.
Types
ChannelStatus
newtype ChannelStatus Source #
Constructors
| ChannelStatus' | |
Fields | |
Bundled Patterns
| pattern ChannelStatus_ACTIVE :: ChannelStatus | |
| pattern ChannelStatus_CREATING :: ChannelStatus | |
| pattern ChannelStatus_DELETING :: ChannelStatus |
Instances
ComputeType
newtype ComputeType Source #
Constructors
| ComputeType' | |
Fields | |
Bundled Patterns
| pattern ComputeType_ACU_1 :: ComputeType | |
| pattern ComputeType_ACU_2 :: ComputeType |
Instances
DatasetActionType
newtype DatasetActionType Source #
Constructors
| DatasetActionType' | |
Fields | |
Bundled Patterns
| pattern DatasetActionType_CONTAINER :: DatasetActionType | |
| pattern DatasetActionType_QUERY :: DatasetActionType |
Instances
DatasetContentState
newtype DatasetContentState Source #
Constructors
| DatasetContentState' | |
Fields | |
Bundled Patterns
| pattern DatasetContentState_CREATING :: DatasetContentState | |
| pattern DatasetContentState_FAILED :: DatasetContentState | |
| pattern DatasetContentState_SUCCEEDED :: DatasetContentState |
Instances
DatasetStatus
newtype DatasetStatus Source #
Constructors
| DatasetStatus' | |
Fields | |
Bundled Patterns
| pattern DatasetStatus_ACTIVE :: DatasetStatus | |
| pattern DatasetStatus_CREATING :: DatasetStatus | |
| pattern DatasetStatus_DELETING :: DatasetStatus |
Instances
DatastoreStatus
newtype DatastoreStatus Source #
Constructors
| DatastoreStatus' | |
Fields | |
Bundled Patterns
| pattern DatastoreStatus_ACTIVE :: DatastoreStatus | |
| pattern DatastoreStatus_CREATING :: DatastoreStatus | |
| pattern DatastoreStatus_DELETING :: DatastoreStatus |
Instances
FileFormatType
newtype FileFormatType Source #
Constructors
| FileFormatType' | |
Fields | |
Bundled Patterns
| pattern FileFormatType_JSON :: FileFormatType | |
| pattern FileFormatType_PARQUET :: FileFormatType |
Instances
LoggingLevel
newtype LoggingLevel Source #
Constructors
| LoggingLevel' | |
Fields | |
Bundled Patterns
| pattern LoggingLevel_ERROR :: LoggingLevel |
Instances
ReprocessingStatus
newtype ReprocessingStatus Source #
Constructors
| ReprocessingStatus' | |
Fields | |
Bundled Patterns
| pattern ReprocessingStatus_CANCELLED :: ReprocessingStatus | |
| pattern ReprocessingStatus_FAILED :: ReprocessingStatus | |
| pattern ReprocessingStatus_RUNNING :: ReprocessingStatus | |
| pattern ReprocessingStatus_SUCCEEDED :: ReprocessingStatus |
Instances
AddAttributesActivity
data AddAttributesActivity Source #
An activity that adds other attributes based on existing attributes in the message.
See: newAddAttributesActivity smart constructor.
Instances
newAddAttributesActivity Source #
Arguments
| :: Text | |
| -> AddAttributesActivity |
Create a value of AddAttributesActivity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:next:AddAttributesActivity', addAttributesActivity_next - The next activity in the pipeline.
$sel:name:AddAttributesActivity', addAttributesActivity_name - The name of the addAttributes activity.
$sel:attributes:AddAttributesActivity', addAttributesActivity_attributes - A list of 1-50 AttributeNameMapping objects that map an existing
attribute to a new attribute.
The existing attributes remain in the message, so if you want to remove
the originals, use RemoveAttributeActivity.
BatchPutMessageErrorEntry
data BatchPutMessageErrorEntry Source #
Contains informations about errors.
See: newBatchPutMessageErrorEntry smart constructor.
Instances
newBatchPutMessageErrorEntry :: BatchPutMessageErrorEntry Source #
Create a value of BatchPutMessageErrorEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:BatchPutMessageErrorEntry', batchPutMessageErrorEntry_errorCode - The code associated with the error.
$sel:errorMessage:BatchPutMessageErrorEntry', batchPutMessageErrorEntry_errorMessage - The message associated with the error.
$sel:messageId:BatchPutMessageErrorEntry', batchPutMessageErrorEntry_messageId - 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: newChannel smart constructor.
Constructors
| Channel' (Maybe POSIX) (Maybe ChannelStatus) (Maybe POSIX) (Maybe Text) (Maybe ChannelStorage) (Maybe RetentionPeriod) (Maybe Text) (Maybe POSIX) |
Instances
newChannel :: Channel Source #
Create a value of Channel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:Channel', channel_creationTime - When the channel was created.
$sel:status:Channel', channel_status - The status of the channel.
$sel:lastMessageArrivalTime:Channel', channel_lastMessageArrivalTime - The last time when a new message arrived in the channel.
IoT Analytics updates this value at most once per minute for one
channel. Hence, the lastMessageArrivalTime value is an approximation.
This feature only applies to messages that arrived in the data store after October 23, 2020.
$sel:arn:Channel', channel_arn - The ARN of the channel.
$sel:storage:Channel', channel_storage - Where channel data is stored. You can choose one of serviceManagedS3
or customerManagedS3 storage. If not specified, the default is
serviceManagedS3. You can't change this storage option after the
channel is created.
$sel:retentionPeriod:Channel', channel_retentionPeriod - How long, in days, message data is kept for the channel.
$sel:name:Channel', channel_name - The name of the channel.
$sel:lastUpdateTime:Channel', channel_lastUpdateTime - When the channel was last updated.
ChannelActivity
data ChannelActivity Source #
The activity that determines the source of the messages to be processed.
See: newChannelActivity smart constructor.
Constructors
| ChannelActivity' (Maybe Text) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ChannelActivity |
Create a value of ChannelActivity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:next:ChannelActivity', channelActivity_next - The next activity in the pipeline.
$sel:name:ChannelActivity', channelActivity_name - The name of the channel activity.
$sel:channelName:ChannelActivity', channelActivity_channelName - The name of the channel from which the messages are processed.
ChannelMessages
data ChannelMessages Source #
Specifies one or more sets of channel messages.
See: newChannelMessages smart constructor.
Constructors
| ChannelMessages' (Maybe (NonEmpty Text)) |
Instances
newChannelMessages :: ChannelMessages Source #
Create a value of ChannelMessages with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3Paths:ChannelMessages', channelMessages_s3Paths - Specifies one or more keys that identify the Amazon Simple Storage
Service (Amazon S3) objects that save your channel messages.
You must use the full path for the key.
Example path:
channel/mychannel/__dt=2020-02-29 00:00:00/1582940490000_1582940520000_123456789012_mychannel_0_2118.0.json.gz
ChannelStatistics
data ChannelStatistics Source #
Statistics information about the channel.
See: newChannelStatistics smart constructor.
Constructors
| ChannelStatistics' (Maybe EstimatedResourceSize) |
Instances
newChannelStatistics :: ChannelStatistics Source #
Create a value of ChannelStatistics with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:size:ChannelStatistics', channelStatistics_size - The estimated size of the channel.
ChannelStorage
data ChannelStorage Source #
Where channel data is stored. You may choose one of serviceManagedS3,
customerManagedS3 storage. If not specified, the default is
serviceManagedS3. This can't be changed after creation of the
channel.
See: newChannelStorage smart constructor.
Constructors
| ChannelStorage' (Maybe ServiceManagedChannelS3Storage) (Maybe CustomerManagedChannelS3Storage) |
Instances
newChannelStorage :: ChannelStorage Source #
Create a value of ChannelStorage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:serviceManagedS3:ChannelStorage', channelStorage_serviceManagedS3 - Used to store channel data in an S3 bucket managed by IoT Analytics. You
can't change the choice of S3 storage after the data store is created.
$sel:customerManagedS3:ChannelStorage', channelStorage_customerManagedS3 - Used to store channel data in an S3 bucket that you manage. If customer
managed storage is selected, the retentionPeriod parameter is ignored.
You can't change the choice of S3 storage after the data store is
created.
ChannelStorageSummary
data ChannelStorageSummary Source #
Where channel data is stored.
See: newChannelStorageSummary smart constructor.
Constructors
| ChannelStorageSummary' (Maybe ServiceManagedChannelS3StorageSummary) (Maybe CustomerManagedChannelS3StorageSummary) |
Instances
newChannelStorageSummary :: ChannelStorageSummary Source #
Create a value of ChannelStorageSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:serviceManagedS3:ChannelStorageSummary', channelStorageSummary_serviceManagedS3 - Used to store channel data in an S3 bucket managed by IoT Analytics.
$sel:customerManagedS3:ChannelStorageSummary', channelStorageSummary_customerManagedS3 - Used to store channel data in an S3 bucket that you manage.
ChannelSummary
data ChannelSummary Source #
A summary of information about a channel.
See: newChannelSummary smart constructor.
Constructors
| ChannelSummary' (Maybe POSIX) (Maybe ChannelStatus) (Maybe POSIX) (Maybe Text) (Maybe ChannelStorageSummary) (Maybe POSIX) |
Instances
newChannelSummary :: ChannelSummary Source #
Create a value of ChannelSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:ChannelSummary', channelSummary_creationTime - When the channel was created.
$sel:status:ChannelSummary', channelSummary_status - The status of the channel.
$sel:lastMessageArrivalTime:ChannelSummary', channelSummary_lastMessageArrivalTime - The last time when a new message arrived in the channel.
IoT Analytics updates this value at most once per minute for one
channel. Hence, the lastMessageArrivalTime value is an approximation.
This feature only applies to messages that arrived in the data store after October 23, 2020.
$sel:channelName:ChannelSummary', channelSummary_channelName - The name of the channel.
$sel:channelStorage:ChannelSummary', channelSummary_channelStorage - Where channel data is stored.
$sel:lastUpdateTime:ChannelSummary', channelSummary_lastUpdateTime - The last time the channel was updated.
Column
Contains information about a column that stores your data.
See: newColumn smart constructor.
Instances
| Eq Column Source # | |
| Read Column Source # | |
| Show Column Source # | |
| Generic Column Source # | |
| NFData Column Source # | |
Defined in Amazonka.IoTAnalytics.Types.Column | |
| Hashable Column Source # | |
Defined in Amazonka.IoTAnalytics.Types.Column | |
| ToJSON Column Source # | |
Defined in Amazonka.IoTAnalytics.Types.Column | |
| FromJSON Column Source # | |
| type Rep Column Source # | |
Defined in Amazonka.IoTAnalytics.Types.Column type Rep Column = D1 ('MetaData "Column" "Amazonka.IoTAnalytics.Types.Column" "libZSservicesZSamazonka-iot-analyticsZSamazonka-iot-analytics" 'False) (C1 ('MetaCons "Column'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Column with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:Column', column_name - The name of the column.
$sel:type':Column', column_type - The type of data. For more information about the supported data types,
see
Common data types
in the Glue Developer Guide.
ContainerDatasetAction
data ContainerDatasetAction Source #
Information required to run the containerAction to produce dataset
contents.
See: newContainerDatasetAction smart constructor.
Constructors
| ContainerDatasetAction' (Maybe [Variable]) Text Text ResourceConfiguration |
Instances
newContainerDatasetAction Source #
Arguments
| :: Text | |
| -> Text | |
| -> ResourceConfiguration | |
| -> ContainerDatasetAction |
Create a value of ContainerDatasetAction with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:variables:ContainerDatasetAction', containerDatasetAction_variables - The values of variables used in the context of the execution of the
containerized application (basically, parameters passed to the
application). Each variable must have a name and a value given by one of
stringValue, datasetContentVersionValue, or outputFileUriValue.
$sel:image:ContainerDatasetAction', containerDatasetAction_image - The ARN of the Docker container stored in your account. The Docker
container contains an application and required support libraries and is
used to generate dataset contents.
$sel:executionRoleArn:ContainerDatasetAction', containerDatasetAction_executionRoleArn - The ARN of the role that gives permission to the system to access
required resources to run the containerAction. This includes, at
minimum, permission to retrieve the dataset contents that are the input
to the containerized application.
$sel:resourceConfiguration:ContainerDatasetAction', containerDatasetAction_resourceConfiguration - Configuration of the resource that executes the containerAction.
CustomerManagedChannelS3Storage
data CustomerManagedChannelS3Storage Source #
Used to store channel data in an S3 bucket that you manage. If
customer-managed storage is selected, the retentionPeriod parameter is
ignored. You can't change the choice of S3 storage after the data store
is created.
See: newCustomerManagedChannelS3Storage smart constructor.
Constructors
| CustomerManagedChannelS3Storage' (Maybe Text) Text Text |
Instances
newCustomerManagedChannelS3Storage Source #
Arguments
| :: Text | |
| -> Text | |
| -> CustomerManagedChannelS3Storage |
Create a value of CustomerManagedChannelS3Storage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyPrefix:CustomerManagedChannelS3Storage', customerManagedChannelS3Storage_keyPrefix - (Optional) The prefix used to create the keys of the channel data
objects. Each object in an S3 bucket has a key that is its unique
identifier in the bucket. Each object in a bucket has exactly one key.
The prefix must end with a forward slash (/).
$sel:bucket:CustomerManagedChannelS3Storage', customerManagedChannelS3Storage_bucket - The name of the S3 bucket in which channel data is stored.
$sel:roleArn:CustomerManagedChannelS3Storage', customerManagedChannelS3Storage_roleArn - The ARN of the role that grants IoT Analytics permission to interact
with your Amazon S3 resources.
CustomerManagedChannelS3StorageSummary
data CustomerManagedChannelS3StorageSummary Source #
Used to store channel data in an S3 bucket that you manage.
See: newCustomerManagedChannelS3StorageSummary smart constructor.
Instances
newCustomerManagedChannelS3StorageSummary :: CustomerManagedChannelS3StorageSummary Source #
Create a value of CustomerManagedChannelS3StorageSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bucket:CustomerManagedChannelS3StorageSummary', customerManagedChannelS3StorageSummary_bucket - The name of the S3 bucket in which channel data is stored.
$sel:keyPrefix:CustomerManagedChannelS3StorageSummary', customerManagedChannelS3StorageSummary_keyPrefix - (Optional) The prefix used to create the keys of the channel data
objects. Each object in an S3 bucket has a key that is its unique
identifier within the bucket (each object in a bucket has exactly one
key). The prefix must end with a forward slash (/).
$sel:roleArn:CustomerManagedChannelS3StorageSummary', customerManagedChannelS3StorageSummary_roleArn - The ARN of the role that grants IoT Analytics permission to interact
with your Amazon S3 resources.
CustomerManagedDatastoreS3Storage
data CustomerManagedDatastoreS3Storage Source #
S3-customer-managed; When you choose customer-managed storage, the
retentionPeriod parameter is ignored. You can't change the choice of
Amazon S3 storage after your data store is created.
See: newCustomerManagedDatastoreS3Storage smart constructor.
Constructors
| CustomerManagedDatastoreS3Storage' (Maybe Text) Text Text |
Instances
newCustomerManagedDatastoreS3Storage Source #
Arguments
| :: Text | |
| -> Text | |
| -> CustomerManagedDatastoreS3Storage |
Create a value of CustomerManagedDatastoreS3Storage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyPrefix:CustomerManagedDatastoreS3Storage', customerManagedDatastoreS3Storage_keyPrefix - (Optional) The prefix used to create the keys of the data store data
objects. Each object in an Amazon S3 bucket has a key that is its unique
identifier in the bucket. Each object in a bucket has exactly one key.
The prefix must end with a forward slash (/).
$sel:bucket:CustomerManagedDatastoreS3Storage', customerManagedDatastoreS3Storage_bucket - The name of the Amazon S3 bucket where your data is stored.
$sel:roleArn:CustomerManagedDatastoreS3Storage', customerManagedDatastoreS3Storage_roleArn - The ARN of the role that grants IoT Analytics permission to interact
with your Amazon S3 resources.
CustomerManagedDatastoreS3StorageSummary
data CustomerManagedDatastoreS3StorageSummary Source #
Contains information about the data store that you manage.
See: newCustomerManagedDatastoreS3StorageSummary smart constructor.
Instances
newCustomerManagedDatastoreS3StorageSummary :: CustomerManagedDatastoreS3StorageSummary Source #
Create a value of CustomerManagedDatastoreS3StorageSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bucket:CustomerManagedDatastoreS3StorageSummary', customerManagedDatastoreS3StorageSummary_bucket - The name of the Amazon S3 bucket where your data is stored.
$sel:keyPrefix:CustomerManagedDatastoreS3StorageSummary', customerManagedDatastoreS3StorageSummary_keyPrefix - (Optional) The prefix used to create the keys of the data store data
objects. Each object in an Amazon S3 bucket has a key that is its unique
identifier in the bucket. Each object in a bucket has exactly one key.
The prefix must end with a forward slash (/).
$sel:roleArn:CustomerManagedDatastoreS3StorageSummary', customerManagedDatastoreS3StorageSummary_roleArn - The ARN of the role that grants IoT Analytics permission to interact
with your Amazon S3 resources.
Dataset
Information about a dataset.
See: newDataset smart constructor.
Constructors
| Dataset' (Maybe POSIX) (Maybe DatasetStatus) (Maybe VersioningConfiguration) (Maybe Text) (Maybe (NonEmpty DatasetAction)) (Maybe [DatasetTrigger]) (Maybe RetentionPeriod) (Maybe (NonEmpty LateDataRule)) (Maybe Text) (Maybe [DatasetContentDeliveryRule]) (Maybe POSIX) |
Instances
newDataset :: Dataset Source #
Create a value of Dataset with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:Dataset', dataset_creationTime - When the dataset was created.
$sel:status:Dataset', dataset_status - The status of the dataset.
$sel:versioningConfiguration:Dataset', dataset_versioningConfiguration - Optional. How many versions of dataset contents are kept. If not
specified or set to null, only the latest version plus the latest
succeeded version (if they are different) are kept for the time period
specified by the retentionPeriod parameter. For more information, see
Keeping Multiple Versions of IoT Analytics datasets
in the IoT Analytics User Guide.
$sel:arn:Dataset', dataset_arn - The ARN of the dataset.
$sel:actions:Dataset', dataset_actions - The DatasetAction objects that automatically create the dataset
contents.
$sel:triggers:Dataset', dataset_triggers - The DatasetTrigger objects that specify when the dataset is
automatically updated.
$sel:retentionPeriod:Dataset', dataset_retentionPeriod - Optional. How long, in days, message data is kept for the dataset.
$sel:lateDataRules:Dataset', dataset_lateDataRules - A list of data rules that send notifications to CloudWatch, when data
arrives late. To specify lateDataRules, the dataset must use a
DeltaTimer
filter.
$sel:name:Dataset', dataset_name - The name of the dataset.
$sel:contentDeliveryRules:Dataset', dataset_contentDeliveryRules - When dataset contents are created they are delivered to destinations
specified here.
$sel:lastUpdateTime:Dataset', dataset_lastUpdateTime - The last time the dataset was updated.
DatasetAction
data DatasetAction Source #
A DatasetAction object that specifies how dataset contents are
automatically created.
See: newDatasetAction smart constructor.
Constructors
| DatasetAction' (Maybe SqlQueryDatasetAction) (Maybe Text) (Maybe ContainerDatasetAction) |
Instances
newDatasetAction :: DatasetAction Source #
Create a value of DatasetAction with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:queryAction:DatasetAction', datasetAction_queryAction - An SqlQueryDatasetAction object that uses an SQL query to
automatically create dataset contents.
$sel:actionName:DatasetAction', datasetAction_actionName - The name of the dataset action by which dataset contents are
automatically created.
$sel:containerAction:DatasetAction', datasetAction_containerAction - Information that allows the system to run a containerized application to
create the dataset contents. The application must be in a Docker
container along with any required support libraries.
DatasetActionSummary
data DatasetActionSummary Source #
Information about the action that automatically creates the dataset's contents.
See: newDatasetActionSummary smart constructor.
Constructors
| DatasetActionSummary' (Maybe Text) (Maybe DatasetActionType) |
Instances
newDatasetActionSummary :: DatasetActionSummary Source #
Create a value of DatasetActionSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:actionName:DatasetActionSummary', datasetActionSummary_actionName - The name of the action that automatically creates the dataset's
contents.
$sel:actionType:DatasetActionSummary', datasetActionSummary_actionType - The type of action by which the dataset's contents are automatically
created.
DatasetContentDeliveryDestination
data DatasetContentDeliveryDestination Source #
The destination to which dataset contents are delivered.
See: newDatasetContentDeliveryDestination smart constructor.
Constructors
| DatasetContentDeliveryDestination' (Maybe S3DestinationConfiguration) (Maybe IotEventsDestinationConfiguration) |
Instances
newDatasetContentDeliveryDestination :: DatasetContentDeliveryDestination Source #
Create a value of DatasetContentDeliveryDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3DestinationConfiguration:DatasetContentDeliveryDestination', datasetContentDeliveryDestination_s3DestinationConfiguration - Configuration information for delivery of dataset contents to Amazon S3.
$sel:iotEventsDestinationConfiguration:DatasetContentDeliveryDestination', datasetContentDeliveryDestination_iotEventsDestinationConfiguration - Configuration information for delivery of dataset contents to IoT
Events.
DatasetContentDeliveryRule
data DatasetContentDeliveryRule Source #
When dataset contents are created, they are delivered to destination specified here.
See: newDatasetContentDeliveryRule smart constructor.
Instances
newDatasetContentDeliveryRule Source #
Arguments
| :: DatasetContentDeliveryDestination | |
| -> DatasetContentDeliveryRule |
Create a value of DatasetContentDeliveryRule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entryName:DatasetContentDeliveryRule', datasetContentDeliveryRule_entryName - The name of the dataset content delivery rules entry.
$sel:destination:DatasetContentDeliveryRule', datasetContentDeliveryRule_destination - The destination to which dataset contents are delivered.
DatasetContentStatus
data DatasetContentStatus Source #
The state of the dataset contents and the reason they are in this state.
See: newDatasetContentStatus smart constructor.
Constructors
| DatasetContentStatus' (Maybe DatasetContentState) (Maybe Text) |
Instances
newDatasetContentStatus :: DatasetContentStatus Source #
Create a value of DatasetContentStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:state:DatasetContentStatus', datasetContentStatus_state - The state of the dataset contents. Can be one of READY, CREATING,
SUCCEEDED, or FAILED.
$sel:reason:DatasetContentStatus', datasetContentStatus_reason - The reason the dataset contents are in this state.
DatasetContentSummary
data DatasetContentSummary Source #
Summary information about dataset contents.
See: newDatasetContentSummary smart constructor.
Constructors
| DatasetContentSummary' (Maybe POSIX) (Maybe DatasetContentStatus) (Maybe POSIX) (Maybe POSIX) (Maybe Text) |
Instances
newDatasetContentSummary :: DatasetContentSummary Source #
Create a value of DatasetContentSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:DatasetContentSummary', datasetContentSummary_creationTime - The actual time the creation of the dataset contents was started.
$sel:status:DatasetContentSummary', datasetContentSummary_status - The status of the dataset contents.
$sel:scheduleTime:DatasetContentSummary', datasetContentSummary_scheduleTime - The time the creation of the dataset contents was scheduled to start.
$sel:completionTime:DatasetContentSummary', datasetContentSummary_completionTime - The time the dataset content status was updated to SUCCEEDED or FAILED.
$sel:version:DatasetContentSummary', datasetContentSummary_version - The version of the dataset contents.
DatasetContentVersionValue
data DatasetContentVersionValue Source #
The dataset whose latest contents are used as input to the notebook or application.
See: newDatasetContentVersionValue smart constructor.
Constructors
| DatasetContentVersionValue' Text |
Instances
newDatasetContentVersionValue Source #
Create a value of DatasetContentVersionValue with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:datasetName:DatasetContentVersionValue', datasetContentVersionValue_datasetName - The name of the dataset whose latest contents are used as input to the
notebook or application.
DatasetEntry
data DatasetEntry Source #
The reference to a dataset entry.
See: newDatasetEntry smart constructor.
Constructors
| DatasetEntry' (Maybe Text) (Maybe Text) |
Instances
newDatasetEntry :: DatasetEntry Source #
Create a value of DatasetEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entryName:DatasetEntry', datasetEntry_entryName - The name of the dataset item.
$sel:dataURI:DatasetEntry', datasetEntry_dataURI - The presigned URI of the dataset item.
DatasetSummary
data DatasetSummary Source #
A summary of information about a dataset.
See: newDatasetSummary smart constructor.
Constructors
| DatasetSummary' (Maybe POSIX) (Maybe DatasetStatus) (Maybe (NonEmpty DatasetActionSummary)) (Maybe [DatasetTrigger]) (Maybe Text) (Maybe POSIX) |
Instances
newDatasetSummary :: DatasetSummary Source #
Create a value of DatasetSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:DatasetSummary', datasetSummary_creationTime - The time the dataset was created.
$sel:status:DatasetSummary', datasetSummary_status - The status of the dataset.
$sel:actions:DatasetSummary', datasetSummary_actions - A list of DataActionSummary objects.
$sel:triggers:DatasetSummary', datasetSummary_triggers - A list of triggers. A trigger causes dataset content to be populated at
a specified time interval or when another dataset is populated. The list
of triggers can be empty or contain up to five DataSetTrigger objects
$sel:datasetName:DatasetSummary', datasetSummary_datasetName - The name of the dataset.
$sel:lastUpdateTime:DatasetSummary', datasetSummary_lastUpdateTime - The last time the dataset was updated.
DatasetTrigger
data DatasetTrigger Source #
The DatasetTrigger that specifies when the dataset is automatically
updated.
See: newDatasetTrigger smart constructor.
Constructors
| DatasetTrigger' (Maybe TriggeringDataset) (Maybe Schedule) |
Instances
newDatasetTrigger :: DatasetTrigger Source #
Create a value of DatasetTrigger with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataset:DatasetTrigger', datasetTrigger_dataset - The dataset whose content creation triggers the creation of this
dataset's contents.
$sel:schedule:DatasetTrigger', datasetTrigger_schedule - The Schedule when the trigger is initiated.
Datastore
Information about a data store.
See: newDatastore smart constructor.
Constructors
Instances
newDatastore :: Datastore Source #
Create a value of Datastore with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:Datastore', datastore_creationTime - When the data store was created.
$sel:status:Datastore', datastore_status - 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.
$sel:lastMessageArrivalTime:Datastore', datastore_lastMessageArrivalTime - The last time when a new message arrived in the data store.
IoT Analytics updates this value at most once per minute for Amazon
Simple Storage Service one data store. Hence, the
lastMessageArrivalTime value is an approximation.
This feature only applies to messages that arrived in the data store after October 23, 2020.
$sel:arn:Datastore', datastore_arn - The ARN of the data store.
$sel:fileFormatConfiguration:Datastore', datastore_fileFormatConfiguration - Contains the configuration information of file formats. 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.
$sel:datastorePartitions:Datastore', datastore_datastorePartitions - Contains information about the partition dimensions in a data store.
$sel:storage:Datastore', datastore_storage - Where data in a data store is stored.. You can choose serviceManagedS3
storage, customerManagedS3 storage, or iotSiteWiseMultiLayerStorage
storage. The default is serviceManagedS3. You can't change the choice
of Amazon S3 storage after your data store is created.
$sel:retentionPeriod:Datastore', datastore_retentionPeriod - How long, in days, message data is kept for the data store. When
customerManagedS3 storage is selected, this parameter is ignored.
$sel:name:Datastore', datastore_name - The name of the data store.
$sel:lastUpdateTime:Datastore', datastore_lastUpdateTime - The last time the data store was updated.
DatastoreActivity
data DatastoreActivity Source #
The datastore activity that specifies where to store the processed data.
See: newDatastoreActivity smart constructor.
Constructors
| DatastoreActivity' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DatastoreActivity |
Create a value of DatastoreActivity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:DatastoreActivity', datastoreActivity_name - The name of the datastore activity.
$sel:datastoreName:DatastoreActivity', datastoreActivity_datastoreName - The name of the data store where processed messages are stored.
DatastoreIotSiteWiseMultiLayerStorage
data DatastoreIotSiteWiseMultiLayerStorage Source #
Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage. You can't change the choice of Amazon S3 storage after your data store is created.
See: newDatastoreIotSiteWiseMultiLayerStorage smart constructor.
Instances
newDatastoreIotSiteWiseMultiLayerStorage Source #
Arguments
| :: IotSiteWiseCustomerManagedDatastoreS3Storage |
|
| -> DatastoreIotSiteWiseMultiLayerStorage |
Create a value of DatastoreIotSiteWiseMultiLayerStorage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:customerManagedS3Storage:DatastoreIotSiteWiseMultiLayerStorage', datastoreIotSiteWiseMultiLayerStorage_customerManagedS3Storage - Used to store data used by IoT SiteWise in an Amazon S3 bucket that you
manage.
DatastoreIotSiteWiseMultiLayerStorageSummary
data DatastoreIotSiteWiseMultiLayerStorageSummary Source #
Contains information about the data store that you manage, which stores data used by IoT SiteWise.
See: newDatastoreIotSiteWiseMultiLayerStorageSummary smart constructor.
Constructors
| DatastoreIotSiteWiseMultiLayerStorageSummary' (Maybe IotSiteWiseCustomerManagedDatastoreS3StorageSummary) |
Instances
newDatastoreIotSiteWiseMultiLayerStorageSummary :: DatastoreIotSiteWiseMultiLayerStorageSummary Source #
Create a value of DatastoreIotSiteWiseMultiLayerStorageSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:customerManagedS3Storage:DatastoreIotSiteWiseMultiLayerStorageSummary', datastoreIotSiteWiseMultiLayerStorageSummary_customerManagedS3Storage - Used to store data used by IoT SiteWise in an Amazon S3 bucket that you
manage.
DatastorePartition
data DatastorePartition Source #
A single dimension to partition a data store. The dimension must be an
AttributePartition or a TimestampPartition.
See: newDatastorePartition smart constructor.
Constructors
| DatastorePartition' (Maybe Partition) (Maybe TimestampPartition) |
Instances
newDatastorePartition :: DatastorePartition Source #
Create a value of DatastorePartition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributePartition:DatastorePartition', datastorePartition_attributePartition - A partition dimension defined by an attributeName.
$sel:timestampPartition:DatastorePartition', datastorePartition_timestampPartition - A partition dimension defined by a timestamp attribute.
DatastorePartitions
data DatastorePartitions Source #
Contains information about the partition dimensions in a data store.
See: newDatastorePartitions smart constructor.
Constructors
| DatastorePartitions' (Maybe [DatastorePartition]) |
Instances
newDatastorePartitions :: DatastorePartitions Source #
Create a value of DatastorePartitions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:partitions:DatastorePartitions', datastorePartitions_partitions - A list of partition dimensions in a data store.
DatastoreStatistics
data DatastoreStatistics Source #
Statistical information about the data store.
See: newDatastoreStatistics smart constructor.
Constructors
| DatastoreStatistics' (Maybe EstimatedResourceSize) |
Instances
newDatastoreStatistics :: DatastoreStatistics Source #
Create a value of DatastoreStatistics with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:size:DatastoreStatistics', datastoreStatistics_size - The estimated size of the data store.
DatastoreStorage
data DatastoreStorage Source #
Where data in a data store is stored.. You can choose serviceManagedS3
storage, customerManagedS3 storage, or iotSiteWiseMultiLayerStorage
storage. The default is serviceManagedS3. You can't change the choice
of Amazon S3 storage after your data store is created.
See: newDatastoreStorage smart constructor.
Constructors
| DatastoreStorage' (Maybe ServiceManagedDatastoreS3Storage) (Maybe CustomerManagedDatastoreS3Storage) (Maybe DatastoreIotSiteWiseMultiLayerStorage) |
Instances
newDatastoreStorage :: DatastoreStorage Source #
Create a value of DatastoreStorage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:serviceManagedS3:DatastoreStorage', datastoreStorage_serviceManagedS3 - Used to store data in an Amazon S3 bucket managed by IoT Analytics. You
can't change the choice of Amazon S3 storage after your data store is
created.
$sel:customerManagedS3:DatastoreStorage', datastoreStorage_customerManagedS3 - S3-customer-managed; When you choose customer-managed storage, the
retentionPeriod parameter is ignored. You can't change the choice of
Amazon S3 storage after your data store is created.
$sel:iotSiteWiseMultiLayerStorage:DatastoreStorage', datastoreStorage_iotSiteWiseMultiLayerStorage - Used to store data used by IoT SiteWise in an Amazon S3 bucket that you
manage. You can't change the choice of Amazon S3 storage after your
data store is created.
DatastoreStorageSummary
data DatastoreStorageSummary Source #
Contains information about your data store.
See: newDatastoreStorageSummary smart constructor.
Constructors
| DatastoreStorageSummary' (Maybe ServiceManagedDatastoreS3StorageSummary) (Maybe CustomerManagedDatastoreS3StorageSummary) (Maybe DatastoreIotSiteWiseMultiLayerStorageSummary) |
Instances
newDatastoreStorageSummary :: DatastoreStorageSummary Source #
Create a value of DatastoreStorageSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:serviceManagedS3:DatastoreStorageSummary', datastoreStorageSummary_serviceManagedS3 - Used to store data in an Amazon S3 bucket managed by IoT Analytics.
$sel:customerManagedS3:DatastoreStorageSummary', datastoreStorageSummary_customerManagedS3 - Used to store data in an Amazon S3 bucket managed by IoT Analytics.
$sel:iotSiteWiseMultiLayerStorage:DatastoreStorageSummary', datastoreStorageSummary_iotSiteWiseMultiLayerStorage - Used to store data used by IoT SiteWise in an Amazon S3 bucket that you
manage.
DatastoreSummary
data DatastoreSummary Source #
A summary of information about a data store.
See: newDatastoreSummary smart constructor.
Constructors
| DatastoreSummary' (Maybe POSIX) (Maybe DatastoreStatus) (Maybe POSIX) (Maybe Text) (Maybe DatastorePartitions) (Maybe FileFormatType) (Maybe POSIX) (Maybe DatastoreStorageSummary) |
Instances
newDatastoreSummary :: DatastoreSummary Source #
Create a value of DatastoreSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:DatastoreSummary', datastoreSummary_creationTime - When the data store was created.
$sel:status:DatastoreSummary', datastoreSummary_status - The status of the data store.
$sel:lastMessageArrivalTime:DatastoreSummary', datastoreSummary_lastMessageArrivalTime - The last time when a new message arrived in the data store.
IoT Analytics updates this value at most once per minute for Amazon
Simple Storage Service one data store. Hence, the
lastMessageArrivalTime value is an approximation.
This feature only applies to messages that arrived in the data store after October 23, 2020.
$sel:datastoreName:DatastoreSummary', datastoreSummary_datastoreName - The name of the data store.
$sel:datastorePartitions:DatastoreSummary', datastoreSummary_datastorePartitions - Contains information about the partition dimensions in a data store.
$sel:fileFormatType:DatastoreSummary', datastoreSummary_fileFormatType - The file format of the data in the data store.
$sel:lastUpdateTime:DatastoreSummary', datastoreSummary_lastUpdateTime - The last time the data store was updated.
$sel:datastoreStorage:DatastoreSummary', datastoreSummary_datastoreStorage - Where data in a data store is stored.
DeltaTime
Used to limit data to that which has arrived since the last execution of the action.
See: newDeltaTime smart constructor.
Constructors
| DeltaTime' Int Text |
Instances
| Eq DeltaTime Source # | |
| Read DeltaTime Source # | |
| Show DeltaTime Source # | |
| Generic DeltaTime Source # | |
| NFData DeltaTime Source # | |
Defined in Amazonka.IoTAnalytics.Types.DeltaTime | |
| Hashable DeltaTime Source # | |
Defined in Amazonka.IoTAnalytics.Types.DeltaTime | |
| ToJSON DeltaTime Source # | |
Defined in Amazonka.IoTAnalytics.Types.DeltaTime | |
| FromJSON DeltaTime Source # | |
| type Rep DeltaTime Source # | |
Defined in Amazonka.IoTAnalytics.Types.DeltaTime type Rep DeltaTime = D1 ('MetaData "DeltaTime" "Amazonka.IoTAnalytics.Types.DeltaTime" "libZSservicesZSamazonka-iot-analyticsZSamazonka-iot-analytics" 'False) (C1 ('MetaCons "DeltaTime'" 'PrefixI 'True) (S1 ('MetaSel ('Just "offsetSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "timeExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of DeltaTime with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:offsetSeconds:DeltaTime', deltaTime_offsetSeconds - The number of seconds of estimated in-flight lag time of message data.
When you create dataset contents using message data from a specified
timeframe, some message data might still be in flight when processing
begins, and so do not arrive in time to be processed. Use this field to
make allowances for the in flight time of your message data, so that
data not processed from a previous timeframe is included with the next
timeframe. Otherwise, missed message data would be excluded from
processing during the next timeframe too, because its timestamp places
it within the previous timeframe.
$sel:timeExpression:DeltaTime', deltaTime_timeExpression - An expression by which the time of the message data might be determined.
This can be the name of a timestamp field or a SQL expression that is
used to derive the time the message data was generated.
DeltaTimeSessionWindowConfiguration
data DeltaTimeSessionWindowConfiguration Source #
A structure that contains the configuration information of a delta time session window.
DeltaTime
specifies a time interval. You can use DeltaTime to create dataset
contents with data that has arrived in the data store since the last
execution. For an example of DeltaTime, see
Creating a SQL dataset with a delta window (CLI)
in the IoT Analytics User Guide.
See: newDeltaTimeSessionWindowConfiguration smart constructor.
Constructors
| DeltaTimeSessionWindowConfiguration' Natural |
Instances
newDeltaTimeSessionWindowConfiguration Source #
Arguments
| :: Natural | |
| -> DeltaTimeSessionWindowConfiguration |
Create a value of DeltaTimeSessionWindowConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:timeoutInMinutes:DeltaTimeSessionWindowConfiguration', deltaTimeSessionWindowConfiguration_timeoutInMinutes - A time interval. You can use timeoutInMinutes so that IoT Analytics
can batch up late data notifications that have been generated since the
last execution. IoT Analytics sends one batch of notifications to Amazon
CloudWatch Events at one time.
For more information about how to write a timestamp expression, see Date and Time Functions and Operators, in the Presto 0.172 Documentation.
DeviceRegistryEnrichActivity
data DeviceRegistryEnrichActivity Source #
An activity that adds data from the IoT device registry to your message.
See: newDeviceRegistryEnrichActivity smart constructor.
Instances
newDeviceRegistryEnrichActivity Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> DeviceRegistryEnrichActivity |
Create a value of DeviceRegistryEnrichActivity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:next:DeviceRegistryEnrichActivity', deviceRegistryEnrichActivity_next - The next activity in the pipeline.
$sel:name:DeviceRegistryEnrichActivity', deviceRegistryEnrichActivity_name - The name of the deviceRegistryEnrich activity.
$sel:attribute:DeviceRegistryEnrichActivity', deviceRegistryEnrichActivity_attribute - The name of the attribute that is added to the message.
$sel:thingName:DeviceRegistryEnrichActivity', deviceRegistryEnrichActivity_thingName - The name of the IoT device whose registry information is added to the
message.
$sel:roleArn:DeviceRegistryEnrichActivity', deviceRegistryEnrichActivity_roleArn - 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 IoT Device Shadow service to a message.
See: newDeviceShadowEnrichActivity smart constructor.
Instances
newDeviceShadowEnrichActivity Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> DeviceShadowEnrichActivity |
Create a value of DeviceShadowEnrichActivity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:next:DeviceShadowEnrichActivity', deviceShadowEnrichActivity_next - The next activity in the pipeline.
$sel:name:DeviceShadowEnrichActivity', deviceShadowEnrichActivity_name - The name of the deviceShadowEnrich activity.
$sel:attribute:DeviceShadowEnrichActivity', deviceShadowEnrichActivity_attribute - The name of the attribute that is added to the message.
$sel:thingName:DeviceShadowEnrichActivity', deviceShadowEnrichActivity_thingName - The name of the IoT device whose shadow information is added to the
message.
$sel:roleArn:DeviceShadowEnrichActivity', deviceShadowEnrichActivity_roleArn - The ARN of the role that allows access to the device's shadow.
EstimatedResourceSize
data EstimatedResourceSize Source #
The estimated size of the resource.
See: newEstimatedResourceSize smart constructor.
Constructors
| EstimatedResourceSize' (Maybe POSIX) (Maybe Double) |
Instances
newEstimatedResourceSize :: EstimatedResourceSize Source #
Create a value of EstimatedResourceSize with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:estimatedOn:EstimatedResourceSize', estimatedResourceSize_estimatedOn - The time when the estimate of the size of the resource was made.
$sel:estimatedSizeInBytes:EstimatedResourceSize', estimatedResourceSize_estimatedSizeInBytes - The estimated size of the resource, in bytes.
FileFormatConfiguration
data FileFormatConfiguration Source #
Contains the configuration information of file formats. 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.
See: newFileFormatConfiguration smart constructor.
Constructors
| FileFormatConfiguration' (Maybe JsonConfiguration) (Maybe ParquetConfiguration) |
Instances
newFileFormatConfiguration :: FileFormatConfiguration Source #
Create a value of FileFormatConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jsonConfiguration:FileFormatConfiguration', fileFormatConfiguration_jsonConfiguration - Contains the configuration information of the JSON format.
$sel:parquetConfiguration:FileFormatConfiguration', fileFormatConfiguration_parquetConfiguration - Contains the configuration information of the Parquet format.
FilterActivity
data FilterActivity Source #
An activity that filters a message based on its attributes.
See: newFilterActivity smart constructor.
Constructors
| FilterActivity' (Maybe Text) Text Text |
Instances
Create a value of FilterActivity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:next:FilterActivity', filterActivity_next - The next activity in the pipeline.
$sel:name:FilterActivity', filterActivity_name - The name of the filter activity.
$sel:filter':FilterActivity', filterActivity_filter - An expression that looks like a SQL WHERE clause that must return a
Boolean value. Messages that satisfy the condition are passed to the
next activity.
GlueConfiguration
data GlueConfiguration Source #
Configuration information for coordination with Glue, a fully managed extract, transform and load (ETL) service.
See: newGlueConfiguration smart constructor.
Constructors
| GlueConfiguration' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> GlueConfiguration |
Create a value of GlueConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tableName:GlueConfiguration', glueConfiguration_tableName - The name of the table in your Glue Data Catalog that is used to perform
the ETL operations. An Glue Data Catalog table contains partitioned data
and descriptions of data sources and targets.
$sel:databaseName:GlueConfiguration', glueConfiguration_databaseName - The name of the database in your Glue Data Catalog in which the table is
located. An Glue Data Catalog database contains metadata tables.
IotEventsDestinationConfiguration
data IotEventsDestinationConfiguration Source #
Configuration information for delivery of dataset contents to IoT Events.
See: newIotEventsDestinationConfiguration smart constructor.
Constructors
| IotEventsDestinationConfiguration' Text Text |
Instances
newIotEventsDestinationConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> IotEventsDestinationConfiguration |
Create a value of IotEventsDestinationConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:inputName:IotEventsDestinationConfiguration', iotEventsDestinationConfiguration_inputName - The name of the IoT Events input to which dataset contents are
delivered.
$sel:roleArn:IotEventsDestinationConfiguration', iotEventsDestinationConfiguration_roleArn - The ARN of the role that grants IoT Analytics permission to deliver
dataset contents to an IoT Events input.
IotSiteWiseCustomerManagedDatastoreS3Storage
data IotSiteWiseCustomerManagedDatastoreS3Storage Source #
Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage. You can't change the choice of Amazon S3 storage after your data store is created.
See: newIotSiteWiseCustomerManagedDatastoreS3Storage smart constructor.
Constructors
| IotSiteWiseCustomerManagedDatastoreS3Storage' (Maybe Text) Text |
Instances
newIotSiteWiseCustomerManagedDatastoreS3Storage Source #
Arguments
| :: Text | |
| -> IotSiteWiseCustomerManagedDatastoreS3Storage |
Create a value of IotSiteWiseCustomerManagedDatastoreS3Storage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyPrefix:IotSiteWiseCustomerManagedDatastoreS3Storage', iotSiteWiseCustomerManagedDatastoreS3Storage_keyPrefix - (Optional) The prefix used to create the keys of the data store data
objects. Each object in an Amazon S3 bucket has a key that is its unique
identifier in the bucket. Each object in a bucket has exactly one key.
The prefix must end with a forward slash (/).
$sel:bucket:IotSiteWiseCustomerManagedDatastoreS3Storage', iotSiteWiseCustomerManagedDatastoreS3Storage_bucket - The name of the Amazon S3 bucket where your data is stored.
IotSiteWiseCustomerManagedDatastoreS3StorageSummary
data IotSiteWiseCustomerManagedDatastoreS3StorageSummary Source #
Contains information about the data store that you manage, which stores data used by IoT SiteWise.
See: newIotSiteWiseCustomerManagedDatastoreS3StorageSummary smart constructor.
Constructors
| IotSiteWiseCustomerManagedDatastoreS3StorageSummary' (Maybe Text) (Maybe Text) |
Instances
newIotSiteWiseCustomerManagedDatastoreS3StorageSummary :: IotSiteWiseCustomerManagedDatastoreS3StorageSummary Source #
Create a value of IotSiteWiseCustomerManagedDatastoreS3StorageSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bucket:IotSiteWiseCustomerManagedDatastoreS3StorageSummary', iotSiteWiseCustomerManagedDatastoreS3StorageSummary_bucket - The name of the Amazon S3 bucket where your data is stored.
$sel:keyPrefix:IotSiteWiseCustomerManagedDatastoreS3StorageSummary', iotSiteWiseCustomerManagedDatastoreS3StorageSummary_keyPrefix - (Optional) The prefix used to create the keys of the data store data
objects. Each object in an Amazon S3 bucket has a key that is its unique
identifier in the bucket. Each object in a bucket has exactly one key.
The prefix must end with a forward slash (/).
JsonConfiguration
data JsonConfiguration Source #
Contains the configuration information of the JSON format.
See: newJsonConfiguration smart constructor.
Constructors
| JsonConfiguration' | |
Instances
newJsonConfiguration :: JsonConfiguration Source #
Create a value of JsonConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
LambdaActivity
data LambdaActivity Source #
An activity that runs a Lambda function to modify the message.
See: newLambdaActivity smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Natural | |
| -> LambdaActivity |
Create a value of LambdaActivity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:next:LambdaActivity', lambdaActivity_next - The next activity in the pipeline.
$sel:name:LambdaActivity', lambdaActivity_name - The name of the lambda activity.
$sel:lambdaName:LambdaActivity', lambdaActivity_lambdaName - The name of the Lambda function that is run on the message.
$sel:batchSize:LambdaActivity', lambdaActivity_batchSize - The number of messages passed to the Lambda function for processing.
The Lambda function must be able to process all of these messages within five minutes, which is the maximum timeout duration for Lambda functions.
LateDataRule
data LateDataRule Source #
A structure that contains the name and configuration information of a late data rule.
See: newLateDataRule smart constructor.
Constructors
| LateDataRule' (Maybe Text) LateDataRuleConfiguration |
Instances
Create a value of LateDataRule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ruleName:LateDataRule', lateDataRule_ruleName - The name of the late data rule.
$sel:ruleConfiguration:LateDataRule', lateDataRule_ruleConfiguration - The information needed to configure the late data rule.
LateDataRuleConfiguration
data LateDataRuleConfiguration Source #
The information needed to configure a delta time session window.
See: newLateDataRuleConfiguration smart constructor.
Instances
newLateDataRuleConfiguration :: LateDataRuleConfiguration Source #
Create a value of LateDataRuleConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deltaTimeSessionWindowConfiguration:LateDataRuleConfiguration', lateDataRuleConfiguration_deltaTimeSessionWindowConfiguration - The information needed to configure a delta time session window.
LoggingOptions
data LoggingOptions Source #
Information about logging options.
See: newLoggingOptions smart constructor.
Constructors
| LoggingOptions' Text LoggingLevel Bool |
Instances
Arguments
| :: Text | |
| -> LoggingLevel | |
| -> Bool | |
| -> LoggingOptions |
Create a value of LoggingOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:roleArn:LoggingOptions', loggingOptions_roleArn - The ARN of the role that grants permission to IoT Analytics to perform
logging.
$sel:level:LoggingOptions', loggingOptions_level - The logging level. Currently, only ERROR is supported.
$sel:enabled:LoggingOptions', loggingOptions_enabled - If true, logging is enabled for IoT Analytics.
MathActivity
data MathActivity Source #
An activity that computes an arithmetic expression using the message's attributes.
See: newMathActivity smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> MathActivity |
Create a value of MathActivity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:next:MathActivity', mathActivity_next - The next activity in the pipeline.
$sel:name:MathActivity', mathActivity_name - The name of the math activity.
$sel:attribute:MathActivity', mathActivity_attribute - The name of the attribute that contains the result of the math
operation.
$sel:math:MathActivity', mathActivity_math - An expression that uses one or more existing attributes and must return
an integer value.
Message
Information about a message.
See: newMessage smart constructor.
Instances
| Eq Message Source # | |
| Read Message Source # | |
| Show Message Source # | |
| Generic Message Source # | |
| NFData Message Source # | |
Defined in Amazonka.IoTAnalytics.Types.Message | |
| Hashable Message Source # | |
Defined in Amazonka.IoTAnalytics.Types.Message | |
| ToJSON Message Source # | |
Defined in Amazonka.IoTAnalytics.Types.Message | |
| type Rep Message Source # | |
Defined in Amazonka.IoTAnalytics.Types.Message type Rep Message = D1 ('MetaData "Message" "Amazonka.IoTAnalytics.Types.Message" "libZSservicesZSamazonka-iot-analyticsZSamazonka-iot-analytics" 'False) (C1 ('MetaCons "Message'" 'PrefixI 'True) (S1 ('MetaSel ('Just "messageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "payload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Base64))) | |
Arguments
| :: Text | |
| -> ByteString | |
| -> Message |
Create a value of Message with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:messageId:Message', message_messageId - The ID you want to assign to the message. Each messageId must be
unique within each batch sent.
$sel:payload:Message', message_payload - The payload of the message. This can be a JSON string or a
base64-encoded string representing binary data, in which case you must
decode it by means of a pipeline activity.--
-- 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.
OutputFileUriValue
data OutputFileUriValue Source #
The value of the variable as a structure that specifies an output file URI.
See: newOutputFileUriValue smart constructor.
Constructors
| OutputFileUriValue' Text |
Instances
newOutputFileUriValue Source #
Arguments
| :: Text | |
| -> OutputFileUriValue |
Create a value of OutputFileUriValue with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileName:OutputFileUriValue', outputFileUriValue_fileName - The URI of the location where dataset contents are stored, usually the
URI of a file in an S3 bucket.
ParquetConfiguration
data ParquetConfiguration Source #
Contains the configuration information of the Parquet format.
See: newParquetConfiguration smart constructor.
Constructors
| ParquetConfiguration' (Maybe SchemaDefinition) |
Instances
newParquetConfiguration :: ParquetConfiguration Source #
Create a value of ParquetConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:schemaDefinition:ParquetConfiguration', parquetConfiguration_schemaDefinition - Information needed to define a schema.
Partition
A partition dimension defined by an attribute.
See: newPartition smart constructor.
Constructors
| Partition' Text |
Instances
| Eq Partition Source # | |
| Read Partition Source # | |
| Show Partition Source # | |
| Generic Partition Source # | |
| NFData Partition Source # | |
Defined in Amazonka.IoTAnalytics.Types.Partition | |
| Hashable Partition Source # | |
Defined in Amazonka.IoTAnalytics.Types.Partition | |
| ToJSON Partition Source # | |
Defined in Amazonka.IoTAnalytics.Types.Partition | |
| FromJSON Partition Source # | |
| type Rep Partition Source # | |
Defined in Amazonka.IoTAnalytics.Types.Partition type Rep Partition = D1 ('MetaData "Partition" "Amazonka.IoTAnalytics.Types.Partition" "libZSservicesZSamazonka-iot-analyticsZSamazonka-iot-analytics" 'False) (C1 ('MetaCons "Partition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Partition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributeName:Partition', partition_attributeName - The name of the attribute that defines a partition dimension.
Pipeline
Contains information about a pipeline.
See: newPipeline smart constructor.
Constructors
| Pipeline' (Maybe POSIX) (Maybe Text) (Maybe (NonEmpty PipelineActivity)) (Maybe Text) (Maybe [ReprocessingSummary]) (Maybe POSIX) |
Instances
newPipeline :: Pipeline Source #
Create a value of Pipeline with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:Pipeline', pipeline_creationTime - When the pipeline was created.
$sel:arn:Pipeline', pipeline_arn - The ARN of the pipeline.
$sel:activities:Pipeline', pipeline_activities - The activities that perform transformations on the messages.
$sel:name:Pipeline', pipeline_name - The name of the pipeline.
$sel:reprocessingSummaries:Pipeline', pipeline_reprocessingSummaries - A summary of information about the pipeline reprocessing.
$sel:lastUpdateTime:Pipeline', pipeline_lastUpdateTime - The last time the pipeline was updated.
PipelineActivity
data PipelineActivity Source #
An activity that performs a transformation on a message.
See: newPipelineActivity smart constructor.
Constructors
Instances
newPipelineActivity :: PipelineActivity Source #
Create a value of PipelineActivity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:selectAttributes:PipelineActivity', pipelineActivity_selectAttributes - Used to create a new message using only the specified attributes from
the original message.
$sel:channel:PipelineActivity', pipelineActivity_channel - Determines the source of the messages to be processed.
$sel:addAttributes:PipelineActivity', pipelineActivity_addAttributes - Adds other attributes based on existing attributes in the message.
$sel:deviceRegistryEnrich:PipelineActivity', pipelineActivity_deviceRegistryEnrich - Adds data from the IoT device registry to your message.
$sel:removeAttributes:PipelineActivity', pipelineActivity_removeAttributes - Removes attributes from a message.
$sel:lambda:PipelineActivity', pipelineActivity_lambda - Runs a Lambda function to modify the message.
$sel:datastore:PipelineActivity', pipelineActivity_datastore - Specifies where to store the processed message data.
$sel:deviceShadowEnrich:PipelineActivity', pipelineActivity_deviceShadowEnrich - Adds information from the IoT Device Shadow service to a message.
$sel:filter':PipelineActivity', pipelineActivity_filter - Filters a message based on its attributes.
$sel:math:PipelineActivity', pipelineActivity_math - 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: newPipelineSummary smart constructor.
Constructors
| PipelineSummary' (Maybe POSIX) (Maybe Text) (Maybe [ReprocessingSummary]) (Maybe POSIX) |
Instances
newPipelineSummary :: PipelineSummary Source #
Create a value of PipelineSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:PipelineSummary', pipelineSummary_creationTime - When the pipeline was created.
$sel:pipelineName:PipelineSummary', pipelineSummary_pipelineName - The name of the pipeline.
$sel:reprocessingSummaries:PipelineSummary', pipelineSummary_reprocessingSummaries - A summary of information about the pipeline reprocessing.
$sel:lastUpdateTime:PipelineSummary', pipelineSummary_lastUpdateTime - When the pipeline was last updated.
QueryFilter
data QueryFilter Source #
Information that is used to filter message data, to segregate it according to the timeframe in which it arrives.
See: newQueryFilter smart constructor.
Constructors
| QueryFilter' (Maybe DeltaTime) |
Instances
newQueryFilter :: QueryFilter Source #
Create a value of QueryFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deltaTime:QueryFilter', queryFilter_deltaTime - Used to limit data to that which has arrived since the last execution of
the action.
RemoveAttributesActivity
data RemoveAttributesActivity Source #
An activity that removes attributes from a message.
See: newRemoveAttributesActivity smart constructor.
Instances
newRemoveAttributesActivity Source #
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> RemoveAttributesActivity |
Create a value of RemoveAttributesActivity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:next:RemoveAttributesActivity', removeAttributesActivity_next - The next activity in the pipeline.
$sel:name:RemoveAttributesActivity', removeAttributesActivity_name - The name of the removeAttributes activity.
$sel:attributes:RemoveAttributesActivity', removeAttributesActivity_attributes - A list of 1-50 attributes to remove from the message.
ReprocessingSummary
data ReprocessingSummary Source #
Information about pipeline reprocessing.
See: newReprocessingSummary smart constructor.
Constructors
| ReprocessingSummary' (Maybe POSIX) (Maybe ReprocessingStatus) (Maybe Text) |
Instances
newReprocessingSummary :: ReprocessingSummary Source #
Create a value of ReprocessingSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:ReprocessingSummary', reprocessingSummary_creationTime - The time the pipeline reprocessing was created.
$sel:status:ReprocessingSummary', reprocessingSummary_status - The status of the pipeline reprocessing.
$sel:id:ReprocessingSummary', reprocessingSummary_id - The reprocessingId returned by StartPipelineReprocessing.
ResourceConfiguration
data ResourceConfiguration Source #
The configuration of the resource used to execute the containerAction.
See: newResourceConfiguration smart constructor.
Constructors
| ResourceConfiguration' ComputeType Natural |
Instances
newResourceConfiguration Source #
Arguments
| :: ComputeType | |
| -> Natural | |
| -> ResourceConfiguration |
Create a value of ResourceConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:computeType:ResourceConfiguration', resourceConfiguration_computeType - The type of the compute resource used to execute the containerAction.
Possible values are: ACU_1 (vCPU=4, memory=16 GiB) or ACU_2 (vCPU=8,
memory=32 GiB).
$sel:volumeSizeInGB:ResourceConfiguration', resourceConfiguration_volumeSizeInGB - The size, in GB, of the persistent storage available to the resource
instance used to execute the containerAction (min: 1, max: 50).
RetentionPeriod
data RetentionPeriod Source #
How long, in days, message data is kept.
See: newRetentionPeriod smart constructor.
Constructors
| RetentionPeriod' (Maybe Bool) (Maybe Natural) |
Instances
newRetentionPeriod :: RetentionPeriod Source #
Create a value of RetentionPeriod with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:unlimited:RetentionPeriod', retentionPeriod_unlimited - If true, message data is kept indefinitely.
$sel:numberOfDays:RetentionPeriod', retentionPeriod_numberOfDays - The number of days that message data is kept. The unlimited parameter
must be false.
S3DestinationConfiguration
data S3DestinationConfiguration Source #
Configuration information for delivery of dataset contents to Amazon Simple Storage Service (Amazon S3).
See: newS3DestinationConfiguration smart constructor.
Constructors
| S3DestinationConfiguration' (Maybe GlueConfiguration) Text Text Text |
Instances
newS3DestinationConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> S3DestinationConfiguration |
Create a value of S3DestinationConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:glueConfiguration:S3DestinationConfiguration', s3DestinationConfiguration_glueConfiguration - Configuration information for coordination with Glue, a fully managed
extract, transform and load (ETL) service.
$sel:bucket:S3DestinationConfiguration', s3DestinationConfiguration_bucket - The name of the S3 bucket to which dataset contents are delivered.
$sel:key:S3DestinationConfiguration', s3DestinationConfiguration_key - The key of the dataset contents object in an S3 bucket. Each object has
a key that is a unique identifier. Each object has exactly one key.
You can create a unique key with the following options:
- Use
!{iotanalytics:scheduleTime}to insert the time of a scheduled SQL query run. - Use
!{iotanalytics:versionId}to insert a unique hash that identifies a dataset content. - Use
!{iotanalytics:creationTime}to insert the creation time of a dataset content.
The following example creates a unique key for a CSV file:
dataset/mydataset/!{iotanalytics:scheduleTime}/!{iotanalytics:versionId}.csv
If you don't use !{iotanalytics:versionId} to specify the key, you
might get duplicate keys. For example, you might have two dataset
contents with the same scheduleTime but different versionIds. This
means that one dataset content overwrites the other.
$sel:roleArn:S3DestinationConfiguration', s3DestinationConfiguration_roleArn - The ARN of the role that grants IoT Analytics permission to interact
with your Amazon S3 and Glue resources.
Schedule
The schedule for when to trigger an update.
See: newSchedule smart constructor.
Instances
| Eq Schedule Source # | |
| Read Schedule Source # | |
| Show Schedule Source # | |
| Generic Schedule Source # | |
| NFData Schedule Source # | |
Defined in Amazonka.IoTAnalytics.Types.Schedule | |
| Hashable Schedule Source # | |
Defined in Amazonka.IoTAnalytics.Types.Schedule | |
| ToJSON Schedule Source # | |
Defined in Amazonka.IoTAnalytics.Types.Schedule | |
| FromJSON Schedule Source # | |
| type Rep Schedule Source # | |
Defined in Amazonka.IoTAnalytics.Types.Schedule type Rep Schedule = D1 ('MetaData "Schedule" "Amazonka.IoTAnalytics.Types.Schedule" "libZSservicesZSamazonka-iot-analyticsZSamazonka-iot-analytics" 'False) (C1 ('MetaCons "Schedule'" 'PrefixI 'True) (S1 ('MetaSel ('Just "expression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
newSchedule :: Schedule Source #
Create a value of Schedule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expression:Schedule', schedule_expression - The expression that defines when to trigger an update. For more
information, see
Schedule Expressions for Rules
in the Amazon CloudWatch Events User Guide.
SchemaDefinition
data SchemaDefinition Source #
Information needed to define a schema.
See: newSchemaDefinition smart constructor.
Constructors
| SchemaDefinition' (Maybe [Column]) |
Instances
newSchemaDefinition :: SchemaDefinition Source #
Create a value of SchemaDefinition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:columns:SchemaDefinition', schemaDefinition_columns - Specifies one or more columns that store your data.
Each schema can have up to 100 columns. Each column can have up to 100 nested types.
SelectAttributesActivity
data SelectAttributesActivity Source #
Used to create a new message using only the specified attributes from the original message.
See: newSelectAttributesActivity smart constructor.
Instances
newSelectAttributesActivity Source #
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> SelectAttributesActivity |
Create a value of SelectAttributesActivity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:next:SelectAttributesActivity', selectAttributesActivity_next - The next activity in the pipeline.
$sel:name:SelectAttributesActivity', selectAttributesActivity_name - The name of the selectAttributes activity.
$sel:attributes:SelectAttributesActivity', selectAttributesActivity_attributes - A list of the attributes to select from the message.
ServiceManagedChannelS3Storage
data ServiceManagedChannelS3Storage Source #
Used to store channel data in an S3 bucket managed by IoT Analytics. You can't change the choice of S3 storage after the data store is created.
See: newServiceManagedChannelS3Storage smart constructor.
Constructors
| ServiceManagedChannelS3Storage' | |
Instances
newServiceManagedChannelS3Storage :: ServiceManagedChannelS3Storage Source #
Create a value of ServiceManagedChannelS3Storage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ServiceManagedChannelS3StorageSummary
data ServiceManagedChannelS3StorageSummary Source #
Used to store channel data in an S3 bucket managed by IoT Analytics.
See: newServiceManagedChannelS3StorageSummary smart constructor.
Constructors
| ServiceManagedChannelS3StorageSummary' | |
Instances
newServiceManagedChannelS3StorageSummary :: ServiceManagedChannelS3StorageSummary Source #
Create a value of ServiceManagedChannelS3StorageSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ServiceManagedDatastoreS3Storage
data ServiceManagedDatastoreS3Storage Source #
Used to store data in an Amazon S3 bucket managed by IoT Analytics. You can't change the choice of Amazon S3 storage after your data store is created.
See: newServiceManagedDatastoreS3Storage smart constructor.
Constructors
| ServiceManagedDatastoreS3Storage' | |
Instances
newServiceManagedDatastoreS3Storage :: ServiceManagedDatastoreS3Storage Source #
Create a value of ServiceManagedDatastoreS3Storage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ServiceManagedDatastoreS3StorageSummary
data ServiceManagedDatastoreS3StorageSummary Source #
Contains information about the data store that is managed by IoT Analytics.
See: newServiceManagedDatastoreS3StorageSummary smart constructor.
Constructors
| ServiceManagedDatastoreS3StorageSummary' | |
Instances
newServiceManagedDatastoreS3StorageSummary :: ServiceManagedDatastoreS3StorageSummary Source #
Create a value of ServiceManagedDatastoreS3StorageSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
SqlQueryDatasetAction
data SqlQueryDatasetAction Source #
The SQL query to modify the message.
See: newSqlQueryDatasetAction smart constructor.
Constructors
| SqlQueryDatasetAction' (Maybe [QueryFilter]) Text |
Instances
newSqlQueryDatasetAction Source #
Create a value of SqlQueryDatasetAction with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:SqlQueryDatasetAction', sqlQueryDatasetAction_filters - Prefilters applied to message data.
$sel:sqlQuery:SqlQueryDatasetAction', sqlQueryDatasetAction_sqlQuery - A SQL query string.
Tag
A set of key-value pairs that are used to manage the resource.
See: newTag smart constructor.
Instances
| Eq Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| Generic Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.IoTAnalytics.Types.Tag | |
| Hashable Tag Source # | |
Defined in Amazonka.IoTAnalytics.Types.Tag | |
| ToJSON Tag Source # | |
Defined in Amazonka.IoTAnalytics.Types.Tag | |
| FromJSON Tag Source # | |
| type Rep Tag Source # | |
Defined in Amazonka.IoTAnalytics.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.IoTAnalytics.Types.Tag" "libZSservicesZSamazonka-iot-analyticsZSamazonka-iot-analytics" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - The tag's key.
$sel:value:Tag', tag_value - The tag's value.
TimestampPartition
data TimestampPartition Source #
A partition dimension defined by a timestamp attribute.
See: newTimestampPartition smart constructor.
Constructors
| TimestampPartition' (Maybe Text) Text |
Instances
newTimestampPartition Source #
Arguments
| :: Text | |
| -> TimestampPartition |
Create a value of TimestampPartition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:timestampFormat:TimestampPartition', timestampPartition_timestampFormat - The timestamp format of a partition defined by a timestamp. The default
format is seconds since epoch (January 1, 1970 at midnight UTC time).
$sel:attributeName:TimestampPartition', timestampPartition_attributeName - The attribute name of the partition defined by a timestamp.
TriggeringDataset
data TriggeringDataset Source #
Information about the dataset whose content generation triggers the new dataset content generation.
See: newTriggeringDataset smart constructor.
Constructors
| TriggeringDataset' Text |
Instances
Arguments
| :: Text | |
| -> TriggeringDataset |
Create a value of TriggeringDataset with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:TriggeringDataset', triggeringDataset_name - The name of the dataset whose content generation triggers the new
dataset content generation.
Variable
An instance of a variable to be passed to the containerAction
execution. Each variable must have a name and a value given by one of
stringValue, datasetContentVersionValue, or outputFileUriValue.
See: newVariable smart constructor.
Constructors
| Variable' (Maybe OutputFileUriValue) (Maybe Double) (Maybe Text) (Maybe DatasetContentVersionValue) Text |
Instances
Create a value of Variable with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:outputFileUriValue:Variable', variable_outputFileUriValue - The value of the variable as a structure that specifies an output file
URI.
$sel:doubleValue:Variable', variable_doubleValue - The value of the variable as a double (numeric).
$sel:stringValue:Variable', variable_stringValue - The value of the variable as a string.
$sel:datasetContentVersionValue:Variable', variable_datasetContentVersionValue - The value of the variable as a structure that specifies a dataset
content version.
$sel:name:Variable', variable_name - The name of the variable.
VersioningConfiguration
data VersioningConfiguration Source #
Information about the versioning of dataset contents.
See: newVersioningConfiguration smart constructor.
Constructors
| VersioningConfiguration' (Maybe Bool) (Maybe Natural) |
Instances
newVersioningConfiguration :: VersioningConfiguration Source #
Create a value of VersioningConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:unlimited:VersioningConfiguration', versioningConfiguration_unlimited - If true, unlimited versions of dataset contents are kept.
$sel:maxVersions:VersioningConfiguration', versioningConfiguration_maxVersions - How many versions of dataset contents are kept. The unlimited
parameter must be false.