| 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.IoTEvents.Types
Contents
- Service Configuration
- Errors
- AlarmModelVersionStatus
- AnalysisResultLevel
- AnalysisStatus
- ComparisonOperator
- DetectorModelVersionStatus
- EvaluationMethod
- InputStatus
- LoggingLevel
- PayloadType
- AcknowledgeFlow
- Action
- AlarmAction
- AlarmCapabilities
- AlarmEventActions
- AlarmModelSummary
- AlarmModelVersionSummary
- AlarmNotification
- AlarmRule
- AnalysisResult
- AnalysisResultLocation
- AssetPropertyTimestamp
- AssetPropertyValue
- AssetPropertyVariant
- Attribute
- ClearTimerAction
- DetectorDebugOption
- DetectorModel
- DetectorModelConfiguration
- DetectorModelDefinition
- DetectorModelSummary
- DetectorModelVersionSummary
- DynamoDBAction
- DynamoDBv2Action
- EmailConfiguration
- EmailContent
- EmailRecipients
- Event
- FirehoseAction
- InitializationConfiguration
- Input
- InputConfiguration
- InputDefinition
- InputIdentifier
- InputSummary
- IotEventsAction
- IotEventsInputIdentifier
- IotSiteWiseAction
- IotSiteWiseAssetModelPropertyIdentifier
- IotSiteWiseInputIdentifier
- IotTopicPublishAction
- LambdaAction
- LoggingOptions
- NotificationAction
- NotificationTargetActions
- OnEnterLifecycle
- OnExitLifecycle
- OnInputLifecycle
- Payload
- RecipientDetail
- ResetTimerAction
- RoutedResource
- SMSConfiguration
- SNSTopicPublishAction
- SSOIdentity
- SetTimerAction
- SetVariableAction
- SimpleRule
- SqsAction
- State
- Tag
- TransitionEvent
Description
Synopsis
- defaultService :: Service
- _InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnsupportedOperationException :: 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
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype AlarmModelVersionStatus where
- newtype AnalysisResultLevel where
- AnalysisResultLevel' { }
- pattern AnalysisResultLevel_ERROR :: AnalysisResultLevel
- pattern AnalysisResultLevel_INFO :: AnalysisResultLevel
- pattern AnalysisResultLevel_WARNING :: AnalysisResultLevel
- newtype AnalysisStatus where
- AnalysisStatus' { }
- pattern AnalysisStatus_COMPLETE :: AnalysisStatus
- pattern AnalysisStatus_FAILED :: AnalysisStatus
- pattern AnalysisStatus_RUNNING :: AnalysisStatus
- newtype ComparisonOperator where
- ComparisonOperator' { }
- pattern ComparisonOperator_EQUAL :: ComparisonOperator
- pattern ComparisonOperator_GREATER :: ComparisonOperator
- pattern ComparisonOperator_GREATER_OR_EQUAL :: ComparisonOperator
- pattern ComparisonOperator_LESS :: ComparisonOperator
- pattern ComparisonOperator_LESS_OR_EQUAL :: ComparisonOperator
- pattern ComparisonOperator_NOT_EQUAL :: ComparisonOperator
- newtype DetectorModelVersionStatus where
- DetectorModelVersionStatus' { }
- pattern DetectorModelVersionStatus_ACTIVATING :: DetectorModelVersionStatus
- pattern DetectorModelVersionStatus_ACTIVE :: DetectorModelVersionStatus
- pattern DetectorModelVersionStatus_DEPRECATED :: DetectorModelVersionStatus
- pattern DetectorModelVersionStatus_DRAFT :: DetectorModelVersionStatus
- pattern DetectorModelVersionStatus_FAILED :: DetectorModelVersionStatus
- pattern DetectorModelVersionStatus_INACTIVE :: DetectorModelVersionStatus
- pattern DetectorModelVersionStatus_PAUSED :: DetectorModelVersionStatus
- newtype EvaluationMethod where
- EvaluationMethod' { }
- pattern EvaluationMethod_BATCH :: EvaluationMethod
- pattern EvaluationMethod_SERIAL :: EvaluationMethod
- newtype InputStatus where
- InputStatus' { }
- pattern InputStatus_ACTIVE :: InputStatus
- pattern InputStatus_CREATING :: InputStatus
- pattern InputStatus_DELETING :: InputStatus
- pattern InputStatus_UPDATING :: InputStatus
- newtype LoggingLevel where
- LoggingLevel' { }
- pattern LoggingLevel_DEBUG :: LoggingLevel
- pattern LoggingLevel_ERROR :: LoggingLevel
- pattern LoggingLevel_INFO :: LoggingLevel
- newtype PayloadType where
- PayloadType' { }
- pattern PayloadType_JSON :: PayloadType
- pattern PayloadType_STRING :: PayloadType
- data AcknowledgeFlow = AcknowledgeFlow' {}
- newAcknowledgeFlow :: Bool -> AcknowledgeFlow
- acknowledgeFlow_enabled :: Lens' AcknowledgeFlow Bool
- data Action = Action' {
- iotTopicPublish :: Maybe IotTopicPublishAction
- dynamoDBv2 :: Maybe DynamoDBv2Action
- resetTimer :: Maybe ResetTimerAction
- setTimer :: Maybe SetTimerAction
- sns :: Maybe SNSTopicPublishAction
- clearTimer :: Maybe ClearTimerAction
- dynamoDB :: Maybe DynamoDBAction
- firehose :: Maybe FirehoseAction
- iotSiteWise :: Maybe IotSiteWiseAction
- setVariable :: Maybe SetVariableAction
- lambda :: Maybe LambdaAction
- iotEvents :: Maybe IotEventsAction
- sqs :: Maybe SqsAction
- newAction :: Action
- action_iotTopicPublish :: Lens' Action (Maybe IotTopicPublishAction)
- action_dynamoDBv2 :: Lens' Action (Maybe DynamoDBv2Action)
- action_resetTimer :: Lens' Action (Maybe ResetTimerAction)
- action_setTimer :: Lens' Action (Maybe SetTimerAction)
- action_sns :: Lens' Action (Maybe SNSTopicPublishAction)
- action_clearTimer :: Lens' Action (Maybe ClearTimerAction)
- action_dynamoDB :: Lens' Action (Maybe DynamoDBAction)
- action_firehose :: Lens' Action (Maybe FirehoseAction)
- action_iotSiteWise :: Lens' Action (Maybe IotSiteWiseAction)
- action_setVariable :: Lens' Action (Maybe SetVariableAction)
- action_lambda :: Lens' Action (Maybe LambdaAction)
- action_iotEvents :: Lens' Action (Maybe IotEventsAction)
- action_sqs :: Lens' Action (Maybe SqsAction)
- data AlarmAction = AlarmAction' {
- iotTopicPublish :: Maybe IotTopicPublishAction
- dynamoDBv2 :: Maybe DynamoDBv2Action
- sns :: Maybe SNSTopicPublishAction
- dynamoDB :: Maybe DynamoDBAction
- firehose :: Maybe FirehoseAction
- iotSiteWise :: Maybe IotSiteWiseAction
- lambda :: Maybe LambdaAction
- iotEvents :: Maybe IotEventsAction
- sqs :: Maybe SqsAction
- newAlarmAction :: AlarmAction
- alarmAction_iotTopicPublish :: Lens' AlarmAction (Maybe IotTopicPublishAction)
- alarmAction_dynamoDBv2 :: Lens' AlarmAction (Maybe DynamoDBv2Action)
- alarmAction_sns :: Lens' AlarmAction (Maybe SNSTopicPublishAction)
- alarmAction_dynamoDB :: Lens' AlarmAction (Maybe DynamoDBAction)
- alarmAction_firehose :: Lens' AlarmAction (Maybe FirehoseAction)
- alarmAction_iotSiteWise :: Lens' AlarmAction (Maybe IotSiteWiseAction)
- alarmAction_lambda :: Lens' AlarmAction (Maybe LambdaAction)
- alarmAction_iotEvents :: Lens' AlarmAction (Maybe IotEventsAction)
- alarmAction_sqs :: Lens' AlarmAction (Maybe SqsAction)
- data AlarmCapabilities = AlarmCapabilities' {}
- newAlarmCapabilities :: AlarmCapabilities
- alarmCapabilities_acknowledgeFlow :: Lens' AlarmCapabilities (Maybe AcknowledgeFlow)
- alarmCapabilities_initializationConfiguration :: Lens' AlarmCapabilities (Maybe InitializationConfiguration)
- data AlarmEventActions = AlarmEventActions' {
- alarmActions :: Maybe [AlarmAction]
- newAlarmEventActions :: AlarmEventActions
- alarmEventActions_alarmActions :: Lens' AlarmEventActions (Maybe [AlarmAction])
- data AlarmModelSummary = AlarmModelSummary' {}
- newAlarmModelSummary :: AlarmModelSummary
- alarmModelSummary_creationTime :: Lens' AlarmModelSummary (Maybe UTCTime)
- alarmModelSummary_alarmModelName :: Lens' AlarmModelSummary (Maybe Text)
- alarmModelSummary_alarmModelDescription :: Lens' AlarmModelSummary (Maybe Text)
- data AlarmModelVersionSummary = AlarmModelVersionSummary' {}
- newAlarmModelVersionSummary :: AlarmModelVersionSummary
- alarmModelVersionSummary_creationTime :: Lens' AlarmModelVersionSummary (Maybe UTCTime)
- alarmModelVersionSummary_status :: Lens' AlarmModelVersionSummary (Maybe AlarmModelVersionStatus)
- alarmModelVersionSummary_alarmModelName :: Lens' AlarmModelVersionSummary (Maybe Text)
- alarmModelVersionSummary_statusMessage :: Lens' AlarmModelVersionSummary (Maybe Text)
- alarmModelVersionSummary_lastUpdateTime :: Lens' AlarmModelVersionSummary (Maybe UTCTime)
- alarmModelVersionSummary_alarmModelVersion :: Lens' AlarmModelVersionSummary (Maybe Text)
- alarmModelVersionSummary_alarmModelArn :: Lens' AlarmModelVersionSummary (Maybe Text)
- alarmModelVersionSummary_roleArn :: Lens' AlarmModelVersionSummary (Maybe Text)
- data AlarmNotification = AlarmNotification' {}
- newAlarmNotification :: AlarmNotification
- alarmNotification_notificationActions :: Lens' AlarmNotification (Maybe (NonEmpty NotificationAction))
- data AlarmRule = AlarmRule' {}
- newAlarmRule :: AlarmRule
- alarmRule_simpleRule :: Lens' AlarmRule (Maybe SimpleRule)
- data AnalysisResult = AnalysisResult' {}
- newAnalysisResult :: AnalysisResult
- analysisResult_type :: Lens' AnalysisResult (Maybe Text)
- analysisResult_message :: Lens' AnalysisResult (Maybe Text)
- analysisResult_level :: Lens' AnalysisResult (Maybe AnalysisResultLevel)
- analysisResult_locations :: Lens' AnalysisResult (Maybe [AnalysisResultLocation])
- data AnalysisResultLocation = AnalysisResultLocation' {}
- newAnalysisResultLocation :: AnalysisResultLocation
- analysisResultLocation_path :: Lens' AnalysisResultLocation (Maybe Text)
- data AssetPropertyTimestamp = AssetPropertyTimestamp' {}
- newAssetPropertyTimestamp :: Text -> AssetPropertyTimestamp
- assetPropertyTimestamp_offsetInNanos :: Lens' AssetPropertyTimestamp (Maybe Text)
- assetPropertyTimestamp_timeInSeconds :: Lens' AssetPropertyTimestamp Text
- data AssetPropertyValue = AssetPropertyValue' {}
- newAssetPropertyValue :: AssetPropertyValue
- assetPropertyValue_value :: Lens' AssetPropertyValue (Maybe AssetPropertyVariant)
- assetPropertyValue_quality :: Lens' AssetPropertyValue (Maybe Text)
- assetPropertyValue_timestamp :: Lens' AssetPropertyValue (Maybe AssetPropertyTimestamp)
- data AssetPropertyVariant = AssetPropertyVariant' {}
- newAssetPropertyVariant :: AssetPropertyVariant
- assetPropertyVariant_integerValue :: Lens' AssetPropertyVariant (Maybe Text)
- assetPropertyVariant_doubleValue :: Lens' AssetPropertyVariant (Maybe Text)
- assetPropertyVariant_stringValue :: Lens' AssetPropertyVariant (Maybe Text)
- assetPropertyVariant_booleanValue :: Lens' AssetPropertyVariant (Maybe Text)
- data Attribute = Attribute' {}
- newAttribute :: Text -> Attribute
- attribute_jsonPath :: Lens' Attribute Text
- data ClearTimerAction = ClearTimerAction' {}
- newClearTimerAction :: Text -> ClearTimerAction
- clearTimerAction_timerName :: Lens' ClearTimerAction Text
- data DetectorDebugOption = DetectorDebugOption' {}
- newDetectorDebugOption :: Text -> DetectorDebugOption
- detectorDebugOption_keyValue :: Lens' DetectorDebugOption (Maybe Text)
- detectorDebugOption_detectorModelName :: Lens' DetectorDebugOption Text
- data DetectorModel = DetectorModel' {}
- newDetectorModel :: DetectorModel
- detectorModel_detectorModelConfiguration :: Lens' DetectorModel (Maybe DetectorModelConfiguration)
- detectorModel_detectorModelDefinition :: Lens' DetectorModel (Maybe DetectorModelDefinition)
- data DetectorModelConfiguration = DetectorModelConfiguration' {
- creationTime :: Maybe POSIX
- status :: Maybe DetectorModelVersionStatus
- detectorModelName :: Maybe Text
- detectorModelArn :: Maybe Text
- detectorModelDescription :: Maybe Text
- key :: Maybe Text
- detectorModelVersion :: Maybe Text
- lastUpdateTime :: Maybe POSIX
- evaluationMethod :: Maybe EvaluationMethod
- roleArn :: Maybe Text
- newDetectorModelConfiguration :: DetectorModelConfiguration
- detectorModelConfiguration_creationTime :: Lens' DetectorModelConfiguration (Maybe UTCTime)
- detectorModelConfiguration_status :: Lens' DetectorModelConfiguration (Maybe DetectorModelVersionStatus)
- detectorModelConfiguration_detectorModelName :: Lens' DetectorModelConfiguration (Maybe Text)
- detectorModelConfiguration_detectorModelArn :: Lens' DetectorModelConfiguration (Maybe Text)
- detectorModelConfiguration_detectorModelDescription :: Lens' DetectorModelConfiguration (Maybe Text)
- detectorModelConfiguration_key :: Lens' DetectorModelConfiguration (Maybe Text)
- detectorModelConfiguration_detectorModelVersion :: Lens' DetectorModelConfiguration (Maybe Text)
- detectorModelConfiguration_lastUpdateTime :: Lens' DetectorModelConfiguration (Maybe UTCTime)
- detectorModelConfiguration_evaluationMethod :: Lens' DetectorModelConfiguration (Maybe EvaluationMethod)
- detectorModelConfiguration_roleArn :: Lens' DetectorModelConfiguration (Maybe Text)
- data DetectorModelDefinition = DetectorModelDefinition' {}
- newDetectorModelDefinition :: NonEmpty State -> Text -> DetectorModelDefinition
- detectorModelDefinition_states :: Lens' DetectorModelDefinition (NonEmpty State)
- detectorModelDefinition_initialStateName :: Lens' DetectorModelDefinition Text
- data DetectorModelSummary = DetectorModelSummary' {}
- newDetectorModelSummary :: DetectorModelSummary
- detectorModelSummary_creationTime :: Lens' DetectorModelSummary (Maybe UTCTime)
- detectorModelSummary_detectorModelName :: Lens' DetectorModelSummary (Maybe Text)
- detectorModelSummary_detectorModelDescription :: Lens' DetectorModelSummary (Maybe Text)
- data DetectorModelVersionSummary = DetectorModelVersionSummary' {}
- newDetectorModelVersionSummary :: DetectorModelVersionSummary
- detectorModelVersionSummary_creationTime :: Lens' DetectorModelVersionSummary (Maybe UTCTime)
- detectorModelVersionSummary_status :: Lens' DetectorModelVersionSummary (Maybe DetectorModelVersionStatus)
- detectorModelVersionSummary_detectorModelName :: Lens' DetectorModelVersionSummary (Maybe Text)
- detectorModelVersionSummary_detectorModelArn :: Lens' DetectorModelVersionSummary (Maybe Text)
- detectorModelVersionSummary_detectorModelVersion :: Lens' DetectorModelVersionSummary (Maybe Text)
- detectorModelVersionSummary_lastUpdateTime :: Lens' DetectorModelVersionSummary (Maybe UTCTime)
- detectorModelVersionSummary_evaluationMethod :: Lens' DetectorModelVersionSummary (Maybe EvaluationMethod)
- detectorModelVersionSummary_roleArn :: Lens' DetectorModelVersionSummary (Maybe Text)
- data DynamoDBAction = DynamoDBAction' {
- hashKeyType :: Maybe Text
- operation :: Maybe Text
- rangeKeyType :: Maybe Text
- payload :: Maybe Payload
- payloadField :: Maybe Text
- rangeKeyField :: Maybe Text
- rangeKeyValue :: Maybe Text
- hashKeyField :: Text
- hashKeyValue :: Text
- tableName :: Text
- newDynamoDBAction :: Text -> Text -> Text -> DynamoDBAction
- dynamoDBAction_hashKeyType :: Lens' DynamoDBAction (Maybe Text)
- dynamoDBAction_operation :: Lens' DynamoDBAction (Maybe Text)
- dynamoDBAction_rangeKeyType :: Lens' DynamoDBAction (Maybe Text)
- dynamoDBAction_payload :: Lens' DynamoDBAction (Maybe Payload)
- dynamoDBAction_payloadField :: Lens' DynamoDBAction (Maybe Text)
- dynamoDBAction_rangeKeyField :: Lens' DynamoDBAction (Maybe Text)
- dynamoDBAction_rangeKeyValue :: Lens' DynamoDBAction (Maybe Text)
- dynamoDBAction_hashKeyField :: Lens' DynamoDBAction Text
- dynamoDBAction_hashKeyValue :: Lens' DynamoDBAction Text
- dynamoDBAction_tableName :: Lens' DynamoDBAction Text
- data DynamoDBv2Action = DynamoDBv2Action' {}
- newDynamoDBv2Action :: Text -> DynamoDBv2Action
- dynamoDBv2Action_payload :: Lens' DynamoDBv2Action (Maybe Payload)
- dynamoDBv2Action_tableName :: Lens' DynamoDBv2Action Text
- data EmailConfiguration = EmailConfiguration' {}
- newEmailConfiguration :: Text -> EmailRecipients -> EmailConfiguration
- emailConfiguration_content :: Lens' EmailConfiguration (Maybe EmailContent)
- emailConfiguration_from :: Lens' EmailConfiguration Text
- emailConfiguration_recipients :: Lens' EmailConfiguration EmailRecipients
- data EmailContent = EmailContent' {}
- newEmailContent :: EmailContent
- emailContent_subject :: Lens' EmailContent (Maybe Text)
- emailContent_additionalMessage :: Lens' EmailContent (Maybe Text)
- data EmailRecipients = EmailRecipients' {
- to :: Maybe (NonEmpty RecipientDetail)
- newEmailRecipients :: EmailRecipients
- emailRecipients_to :: Lens' EmailRecipients (Maybe (NonEmpty RecipientDetail))
- data Event = Event' {}
- newEvent :: Text -> Event
- event_actions :: Lens' Event (Maybe [Action])
- event_condition :: Lens' Event (Maybe Text)
- event_eventName :: Lens' Event Text
- data FirehoseAction = FirehoseAction' {}
- newFirehoseAction :: Text -> FirehoseAction
- firehoseAction_separator :: Lens' FirehoseAction (Maybe Text)
- firehoseAction_payload :: Lens' FirehoseAction (Maybe Payload)
- firehoseAction_deliveryStreamName :: Lens' FirehoseAction Text
- data InitializationConfiguration = InitializationConfiguration' {}
- newInitializationConfiguration :: Bool -> InitializationConfiguration
- initializationConfiguration_disabledOnInitialization :: Lens' InitializationConfiguration Bool
- data Input = Input' {}
- newInput :: Input
- input_inputDefinition :: Lens' Input (Maybe InputDefinition)
- input_inputConfiguration :: Lens' Input (Maybe InputConfiguration)
- data InputConfiguration = InputConfiguration' {}
- newInputConfiguration :: Text -> Text -> UTCTime -> UTCTime -> InputStatus -> InputConfiguration
- inputConfiguration_inputDescription :: Lens' InputConfiguration (Maybe Text)
- inputConfiguration_inputName :: Lens' InputConfiguration Text
- inputConfiguration_inputArn :: Lens' InputConfiguration Text
- inputConfiguration_creationTime :: Lens' InputConfiguration UTCTime
- inputConfiguration_lastUpdateTime :: Lens' InputConfiguration UTCTime
- inputConfiguration_status :: Lens' InputConfiguration InputStatus
- data InputDefinition = InputDefinition' {}
- newInputDefinition :: NonEmpty Attribute -> InputDefinition
- inputDefinition_attributes :: Lens' InputDefinition (NonEmpty Attribute)
- data InputIdentifier = InputIdentifier' {}
- newInputIdentifier :: InputIdentifier
- inputIdentifier_iotSiteWiseInputIdentifier :: Lens' InputIdentifier (Maybe IotSiteWiseInputIdentifier)
- inputIdentifier_iotEventsInputIdentifier :: Lens' InputIdentifier (Maybe IotEventsInputIdentifier)
- data InputSummary = InputSummary' {}
- newInputSummary :: InputSummary
- inputSummary_creationTime :: Lens' InputSummary (Maybe UTCTime)
- inputSummary_status :: Lens' InputSummary (Maybe InputStatus)
- inputSummary_inputName :: Lens' InputSummary (Maybe Text)
- inputSummary_inputDescription :: Lens' InputSummary (Maybe Text)
- inputSummary_inputArn :: Lens' InputSummary (Maybe Text)
- inputSummary_lastUpdateTime :: Lens' InputSummary (Maybe UTCTime)
- data IotEventsAction = IotEventsAction' {}
- newIotEventsAction :: Text -> IotEventsAction
- iotEventsAction_payload :: Lens' IotEventsAction (Maybe Payload)
- iotEventsAction_inputName :: Lens' IotEventsAction Text
- data IotEventsInputIdentifier = IotEventsInputIdentifier' {}
- newIotEventsInputIdentifier :: Text -> IotEventsInputIdentifier
- iotEventsInputIdentifier_inputName :: Lens' IotEventsInputIdentifier Text
- data IotSiteWiseAction = IotSiteWiseAction' {}
- newIotSiteWiseAction :: IotSiteWiseAction
- iotSiteWiseAction_entryId :: Lens' IotSiteWiseAction (Maybe Text)
- iotSiteWiseAction_propertyAlias :: Lens' IotSiteWiseAction (Maybe Text)
- iotSiteWiseAction_propertyValue :: Lens' IotSiteWiseAction (Maybe AssetPropertyValue)
- iotSiteWiseAction_propertyId :: Lens' IotSiteWiseAction (Maybe Text)
- iotSiteWiseAction_assetId :: Lens' IotSiteWiseAction (Maybe Text)
- data IotSiteWiseAssetModelPropertyIdentifier = IotSiteWiseAssetModelPropertyIdentifier' {
- assetModelId :: Text
- propertyId :: Text
- newIotSiteWiseAssetModelPropertyIdentifier :: Text -> Text -> IotSiteWiseAssetModelPropertyIdentifier
- iotSiteWiseAssetModelPropertyIdentifier_assetModelId :: Lens' IotSiteWiseAssetModelPropertyIdentifier Text
- iotSiteWiseAssetModelPropertyIdentifier_propertyId :: Lens' IotSiteWiseAssetModelPropertyIdentifier Text
- data IotSiteWiseInputIdentifier = IotSiteWiseInputIdentifier' {}
- newIotSiteWiseInputIdentifier :: IotSiteWiseInputIdentifier
- iotSiteWiseInputIdentifier_iotSiteWiseAssetModelPropertyIdentifier :: Lens' IotSiteWiseInputIdentifier (Maybe IotSiteWiseAssetModelPropertyIdentifier)
- data IotTopicPublishAction = IotTopicPublishAction' {}
- newIotTopicPublishAction :: Text -> IotTopicPublishAction
- iotTopicPublishAction_payload :: Lens' IotTopicPublishAction (Maybe Payload)
- iotTopicPublishAction_mqttTopic :: Lens' IotTopicPublishAction Text
- data LambdaAction = LambdaAction' {
- payload :: Maybe Payload
- functionArn :: Text
- newLambdaAction :: Text -> LambdaAction
- lambdaAction_payload :: Lens' LambdaAction (Maybe Payload)
- lambdaAction_functionArn :: Lens' LambdaAction Text
- data LoggingOptions = LoggingOptions' {}
- newLoggingOptions :: Text -> LoggingLevel -> Bool -> LoggingOptions
- loggingOptions_detectorDebugOptions :: Lens' LoggingOptions (Maybe (NonEmpty DetectorDebugOption))
- loggingOptions_roleArn :: Lens' LoggingOptions Text
- loggingOptions_level :: Lens' LoggingOptions LoggingLevel
- loggingOptions_enabled :: Lens' LoggingOptions Bool
- data NotificationAction = NotificationAction' {}
- newNotificationAction :: NotificationTargetActions -> NotificationAction
- notificationAction_emailConfigurations :: Lens' NotificationAction (Maybe (NonEmpty EmailConfiguration))
- notificationAction_smsConfigurations :: Lens' NotificationAction (Maybe (NonEmpty SMSConfiguration))
- notificationAction_action :: Lens' NotificationAction NotificationTargetActions
- data NotificationTargetActions = NotificationTargetActions' {}
- newNotificationTargetActions :: NotificationTargetActions
- notificationTargetActions_lambdaAction :: Lens' NotificationTargetActions (Maybe LambdaAction)
- data OnEnterLifecycle = OnEnterLifecycle' {}
- newOnEnterLifecycle :: OnEnterLifecycle
- onEnterLifecycle_events :: Lens' OnEnterLifecycle (Maybe [Event])
- data OnExitLifecycle = OnExitLifecycle' {}
- newOnExitLifecycle :: OnExitLifecycle
- onExitLifecycle_events :: Lens' OnExitLifecycle (Maybe [Event])
- data OnInputLifecycle = OnInputLifecycle' {
- events :: Maybe [Event]
- transitionEvents :: Maybe [TransitionEvent]
- newOnInputLifecycle :: OnInputLifecycle
- onInputLifecycle_events :: Lens' OnInputLifecycle (Maybe [Event])
- onInputLifecycle_transitionEvents :: Lens' OnInputLifecycle (Maybe [TransitionEvent])
- data Payload = Payload' {}
- newPayload :: Text -> PayloadType -> Payload
- payload_contentExpression :: Lens' Payload Text
- payload_type :: Lens' Payload PayloadType
- data RecipientDetail = RecipientDetail' {}
- newRecipientDetail :: RecipientDetail
- recipientDetail_ssoIdentity :: Lens' RecipientDetail (Maybe SSOIdentity)
- data ResetTimerAction = ResetTimerAction' {}
- newResetTimerAction :: Text -> ResetTimerAction
- resetTimerAction_timerName :: Lens' ResetTimerAction Text
- data RoutedResource = RoutedResource' {}
- newRoutedResource :: RoutedResource
- routedResource_arn :: Lens' RoutedResource (Maybe Text)
- routedResource_name :: Lens' RoutedResource (Maybe Text)
- data SMSConfiguration = SMSConfiguration' {}
- newSMSConfiguration :: NonEmpty RecipientDetail -> SMSConfiguration
- sMSConfiguration_additionalMessage :: Lens' SMSConfiguration (Maybe Text)
- sMSConfiguration_senderId :: Lens' SMSConfiguration (Maybe Text)
- sMSConfiguration_recipients :: Lens' SMSConfiguration (NonEmpty RecipientDetail)
- data SNSTopicPublishAction = SNSTopicPublishAction' {}
- newSNSTopicPublishAction :: Text -> SNSTopicPublishAction
- sNSTopicPublishAction_payload :: Lens' SNSTopicPublishAction (Maybe Payload)
- sNSTopicPublishAction_targetArn :: Lens' SNSTopicPublishAction Text
- data SSOIdentity = SSOIdentity' {
- userId :: Maybe Text
- identityStoreId :: Text
- newSSOIdentity :: Text -> SSOIdentity
- sSOIdentity_userId :: Lens' SSOIdentity (Maybe Text)
- sSOIdentity_identityStoreId :: Lens' SSOIdentity Text
- data SetTimerAction = SetTimerAction' {}
- newSetTimerAction :: Text -> SetTimerAction
- setTimerAction_durationExpression :: Lens' SetTimerAction (Maybe Text)
- setTimerAction_seconds :: Lens' SetTimerAction (Maybe Natural)
- setTimerAction_timerName :: Lens' SetTimerAction Text
- data SetVariableAction = SetVariableAction' {
- variableName :: Text
- value :: Text
- newSetVariableAction :: Text -> Text -> SetVariableAction
- setVariableAction_variableName :: Lens' SetVariableAction Text
- setVariableAction_value :: Lens' SetVariableAction Text
- data SimpleRule = SimpleRule' {}
- newSimpleRule :: Text -> ComparisonOperator -> Text -> SimpleRule
- simpleRule_inputProperty :: Lens' SimpleRule Text
- simpleRule_comparisonOperator :: Lens' SimpleRule ComparisonOperator
- simpleRule_threshold :: Lens' SimpleRule Text
- data SqsAction = SqsAction' {}
- newSqsAction :: Text -> SqsAction
- sqsAction_payload :: Lens' SqsAction (Maybe Payload)
- sqsAction_useBase64 :: Lens' SqsAction (Maybe Bool)
- sqsAction_queueUrl :: Lens' SqsAction Text
- data State = State' {}
- newState :: Text -> State
- state_onEnter :: Lens' State (Maybe OnEnterLifecycle)
- state_onInput :: Lens' State (Maybe OnInputLifecycle)
- state_onExit :: Lens' State (Maybe OnExitLifecycle)
- state_stateName :: Lens' State Text
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- data TransitionEvent = TransitionEvent' {}
- newTransitionEvent :: Text -> Text -> Text -> TransitionEvent
- transitionEvent_actions :: Lens' TransitionEvent (Maybe [Action])
- transitionEvent_eventName :: Lens' TransitionEvent Text
- transitionEvent_condition :: Lens' TransitionEvent Text
- transitionEvent_nextState :: Lens' TransitionEvent Text
Service Configuration
defaultService :: Service Source #
API version 2018-07-27 of the Amazon IoT Events SDK configuration.
Errors
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was invalid.
_UnsupportedOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested operation is not supported.
_ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource already exists.
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request could not be completed due to throttling.
_InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An internal failure occurred.
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The service is currently unavailable.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource was not found.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A limit was exceeded.
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource is in use.
AlarmModelVersionStatus
newtype AlarmModelVersionStatus Source #
Constructors
| AlarmModelVersionStatus' | |
Fields | |
Bundled Patterns
Instances
AnalysisResultLevel
newtype AnalysisResultLevel Source #
Constructors
| AnalysisResultLevel' | |
Fields | |
Bundled Patterns
| pattern AnalysisResultLevel_ERROR :: AnalysisResultLevel | |
| pattern AnalysisResultLevel_INFO :: AnalysisResultLevel | |
| pattern AnalysisResultLevel_WARNING :: AnalysisResultLevel |
Instances
AnalysisStatus
newtype AnalysisStatus Source #
Constructors
| AnalysisStatus' | |
Fields | |
Bundled Patterns
| pattern AnalysisStatus_COMPLETE :: AnalysisStatus | |
| pattern AnalysisStatus_FAILED :: AnalysisStatus | |
| pattern AnalysisStatus_RUNNING :: AnalysisStatus |
Instances
ComparisonOperator
newtype ComparisonOperator Source #
Constructors
| ComparisonOperator' | |
Fields | |
Bundled Patterns
| pattern ComparisonOperator_EQUAL :: ComparisonOperator | |
| pattern ComparisonOperator_GREATER :: ComparisonOperator | |
| pattern ComparisonOperator_GREATER_OR_EQUAL :: ComparisonOperator | |
| pattern ComparisonOperator_LESS :: ComparisonOperator | |
| pattern ComparisonOperator_LESS_OR_EQUAL :: ComparisonOperator | |
| pattern ComparisonOperator_NOT_EQUAL :: ComparisonOperator |
Instances
DetectorModelVersionStatus
newtype DetectorModelVersionStatus Source #
Constructors
| DetectorModelVersionStatus' | |
Fields | |
Bundled Patterns
Instances
EvaluationMethod
newtype EvaluationMethod Source #
Constructors
| EvaluationMethod' | |
Fields | |
Bundled Patterns
| pattern EvaluationMethod_BATCH :: EvaluationMethod | |
| pattern EvaluationMethod_SERIAL :: EvaluationMethod |
Instances
InputStatus
newtype InputStatus Source #
Constructors
| InputStatus' | |
Fields | |
Bundled Patterns
| pattern InputStatus_ACTIVE :: InputStatus | |
| pattern InputStatus_CREATING :: InputStatus | |
| pattern InputStatus_DELETING :: InputStatus | |
| pattern InputStatus_UPDATING :: InputStatus |
Instances
LoggingLevel
newtype LoggingLevel Source #
Constructors
| LoggingLevel' | |
Fields | |
Bundled Patterns
| pattern LoggingLevel_DEBUG :: LoggingLevel | |
| pattern LoggingLevel_ERROR :: LoggingLevel | |
| pattern LoggingLevel_INFO :: LoggingLevel |
Instances
PayloadType
newtype PayloadType Source #
Constructors
| PayloadType' | |
Fields | |
Bundled Patterns
| pattern PayloadType_JSON :: PayloadType | |
| pattern PayloadType_STRING :: PayloadType |
Instances
AcknowledgeFlow
data AcknowledgeFlow Source #
Specifies whether to get notified for alarm state changes.
See: newAcknowledgeFlow smart constructor.
Constructors
| AcknowledgeFlow' | |
Fields
| |
Instances
Arguments
| :: Bool | |
| -> AcknowledgeFlow |
Create a value of AcknowledgeFlow 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:enabled:AcknowledgeFlow', acknowledgeFlow_enabled - The value must be TRUE or FALSE. If TRUE, you receive a
notification when the alarm state changes. You must choose to
acknowledge the notification before the alarm state can return to
NORMAL. If FALSE, you won't receive notifications. The alarm
automatically changes to the NORMAL state when the input property
value returns to the specified range.
acknowledgeFlow_enabled :: Lens' AcknowledgeFlow Bool Source #
The value must be TRUE or FALSE. If TRUE, you receive a
notification when the alarm state changes. You must choose to
acknowledge the notification before the alarm state can return to
NORMAL. If FALSE, you won't receive notifications. The alarm
automatically changes to the NORMAL state when the input property
value returns to the specified range.
Action
An action to be performed when the condition is TRUE.
See: newAction smart constructor.
Constructors
| Action' | |
Fields
| |
Instances
Create a value of Action 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:iotTopicPublish:Action', action_iotTopicPublish - Publishes an MQTT message with the given topic to the AWS IoT message
broker.
$sel:dynamoDBv2:Action', action_dynamoDBv2 - Writes to the DynamoDB table that you created. The default action
payload contains all attribute-value pairs that have the information
about the detector model instance and the event that triggered the
action. You can customize the
payload.
A separate column of the DynamoDB table receives one attribute-value
pair in the payload that you specify. For more information, see
Actions
in AWS IoT Events Developer Guide.
$sel:resetTimer:Action', action_resetTimer - Information needed to reset the timer.
$sel:setTimer:Action', action_setTimer - Information needed to set the timer.
$sel:sns:Action', action_sns - Sends an Amazon SNS message.
$sel:clearTimer:Action', action_clearTimer - Information needed to clear the timer.
$sel:dynamoDB:Action', action_dynamoDB - Writes to the DynamoDB table that you created. The default action
payload contains all attribute-value pairs that have the information
about the detector model instance and the event that triggered the
action. You can customize the
payload.
One column of the DynamoDB table receives all attribute-value pairs in
the payload that you specify. For more information, see
Actions
in AWS IoT Events Developer Guide.
$sel:firehose:Action', action_firehose - Sends information about the detector model instance and the event that
triggered the action to an Amazon Kinesis Data Firehose delivery stream.
$sel:iotSiteWise:Action', action_iotSiteWise - Sends information about the detector model instance and the event that
triggered the action to an asset property in AWS IoT SiteWise .
$sel:setVariable:Action', action_setVariable - Sets a variable to a specified value.
$sel:lambda:Action', action_lambda - Calls a Lambda function, passing in information about the detector model
instance and the event that triggered the action.
$sel:iotEvents:Action', action_iotEvents - Sends AWS IoT Events input, which passes information about the detector
model instance and the event that triggered the action.
$sel:sqs:Action', action_sqs - Sends information about the detector model instance and the event that
triggered the action to an Amazon SQS queue.
action_iotTopicPublish :: Lens' Action (Maybe IotTopicPublishAction) Source #
Publishes an MQTT message with the given topic to the AWS IoT message broker.
action_dynamoDBv2 :: Lens' Action (Maybe DynamoDBv2Action) Source #
Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the payload. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide.
action_resetTimer :: Lens' Action (Maybe ResetTimerAction) Source #
Information needed to reset the timer.
action_setTimer :: Lens' Action (Maybe SetTimerAction) Source #
Information needed to set the timer.
action_sns :: Lens' Action (Maybe SNSTopicPublishAction) Source #
Sends an Amazon SNS message.
action_clearTimer :: Lens' Action (Maybe ClearTimerAction) Source #
Information needed to clear the timer.
action_dynamoDB :: Lens' Action (Maybe DynamoDBAction) Source #
Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide.
action_firehose :: Lens' Action (Maybe FirehoseAction) Source #
Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
action_iotSiteWise :: Lens' Action (Maybe IotSiteWiseAction) Source #
Sends information about the detector model instance and the event that triggered the action to an asset property in AWS IoT SiteWise .
action_setVariable :: Lens' Action (Maybe SetVariableAction) Source #
Sets a variable to a specified value.
action_lambda :: Lens' Action (Maybe LambdaAction) Source #
Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
action_iotEvents :: Lens' Action (Maybe IotEventsAction) Source #
Sends AWS IoT Events input, which passes information about the detector model instance and the event that triggered the action.
action_sqs :: Lens' Action (Maybe SqsAction) Source #
Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
AlarmAction
data AlarmAction Source #
Specifies one of the following actions to receive notifications when the alarm state changes.
See: newAlarmAction smart constructor.
Constructors
Instances
newAlarmAction :: AlarmAction Source #
Create a value of AlarmAction 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:iotTopicPublish:AlarmAction', alarmAction_iotTopicPublish - Undocumented member.
$sel:dynamoDBv2:AlarmAction', alarmAction_dynamoDBv2 - Undocumented member.
$sel:sns:AlarmAction', alarmAction_sns - Undocumented member.
$sel:dynamoDB:AlarmAction', alarmAction_dynamoDB - Undocumented member.
$sel:firehose:AlarmAction', alarmAction_firehose - Undocumented member.
$sel:iotSiteWise:AlarmAction', alarmAction_iotSiteWise - Undocumented member.
$sel:lambda:AlarmAction', alarmAction_lambda - Undocumented member.
$sel:iotEvents:AlarmAction', alarmAction_iotEvents - Undocumented member.
$sel:sqs:AlarmAction', alarmAction_sqs - Undocumented member.
alarmAction_iotTopicPublish :: Lens' AlarmAction (Maybe IotTopicPublishAction) Source #
Undocumented member.
alarmAction_dynamoDBv2 :: Lens' AlarmAction (Maybe DynamoDBv2Action) Source #
Undocumented member.
alarmAction_sns :: Lens' AlarmAction (Maybe SNSTopicPublishAction) Source #
Undocumented member.
alarmAction_dynamoDB :: Lens' AlarmAction (Maybe DynamoDBAction) Source #
Undocumented member.
alarmAction_firehose :: Lens' AlarmAction (Maybe FirehoseAction) Source #
Undocumented member.
alarmAction_iotSiteWise :: Lens' AlarmAction (Maybe IotSiteWiseAction) Source #
Undocumented member.
alarmAction_lambda :: Lens' AlarmAction (Maybe LambdaAction) Source #
Undocumented member.
alarmAction_iotEvents :: Lens' AlarmAction (Maybe IotEventsAction) Source #
Undocumented member.
alarmAction_sqs :: Lens' AlarmAction (Maybe SqsAction) Source #
Undocumented member.
AlarmCapabilities
data AlarmCapabilities Source #
Contains the configuration information of alarm state changes.
See: newAlarmCapabilities smart constructor.
Constructors
| AlarmCapabilities' | |
Fields
| |
Instances
newAlarmCapabilities :: AlarmCapabilities Source #
Create a value of AlarmCapabilities 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:acknowledgeFlow:AlarmCapabilities', alarmCapabilities_acknowledgeFlow - Specifies whether to get notified for alarm state changes.
$sel:initializationConfiguration:AlarmCapabilities', alarmCapabilities_initializationConfiguration - Specifies the default alarm state. The configuration applies to all
alarms that were created based on this alarm model.
alarmCapabilities_acknowledgeFlow :: Lens' AlarmCapabilities (Maybe AcknowledgeFlow) Source #
Specifies whether to get notified for alarm state changes.
alarmCapabilities_initializationConfiguration :: Lens' AlarmCapabilities (Maybe InitializationConfiguration) Source #
Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.
AlarmEventActions
data AlarmEventActions Source #
Contains information about one or more alarm actions.
See: newAlarmEventActions smart constructor.
Constructors
| AlarmEventActions' | |
Fields
| |
Instances
newAlarmEventActions :: AlarmEventActions Source #
Create a value of AlarmEventActions 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:alarmActions:AlarmEventActions', alarmEventActions_alarmActions - Specifies one or more supported actions to receive notifications when
the alarm state changes.
alarmEventActions_alarmActions :: Lens' AlarmEventActions (Maybe [AlarmAction]) Source #
Specifies one or more supported actions to receive notifications when the alarm state changes.
AlarmModelSummary
data AlarmModelSummary Source #
Contains a summary of an alarm model.
See: newAlarmModelSummary smart constructor.
Constructors
| AlarmModelSummary' | |
Fields
| |
Instances
newAlarmModelSummary :: AlarmModelSummary Source #
Create a value of AlarmModelSummary 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:AlarmModelSummary', alarmModelSummary_creationTime - The time the alarm model was created, in the Unix epoch format.
$sel:alarmModelName:AlarmModelSummary', alarmModelSummary_alarmModelName - The name of the alarm model.
$sel:alarmModelDescription:AlarmModelSummary', alarmModelSummary_alarmModelDescription - The description of the alarm model.
alarmModelSummary_creationTime :: Lens' AlarmModelSummary (Maybe UTCTime) Source #
The time the alarm model was created, in the Unix epoch format.
alarmModelSummary_alarmModelName :: Lens' AlarmModelSummary (Maybe Text) Source #
The name of the alarm model.
alarmModelSummary_alarmModelDescription :: Lens' AlarmModelSummary (Maybe Text) Source #
The description of the alarm model.
AlarmModelVersionSummary
data AlarmModelVersionSummary Source #
Contains a summary of an alarm model version.
See: newAlarmModelVersionSummary smart constructor.
Constructors
| AlarmModelVersionSummary' | |
Fields
| |
Instances
newAlarmModelVersionSummary :: AlarmModelVersionSummary Source #
Create a value of AlarmModelVersionSummary 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:AlarmModelVersionSummary', alarmModelVersionSummary_creationTime - The time the alarm model was created, in the Unix epoch format.
$sel:status:AlarmModelVersionSummary', alarmModelVersionSummary_status - The status of the alarm model. The status can be one of the following
values:
ACTIVE- The alarm model is active and it's ready to evaluate data.ACTIVATING- AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes.INACTIVE- The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model.FAILED- You couldn't create or update the alarm model. Check your alarm model information and try again.
$sel:alarmModelName:AlarmModelVersionSummary', alarmModelVersionSummary_alarmModelName - The name of the alarm model.
$sel:statusMessage:AlarmModelVersionSummary', alarmModelVersionSummary_statusMessage - Contains information about the status of the alarm model version.
$sel:lastUpdateTime:AlarmModelVersionSummary', alarmModelVersionSummary_lastUpdateTime - The time the alarm model was last updated, in the Unix epoch format.
$sel:alarmModelVersion:AlarmModelVersionSummary', alarmModelVersionSummary_alarmModelVersion - The version of the alarm model.
$sel:alarmModelArn:AlarmModelVersionSummary', alarmModelVersionSummary_alarmModelArn - The ARN of the alarm model. For more information, see
Amazon Resource Names (ARNs)
in the AWS General Reference.
$sel:roleArn:AlarmModelVersionSummary', alarmModelVersionSummary_roleArn - The ARN of the IAM role that allows the alarm to perform actions and
access AWS resources. For more information, see
Amazon Resource Names (ARNs)
in the AWS General Reference.
alarmModelVersionSummary_creationTime :: Lens' AlarmModelVersionSummary (Maybe UTCTime) Source #
The time the alarm model was created, in the Unix epoch format.
alarmModelVersionSummary_status :: Lens' AlarmModelVersionSummary (Maybe AlarmModelVersionStatus) Source #
The status of the alarm model. The status can be one of the following values:
ACTIVE- The alarm model is active and it's ready to evaluate data.ACTIVATING- AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes.INACTIVE- The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model.FAILED- You couldn't create or update the alarm model. Check your alarm model information and try again.
alarmModelVersionSummary_alarmModelName :: Lens' AlarmModelVersionSummary (Maybe Text) Source #
The name of the alarm model.
alarmModelVersionSummary_statusMessage :: Lens' AlarmModelVersionSummary (Maybe Text) Source #
Contains information about the status of the alarm model version.
alarmModelVersionSummary_lastUpdateTime :: Lens' AlarmModelVersionSummary (Maybe UTCTime) Source #
The time the alarm model was last updated, in the Unix epoch format.
alarmModelVersionSummary_alarmModelVersion :: Lens' AlarmModelVersionSummary (Maybe Text) Source #
The version of the alarm model.
alarmModelVersionSummary_alarmModelArn :: Lens' AlarmModelVersionSummary (Maybe Text) Source #
The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
alarmModelVersionSummary_roleArn :: Lens' AlarmModelVersionSummary (Maybe Text) Source #
The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
AlarmNotification
data AlarmNotification Source #
Contains information about one or more notification actions.
See: newAlarmNotification smart constructor.
Constructors
| AlarmNotification' | |
Fields
| |
Instances
newAlarmNotification :: AlarmNotification Source #
Create a value of AlarmNotification 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:notificationActions:AlarmNotification', alarmNotification_notificationActions - Contains the notification settings of an alarm model. The settings apply
to all alarms that were created based on this alarm model.
alarmNotification_notificationActions :: Lens' AlarmNotification (Maybe (NonEmpty NotificationAction)) Source #
Contains the notification settings of an alarm model. The settings apply to all alarms that were created based on this alarm model.
AlarmRule
Defines when your alarm is invoked.
See: newAlarmRule smart constructor.
Constructors
| AlarmRule' | |
Fields
| |
Instances
| Eq AlarmRule Source # | |
| Read AlarmRule Source # | |
| Show AlarmRule Source # | |
| Generic AlarmRule Source # | |
| NFData AlarmRule Source # | |
Defined in Amazonka.IoTEvents.Types.AlarmRule | |
| Hashable AlarmRule Source # | |
Defined in Amazonka.IoTEvents.Types.AlarmRule | |
| ToJSON AlarmRule Source # | |
Defined in Amazonka.IoTEvents.Types.AlarmRule | |
| FromJSON AlarmRule Source # | |
| type Rep AlarmRule Source # | |
Defined in Amazonka.IoTEvents.Types.AlarmRule type Rep AlarmRule = D1 ('MetaData "AlarmRule" "Amazonka.IoTEvents.Types.AlarmRule" "libZSservicesZSamazonka-ioteventsZSamazonka-iotevents" 'False) (C1 ('MetaCons "AlarmRule'" 'PrefixI 'True) (S1 ('MetaSel ('Just "simpleRule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SimpleRule)))) | |
newAlarmRule :: AlarmRule Source #
Create a value of AlarmRule 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:simpleRule:AlarmRule', alarmRule_simpleRule - A rule that compares an input property value to a threshold value with a
comparison operator.
alarmRule_simpleRule :: Lens' AlarmRule (Maybe SimpleRule) Source #
A rule that compares an input property value to a threshold value with a comparison operator.
AnalysisResult
data AnalysisResult Source #
Contains the result of the analysis.
See: newAnalysisResult smart constructor.
Constructors
| AnalysisResult' | |
Fields
| |
Instances
newAnalysisResult :: AnalysisResult Source #
Create a value of AnalysisResult 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:type':AnalysisResult', analysisResult_type - The type of the analysis result. Analyses fall into the following types
based on the validators used to generate the analysis result:
supported-actions- You must specify AWS IoT Events supported actions that work with other AWS services in a supported AWS Region.service-limits- Resources or API operations can't exceed service quotas (also known as limits). Update your detector model or request a quota increase.structure- The detector model must follow a structure that AWS IoT Events supports.expression-syntax- Your expression must follow the required syntax.data-type- Data types referenced in the detector model must be compatible.referenced-data- You must define the data referenced in your detector model before you can use the data.referenced-resource- Resources that the detector model uses must be available.
For more information, see Running detector model analyses in the AWS IoT Events Developer Guide.
$sel:message:AnalysisResult', analysisResult_message - Contains additional information about the analysis result.
$sel:level:AnalysisResult', analysisResult_level - The severity level of the analysis result. Based on the severity level,
analysis results fall into three general categories:
INFO- An information result tells you about a significant field in your detector model. This type of result usually doesn't require immediate action.WARNING- A warning result draws special attention to fields that might cause issues for your detector model. We recommend that you review warnings and take necessary actions before you use your detector model in production environments. Otherwise, the detector model might not work as expected.ERROR- An error result notifies you about a problem found in your detector model. You must fix all errors before you can publish your detector model.
$sel:locations:AnalysisResult', analysisResult_locations - Contains one or more locations that you can use to locate the fields in
your detector model that the analysis result references.
analysisResult_type :: Lens' AnalysisResult (Maybe Text) Source #
The type of the analysis result. Analyses fall into the following types based on the validators used to generate the analysis result:
supported-actions- You must specify AWS IoT Events supported actions that work with other AWS services in a supported AWS Region.service-limits- Resources or API operations can't exceed service quotas (also known as limits). Update your detector model or request a quota increase.structure- The detector model must follow a structure that AWS IoT Events supports.expression-syntax- Your expression must follow the required syntax.data-type- Data types referenced in the detector model must be compatible.referenced-data- You must define the data referenced in your detector model before you can use the data.referenced-resource- Resources that the detector model uses must be available.
For more information, see Running detector model analyses in the AWS IoT Events Developer Guide.
analysisResult_message :: Lens' AnalysisResult (Maybe Text) Source #
Contains additional information about the analysis result.
analysisResult_level :: Lens' AnalysisResult (Maybe AnalysisResultLevel) Source #
The severity level of the analysis result. Based on the severity level, analysis results fall into three general categories:
INFO- An information result tells you about a significant field in your detector model. This type of result usually doesn't require immediate action.WARNING- A warning result draws special attention to fields that might cause issues for your detector model. We recommend that you review warnings and take necessary actions before you use your detector model in production environments. Otherwise, the detector model might not work as expected.ERROR- An error result notifies you about a problem found in your detector model. You must fix all errors before you can publish your detector model.
analysisResult_locations :: Lens' AnalysisResult (Maybe [AnalysisResultLocation]) Source #
Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.
AnalysisResultLocation
data AnalysisResultLocation Source #
Contains information that you can use to locate the field in your detector model that the analysis result references.
See: newAnalysisResultLocation smart constructor.
Constructors
| AnalysisResultLocation' | |
Instances
newAnalysisResultLocation :: AnalysisResultLocation Source #
Create a value of AnalysisResultLocation 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:path:AnalysisResultLocation', analysisResultLocation_path - A JsonPath expression that
identifies the error field in your detector model.
analysisResultLocation_path :: Lens' AnalysisResultLocation (Maybe Text) Source #
A JsonPath expression that identifies the error field in your detector model.
AssetPropertyTimestamp
data AssetPropertyTimestamp Source #
A structure that contains timestamp information. For more information, see TimeInNanos in the AWS IoT SiteWise API Reference.
You must use expressions for all parameters in AssetPropertyTimestamp.
The expressions accept literals, operators, functions, references, and
substitution templates.
Examples
- For literal values, the expressions must contain single quotes. For
example, the value for the
timeInSecondsparameter can be'1586400675'. - For references, you must specify either variables or input values.
For example, the value for the
offsetInNanosparameter can be$variable.time. For a substitution template, you must use
${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.In the following example, the value for the
timeInSecondsparameter uses a substitution template.'${$input.TemperatureInput.sensorData.timestamp / 1000}'
For more information, see Expressions in the AWS IoT Events Developer Guide.
See: newAssetPropertyTimestamp smart constructor.
Constructors
| AssetPropertyTimestamp' | |
Fields
| |
Instances
newAssetPropertyTimestamp Source #
Create a value of AssetPropertyTimestamp 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:offsetInNanos:AssetPropertyTimestamp', assetPropertyTimestamp_offsetInNanos - The nanosecond offset converted from timeInSeconds. The valid range is
between 0-999999999.
$sel:timeInSeconds:AssetPropertyTimestamp', assetPropertyTimestamp_timeInSeconds - The timestamp, in seconds, in the Unix epoch format. The valid range is
between 1-31556889864403199.
assetPropertyTimestamp_offsetInNanos :: Lens' AssetPropertyTimestamp (Maybe Text) Source #
The nanosecond offset converted from timeInSeconds. The valid range is
between 0-999999999.
assetPropertyTimestamp_timeInSeconds :: Lens' AssetPropertyTimestamp Text Source #
The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199.
AssetPropertyValue
data AssetPropertyValue Source #
A structure that contains value information. For more information, see AssetPropertyValue in the AWS IoT SiteWise API Reference.
You must use expressions for all parameters in AssetPropertyValue. The
expressions accept literals, operators, functions, references, and
substitution templates.
Examples
- For literal values, the expressions must contain single quotes. For
example, the value for the
qualityparameter can be'GOOD'. - For references, you must specify either variables or input values.
For example, the value for the
qualityparameter can be$input.TemperatureInput.sensorData.quality.
For more information, see Expressions in the AWS IoT Events Developer Guide.
See: newAssetPropertyValue smart constructor.
Constructors
| AssetPropertyValue' | |
Fields
| |
Instances
newAssetPropertyValue :: AssetPropertyValue Source #
Create a value of AssetPropertyValue 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:value:AssetPropertyValue', assetPropertyValue_value - The value to send to an asset property.
$sel:quality:AssetPropertyValue', assetPropertyValue_quality - The quality of the asset property value. The value must be 'GOOD',
'BAD', or 'UNCERTAIN'.
$sel:timestamp:AssetPropertyValue', assetPropertyValue_timestamp - The timestamp associated with the asset property value. The default is
the current event time.
assetPropertyValue_value :: Lens' AssetPropertyValue (Maybe AssetPropertyVariant) Source #
The value to send to an asset property.
assetPropertyValue_quality :: Lens' AssetPropertyValue (Maybe Text) Source #
The quality of the asset property value. The value must be 'GOOD',
'BAD', or 'UNCERTAIN'.
assetPropertyValue_timestamp :: Lens' AssetPropertyValue (Maybe AssetPropertyTimestamp) Source #
The timestamp associated with the asset property value. The default is the current event time.
AssetPropertyVariant
data AssetPropertyVariant Source #
A structure that contains an asset property value. For more information, see Variant in the AWS IoT SiteWise API Reference.
You must use expressions for all parameters in AssetPropertyVariant.
The expressions accept literals, operators, functions, references, and
substitution templates.
Examples
- For literal values, the expressions must contain single quotes. For
example, the value for the
integerValueparameter can be'100'. - For references, you must specify either variables or parameters. For
example, the value for the
booleanValueparameter can be$variable.offline. For a substitution template, you must use
${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.In the following example, the value for the
doubleValueparameter uses a substitution template.'${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'
For more information, see Expressions in the AWS IoT Events Developer Guide.
You must specify one of the following value types, depending on the
dataType of the specified asset property. For more information, see
AssetProperty
in the AWS IoT SiteWise API Reference.
See: newAssetPropertyVariant smart constructor.
Constructors
| AssetPropertyVariant' | |
Fields
| |
Instances
newAssetPropertyVariant :: AssetPropertyVariant Source #
Create a value of AssetPropertyVariant 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:integerValue:AssetPropertyVariant', assetPropertyVariant_integerValue - The asset property value is an integer. You must use an expression, and
the evaluated result should be an integer.
$sel:doubleValue:AssetPropertyVariant', assetPropertyVariant_doubleValue - The asset property value is a double. You must use an expression, and
the evaluated result should be a double.
$sel:stringValue:AssetPropertyVariant', assetPropertyVariant_stringValue - The asset property value is a string. You must use an expression, and
the evaluated result should be a string.
$sel:booleanValue:AssetPropertyVariant', assetPropertyVariant_booleanValue - The asset property value is a Boolean value that must be 'TRUE' or
'FALSE'. You must use an expression, and the evaluated result should
be a Boolean value.
assetPropertyVariant_integerValue :: Lens' AssetPropertyVariant (Maybe Text) Source #
The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.
assetPropertyVariant_doubleValue :: Lens' AssetPropertyVariant (Maybe Text) Source #
The asset property value is a double. You must use an expression, and the evaluated result should be a double.
assetPropertyVariant_stringValue :: Lens' AssetPropertyVariant (Maybe Text) Source #
The asset property value is a string. You must use an expression, and the evaluated result should be a string.
assetPropertyVariant_booleanValue :: Lens' AssetPropertyVariant (Maybe Text) Source #
The asset property value is a Boolean value that must be 'TRUE' or
'FALSE'. You must use an expression, and the evaluated result should
be a Boolean value.
Attribute
The attributes from the JSON payload that are made available by the
input. Inputs are derived from messages sent to the AWS IoT Events
system using BatchPutMessage. Each such message contains a JSON
payload. Those attributes (and their paired values) specified here are
available for use in the condition expressions used by detectors.
See: newAttribute smart constructor.
Constructors
| Attribute' | |
Fields
| |
Instances
| Eq Attribute Source # | |
| Read Attribute Source # | |
| Show Attribute Source # | |
| Generic Attribute Source # | |
| NFData Attribute Source # | |
Defined in Amazonka.IoTEvents.Types.Attribute | |
| Hashable Attribute Source # | |
Defined in Amazonka.IoTEvents.Types.Attribute | |
| ToJSON Attribute Source # | |
Defined in Amazonka.IoTEvents.Types.Attribute | |
| FromJSON Attribute Source # | |
| type Rep Attribute Source # | |
Defined in Amazonka.IoTEvents.Types.Attribute | |
Create a value of Attribute 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:jsonPath:Attribute', attribute_jsonPath - An expression that specifies an attribute-value pair in a JSON
structure. Use this to specify an attribute from the JSON payload that
is made available by the input. Inputs are derived from messages sent to
AWS IoT Events (BatchPutMessage). Each such message contains a JSON
payload. The attribute (and its paired value) specified here are
available for use in the condition expressions used by detectors.
Syntax: <field-name>.<field-name>...
attribute_jsonPath :: Lens' Attribute Text Source #
An expression that specifies an attribute-value pair in a JSON
structure. Use this to specify an attribute from the JSON payload that
is made available by the input. Inputs are derived from messages sent to
AWS IoT Events (BatchPutMessage). Each such message contains a JSON
payload. The attribute (and its paired value) specified here are
available for use in the condition expressions used by detectors.
Syntax: <field-name>.<field-name>...
ClearTimerAction
data ClearTimerAction Source #
Information needed to clear the timer.
See: newClearTimerAction smart constructor.
Constructors
| ClearTimerAction' | |
Instances
Arguments
| :: Text | |
| -> ClearTimerAction |
Create a value of ClearTimerAction 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:timerName:ClearTimerAction', clearTimerAction_timerName - The name of the timer to clear.
clearTimerAction_timerName :: Lens' ClearTimerAction Text Source #
The name of the timer to clear.
DetectorDebugOption
data DetectorDebugOption Source #
The detector model and the specific detectors (instances) for which the logging level is given.
See: newDetectorDebugOption smart constructor.
Constructors
| DetectorDebugOption' | |
Fields
| |
Instances
newDetectorDebugOption Source #
Create a value of DetectorDebugOption 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:keyValue:DetectorDebugOption', detectorDebugOption_keyValue - The value of the input attribute key used to create the detector (the
instance of the detector model).
$sel:detectorModelName:DetectorDebugOption', detectorDebugOption_detectorModelName - The name of the detector model.
detectorDebugOption_keyValue :: Lens' DetectorDebugOption (Maybe Text) Source #
The value of the input attribute key used to create the detector (the instance of the detector model).
detectorDebugOption_detectorModelName :: Lens' DetectorDebugOption Text Source #
The name of the detector model.
DetectorModel
data DetectorModel Source #
Information about the detector model.
See: newDetectorModel smart constructor.
Constructors
| DetectorModel' | |
Fields
| |
Instances
newDetectorModel :: DetectorModel Source #
Create a value of DetectorModel 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:detectorModelConfiguration:DetectorModel', detectorModel_detectorModelConfiguration - Information about how the detector is configured.
$sel:detectorModelDefinition:DetectorModel', detectorModel_detectorModelDefinition - Information that defines how a detector operates.
detectorModel_detectorModelConfiguration :: Lens' DetectorModel (Maybe DetectorModelConfiguration) Source #
Information about how the detector is configured.
detectorModel_detectorModelDefinition :: Lens' DetectorModel (Maybe DetectorModelDefinition) Source #
Information that defines how a detector operates.
DetectorModelConfiguration
data DetectorModelConfiguration Source #
Information about how the detector model is configured.
See: newDetectorModelConfiguration smart constructor.
Constructors
| DetectorModelConfiguration' | |
Fields
| |
Instances
newDetectorModelConfiguration :: DetectorModelConfiguration Source #
Create a value of DetectorModelConfiguration 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:DetectorModelConfiguration', detectorModelConfiguration_creationTime - The time the detector model was created.
$sel:status:DetectorModelConfiguration', detectorModelConfiguration_status - The status of the detector model.
$sel:detectorModelName:DetectorModelConfiguration', detectorModelConfiguration_detectorModelName - The name of the detector model.
$sel:detectorModelArn:DetectorModelConfiguration', detectorModelConfiguration_detectorModelArn - The ARN of the detector model.
$sel:detectorModelDescription:DetectorModelConfiguration', detectorModelConfiguration_detectorModelDescription - A brief description of the detector model.
$sel:key:DetectorModelConfiguration', detectorModelConfiguration_key - The value used to identify a detector instance. When a device or system
sends input, a new detector instance with a unique key value is created.
AWS IoT Events can continue to route input to its corresponding detector
instance based on this identifying information.
This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.
$sel:detectorModelVersion:DetectorModelConfiguration', detectorModelConfiguration_detectorModelVersion - The version of the detector model.
$sel:lastUpdateTime:DetectorModelConfiguration', detectorModelConfiguration_lastUpdateTime - The time the detector model was last updated.
$sel:evaluationMethod:DetectorModelConfiguration', detectorModelConfiguration_evaluationMethod - Information about the order in which events are evaluated and how
actions are executed.
$sel:roleArn:DetectorModelConfiguration', detectorModelConfiguration_roleArn - The ARN of the role that grants permission to AWS IoT Events to perform
its operations.
detectorModelConfiguration_creationTime :: Lens' DetectorModelConfiguration (Maybe UTCTime) Source #
The time the detector model was created.
detectorModelConfiguration_status :: Lens' DetectorModelConfiguration (Maybe DetectorModelVersionStatus) Source #
The status of the detector model.
detectorModelConfiguration_detectorModelName :: Lens' DetectorModelConfiguration (Maybe Text) Source #
The name of the detector model.
detectorModelConfiguration_detectorModelArn :: Lens' DetectorModelConfiguration (Maybe Text) Source #
The ARN of the detector model.
detectorModelConfiguration_detectorModelDescription :: Lens' DetectorModelConfiguration (Maybe Text) Source #
A brief description of the detector model.
detectorModelConfiguration_key :: Lens' DetectorModelConfiguration (Maybe Text) Source #
The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information.
This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.
detectorModelConfiguration_detectorModelVersion :: Lens' DetectorModelConfiguration (Maybe Text) Source #
The version of the detector model.
detectorModelConfiguration_lastUpdateTime :: Lens' DetectorModelConfiguration (Maybe UTCTime) Source #
The time the detector model was last updated.
detectorModelConfiguration_evaluationMethod :: Lens' DetectorModelConfiguration (Maybe EvaluationMethod) Source #
Information about the order in which events are evaluated and how actions are executed.
detectorModelConfiguration_roleArn :: Lens' DetectorModelConfiguration (Maybe Text) Source #
The ARN of the role that grants permission to AWS IoT Events to perform its operations.
DetectorModelDefinition
data DetectorModelDefinition Source #
Information that defines how a detector operates.
See: newDetectorModelDefinition smart constructor.
Constructors
| DetectorModelDefinition' | |
Fields
| |
Instances
newDetectorModelDefinition Source #
Arguments
| :: NonEmpty State | |
| -> Text | |
| -> DetectorModelDefinition |
Create a value of DetectorModelDefinition 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:states:DetectorModelDefinition', detectorModelDefinition_states - Information about the states of the detector.
$sel:initialStateName:DetectorModelDefinition', detectorModelDefinition_initialStateName - The state that is entered at the creation of each detector (instance).
detectorModelDefinition_states :: Lens' DetectorModelDefinition (NonEmpty State) Source #
Information about the states of the detector.
detectorModelDefinition_initialStateName :: Lens' DetectorModelDefinition Text Source #
The state that is entered at the creation of each detector (instance).
DetectorModelSummary
data DetectorModelSummary Source #
Information about the detector model.
See: newDetectorModelSummary smart constructor.
Constructors
| DetectorModelSummary' | |
Fields
| |
Instances
newDetectorModelSummary :: DetectorModelSummary Source #
Create a value of DetectorModelSummary 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:DetectorModelSummary', detectorModelSummary_creationTime - The time the detector model was created.
$sel:detectorModelName:DetectorModelSummary', detectorModelSummary_detectorModelName - The name of the detector model.
$sel:detectorModelDescription:DetectorModelSummary', detectorModelSummary_detectorModelDescription - A brief description of the detector model.
detectorModelSummary_creationTime :: Lens' DetectorModelSummary (Maybe UTCTime) Source #
The time the detector model was created.
detectorModelSummary_detectorModelName :: Lens' DetectorModelSummary (Maybe Text) Source #
The name of the detector model.
detectorModelSummary_detectorModelDescription :: Lens' DetectorModelSummary (Maybe Text) Source #
A brief description of the detector model.
DetectorModelVersionSummary
data DetectorModelVersionSummary Source #
Information about the detector model version.
See: newDetectorModelVersionSummary smart constructor.
Constructors
| DetectorModelVersionSummary' | |
Fields
| |
Instances
newDetectorModelVersionSummary :: DetectorModelVersionSummary Source #
Create a value of DetectorModelVersionSummary 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:DetectorModelVersionSummary', detectorModelVersionSummary_creationTime - The time the detector model version was created.
$sel:status:DetectorModelVersionSummary', detectorModelVersionSummary_status - The status of the detector model version.
$sel:detectorModelName:DetectorModelVersionSummary', detectorModelVersionSummary_detectorModelName - The name of the detector model.
$sel:detectorModelArn:DetectorModelVersionSummary', detectorModelVersionSummary_detectorModelArn - The ARN of the detector model version.
$sel:detectorModelVersion:DetectorModelVersionSummary', detectorModelVersionSummary_detectorModelVersion - The ID of the detector model version.
$sel:lastUpdateTime:DetectorModelVersionSummary', detectorModelVersionSummary_lastUpdateTime - The last time the detector model version was updated.
$sel:evaluationMethod:DetectorModelVersionSummary', detectorModelVersionSummary_evaluationMethod - Information about the order in which events are evaluated and how
actions are executed.
$sel:roleArn:DetectorModelVersionSummary', detectorModelVersionSummary_roleArn - The ARN of the role that grants the detector model permission to perform
its tasks.
detectorModelVersionSummary_creationTime :: Lens' DetectorModelVersionSummary (Maybe UTCTime) Source #
The time the detector model version was created.
detectorModelVersionSummary_status :: Lens' DetectorModelVersionSummary (Maybe DetectorModelVersionStatus) Source #
The status of the detector model version.
detectorModelVersionSummary_detectorModelName :: Lens' DetectorModelVersionSummary (Maybe Text) Source #
The name of the detector model.
detectorModelVersionSummary_detectorModelArn :: Lens' DetectorModelVersionSummary (Maybe Text) Source #
The ARN of the detector model version.
detectorModelVersionSummary_detectorModelVersion :: Lens' DetectorModelVersionSummary (Maybe Text) Source #
The ID of the detector model version.
detectorModelVersionSummary_lastUpdateTime :: Lens' DetectorModelVersionSummary (Maybe UTCTime) Source #
The last time the detector model version was updated.
detectorModelVersionSummary_evaluationMethod :: Lens' DetectorModelVersionSummary (Maybe EvaluationMethod) Source #
Information about the order in which events are evaluated and how actions are executed.
detectorModelVersionSummary_roleArn :: Lens' DetectorModelVersionSummary (Maybe Text) Source #
The ARN of the role that grants the detector model permission to perform its tasks.
DynamoDBAction
data DynamoDBAction Source #
Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.
You must use expressions for all parameters in DynamoDBAction. The
expressions accept literals, operators, functions, references, and
substitution templates.
Examples
- For literal values, the expressions must contain single quotes. For
example, the value for the
hashKeyTypeparameter can be'STRING'. - For references, you must specify either variables or input values.
For example, the value for the
hashKeyFieldparameter can be$input.GreenhouseInput.name. For a substitution template, you must use
${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.In the following example, the value for the
hashKeyValueparameter uses a substitution template.'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'For a string concatenation, you must use
+. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.In the following example, the value for the
tableNameparameter uses a string concatenation.'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date
For more information, see Expressions in the AWS IoT Events Developer Guide.
If the defined payload type is a string, DynamoDBAction writes
non-JSON data to the DynamoDB table as binary data. The DynamoDB console
displays the data as Base64-encoded text. The value for the
payloadField parameter is <payload-field>_raw.
See: newDynamoDBAction smart constructor.
Constructors
| DynamoDBAction' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> DynamoDBAction |
Create a value of DynamoDBAction 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:hashKeyType:DynamoDBAction', dynamoDBAction_hashKeyType - The data type for the hash key (also called the partition key). You can
specify the following values:
'STRING'- The hash key is a string.'NUMBER'- The hash key is a number.
If you don't specify hashKeyType, the default value is 'STRING'.
$sel:operation:DynamoDBAction', dynamoDBAction_operation - The type of operation to perform. You can specify the following values:
'INSERT'- Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.'UPDATE'- Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.'DELETE'- Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
If you don't specify this parameter, AWS IoT Events triggers the
'INSERT' operation.
$sel:rangeKeyType:DynamoDBAction', dynamoDBAction_rangeKeyType - The data type for the range key (also called the sort key), You can
specify the following values:
'STRING'- The range key is a string.'NUMBER'- The range key is number.
If you don't specify rangeKeyField, the default value is
'STRING'.
$sel:payload:DynamoDBAction', dynamoDBAction_payload - Undocumented member.
$sel:payloadField:DynamoDBAction', dynamoDBAction_payloadField - The name of the DynamoDB column that receives the action payload.
If you don't specify this parameter, the name of the DynamoDB column is
payload.
$sel:rangeKeyField:DynamoDBAction', dynamoDBAction_rangeKeyField - The name of the range key (also called the sort key). The
rangeKeyField value must match the sort key of the target DynamoDB
table.
$sel:rangeKeyValue:DynamoDBAction', dynamoDBAction_rangeKeyValue - The value of the range key (also called the sort key).
$sel:hashKeyField:DynamoDBAction', dynamoDBAction_hashKeyField - The name of the hash key (also called the partition key). The
hashKeyField value must match the partition key of the target DynamoDB
table.
$sel:hashKeyValue:DynamoDBAction', dynamoDBAction_hashKeyValue - The value of the hash key (also called the partition key).
$sel:tableName:DynamoDBAction', dynamoDBAction_tableName - The name of the DynamoDB table. The tableName value must match the
table name of the target DynamoDB table.
dynamoDBAction_hashKeyType :: Lens' DynamoDBAction (Maybe Text) Source #
The data type for the hash key (also called the partition key). You can specify the following values:
'STRING'- The hash key is a string.'NUMBER'- The hash key is a number.
If you don't specify hashKeyType, the default value is 'STRING'.
dynamoDBAction_operation :: Lens' DynamoDBAction (Maybe Text) Source #
The type of operation to perform. You can specify the following values:
'INSERT'- Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.'UPDATE'- Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.'DELETE'- Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
If you don't specify this parameter, AWS IoT Events triggers the
'INSERT' operation.
dynamoDBAction_rangeKeyType :: Lens' DynamoDBAction (Maybe Text) Source #
The data type for the range key (also called the sort key), You can specify the following values:
'STRING'- The range key is a string.'NUMBER'- The range key is number.
If you don't specify rangeKeyField, the default value is
'STRING'.
dynamoDBAction_payload :: Lens' DynamoDBAction (Maybe Payload) Source #
Undocumented member.
dynamoDBAction_payloadField :: Lens' DynamoDBAction (Maybe Text) Source #
The name of the DynamoDB column that receives the action payload.
If you don't specify this parameter, the name of the DynamoDB column is
payload.
dynamoDBAction_rangeKeyField :: Lens' DynamoDBAction (Maybe Text) Source #
The name of the range key (also called the sort key). The
rangeKeyField value must match the sort key of the target DynamoDB
table.
dynamoDBAction_rangeKeyValue :: Lens' DynamoDBAction (Maybe Text) Source #
The value of the range key (also called the sort key).
dynamoDBAction_hashKeyField :: Lens' DynamoDBAction Text Source #
The name of the hash key (also called the partition key). The
hashKeyField value must match the partition key of the target DynamoDB
table.
dynamoDBAction_hashKeyValue :: Lens' DynamoDBAction Text Source #
The value of the hash key (also called the partition key).
dynamoDBAction_tableName :: Lens' DynamoDBAction Text Source #
The name of the DynamoDB table. The tableName value must match the
table name of the target DynamoDB table.
DynamoDBv2Action
data DynamoDBv2Action Source #
Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.
You must use expressions for all parameters in DynamoDBv2Action. The
expressions accept literals, operators, functions, references, and
substitution templates.
Examples
- For literal values, the expressions must contain single quotes. For
example, the value for the
tableNameparameter can be'GreenhouseTemperatureTable'. - For references, you must specify either variables or input values.
For example, the value for the
tableNameparameter can be$variable.ddbtableName. For a substitution template, you must use
${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.In the following example, the value for the
contentExpressionparameter inPayloaduses a substitution template.'{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'For a string concatenation, you must use
+. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.In the following example, the value for the
tableNameparameter uses a string concatenation.'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date
For more information, see Expressions in the AWS IoT Events Developer Guide.
The value for the type parameter in Payload must be JSON.
See: newDynamoDBv2Action smart constructor.
Constructors
| DynamoDBv2Action' | |
Instances
Arguments
| :: Text | |
| -> DynamoDBv2Action |
Create a value of DynamoDBv2Action 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:payload:DynamoDBv2Action', dynamoDBv2Action_payload - Undocumented member.
$sel:tableName:DynamoDBv2Action', dynamoDBv2Action_tableName - The name of the DynamoDB table.
dynamoDBv2Action_payload :: Lens' DynamoDBv2Action (Maybe Payload) Source #
Undocumented member.
dynamoDBv2Action_tableName :: Lens' DynamoDBv2Action Text Source #
The name of the DynamoDB table.
EmailConfiguration
data EmailConfiguration Source #
Contains the configuration information of email notifications.
See: newEmailConfiguration smart constructor.
Constructors
| EmailConfiguration' | |
Fields
| |
Instances
newEmailConfiguration Source #
Arguments
| :: Text | |
| -> EmailRecipients | |
| -> EmailConfiguration |
Create a value of EmailConfiguration 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:content:EmailConfiguration', emailConfiguration_content - Contains the subject and message of an email.
$sel:from:EmailConfiguration', emailConfiguration_from - The email address that sends emails.
If you use the AWS IoT Events managed AWS Lambda function to manage your emails, you must verify the email address that sends emails in Amazon SES.
$sel:recipients:EmailConfiguration', emailConfiguration_recipients - Contains the information of one or more recipients who receive the
emails.
You must add the users that receive emails to your AWS SSO store.
emailConfiguration_content :: Lens' EmailConfiguration (Maybe EmailContent) Source #
Contains the subject and message of an email.
emailConfiguration_from :: Lens' EmailConfiguration Text Source #
The email address that sends emails.
If you use the AWS IoT Events managed AWS Lambda function to manage your emails, you must verify the email address that sends emails in Amazon SES.
emailConfiguration_recipients :: Lens' EmailConfiguration EmailRecipients Source #
Contains the information of one or more recipients who receive the emails.
You must add the users that receive emails to your AWS SSO store.
EmailContent
data EmailContent Source #
Contains the subject and message of an email.
See: newEmailContent smart constructor.
Constructors
| EmailContent' | |
Instances
newEmailContent :: EmailContent Source #
Create a value of EmailContent 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:subject:EmailContent', emailContent_subject - The subject of the email.
$sel:additionalMessage:EmailContent', emailContent_additionalMessage - The message that you want to send. The message can be up to 200
characters.
emailContent_subject :: Lens' EmailContent (Maybe Text) Source #
The subject of the email.
emailContent_additionalMessage :: Lens' EmailContent (Maybe Text) Source #
The message that you want to send. The message can be up to 200 characters.
EmailRecipients
data EmailRecipients Source #
Contains the information of one or more recipients who receive the emails.
You must add the users that receive emails to your AWS SSO store.
See: newEmailRecipients smart constructor.
Constructors
| EmailRecipients' | |
Fields
| |
Instances
newEmailRecipients :: EmailRecipients Source #
Create a value of EmailRecipients 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:to:EmailRecipients', emailRecipients_to - Specifies one or more recipients who receive the email.
emailRecipients_to :: Lens' EmailRecipients (Maybe (NonEmpty RecipientDetail)) Source #
Specifies one or more recipients who receive the email.
Event
Specifies the actions to be performed when the condition evaluates
to TRUE.
See: newEvent smart constructor.
Constructors
| Event' | |
Fields
| |
Instances
| Eq Event Source # | |
| Read Event Source # | |
| Show Event Source # | |
| Generic Event Source # | |
| NFData Event Source # | |
Defined in Amazonka.IoTEvents.Types.Event | |
| Hashable Event Source # | |
Defined in Amazonka.IoTEvents.Types.Event | |
| ToJSON Event Source # | |
Defined in Amazonka.IoTEvents.Types.Event | |
| FromJSON Event Source # | |
| type Rep Event Source # | |
Defined in Amazonka.IoTEvents.Types.Event type Rep Event = D1 ('MetaData "Event" "Amazonka.IoTEvents.Types.Event" "libZSservicesZSamazonka-ioteventsZSamazonka-iotevents" 'False) (C1 ('MetaCons "Event'" 'PrefixI 'True) (S1 ('MetaSel ('Just "actions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Action])) :*: (S1 ('MetaSel ('Just "condition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "eventName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) | |
Create a value of Event 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:actions:Event', event_actions - The actions to be performed.
$sel:condition:Event', event_condition - Optional. The Boolean expression that, when TRUE, causes the actions
to be performed. If not present, the actions are performed (=TRUE). If
the expression result is not a Boolean value, the actions are not
performed (=FALSE).
$sel:eventName:Event', event_eventName - The name of the event.
event_condition :: Lens' Event (Maybe Text) Source #
Optional. The Boolean expression that, when TRUE, causes the actions
to be performed. If not present, the actions are performed (=TRUE). If
the expression result is not a Boolean value, the actions are not
performed (=FALSE).
FirehoseAction
data FirehoseAction Source #
Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
See: newFirehoseAction smart constructor.
Constructors
| FirehoseAction' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> FirehoseAction |
Create a value of FirehoseAction 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:separator:FirehoseAction', firehoseAction_separator - A character separator that is used to separate records written to the
Kinesis Data Firehose delivery stream. Valid values are: '\n'
(newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
$sel:payload:FirehoseAction', firehoseAction_payload - You can configure the action payload when you send a message to an
Amazon Kinesis Data Firehose delivery stream.
$sel:deliveryStreamName:FirehoseAction', firehoseAction_deliveryStreamName - The name of the Kinesis Data Firehose delivery stream where the data is
written.
firehoseAction_separator :: Lens' FirehoseAction (Maybe Text) Source #
A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
firehoseAction_payload :: Lens' FirehoseAction (Maybe Payload) Source #
You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream.
firehoseAction_deliveryStreamName :: Lens' FirehoseAction Text Source #
The name of the Kinesis Data Firehose delivery stream where the data is written.
InitializationConfiguration
data InitializationConfiguration Source #
Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.
See: newInitializationConfiguration smart constructor.
Constructors
| InitializationConfiguration' | |
Fields
| |
Instances
newInitializationConfiguration Source #
Arguments
| :: Bool | |
| -> InitializationConfiguration |
Create a value of InitializationConfiguration 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:disabledOnInitialization:InitializationConfiguration', initializationConfiguration_disabledOnInitialization - The value must be TRUE or FALSE. If FALSE, all alarm instances
created based on the alarm model are activated. The default value is
TRUE.
initializationConfiguration_disabledOnInitialization :: Lens' InitializationConfiguration Bool Source #
The value must be TRUE or FALSE. If FALSE, all alarm instances
created based on the alarm model are activated. The default value is
TRUE.
Input
Information about the input.
See: newInput smart constructor.
Constructors
| Input' | |
Fields
| |
Instances
| Eq Input Source # | |
| Read Input Source # | |
| Show Input Source # | |
| Generic Input Source # | |
| NFData Input Source # | |
Defined in Amazonka.IoTEvents.Types.Input | |
| Hashable Input Source # | |
Defined in Amazonka.IoTEvents.Types.Input | |
| FromJSON Input Source # | |
| type Rep Input Source # | |
Defined in Amazonka.IoTEvents.Types.Input type Rep Input = D1 ('MetaData "Input" "Amazonka.IoTEvents.Types.Input" "libZSservicesZSamazonka-ioteventsZSamazonka-iotevents" 'False) (C1 ('MetaCons "Input'" 'PrefixI 'True) (S1 ('MetaSel ('Just "inputDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputDefinition)) :*: S1 ('MetaSel ('Just "inputConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputConfiguration)))) | |
Create a value of Input 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:inputDefinition:Input', input_inputDefinition - The definition of the input.
$sel:inputConfiguration:Input', input_inputConfiguration - Information about the configuration of an input.
input_inputDefinition :: Lens' Input (Maybe InputDefinition) Source #
The definition of the input.
input_inputConfiguration :: Lens' Input (Maybe InputConfiguration) Source #
Information about the configuration of an input.
InputConfiguration
data InputConfiguration Source #
Information about the configuration of an input.
See: newInputConfiguration smart constructor.
Constructors
| InputConfiguration' | |
Fields
| |
Instances
newInputConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> UTCTime | |
| -> UTCTime | |
| -> InputStatus | |
| -> InputConfiguration |
Create a value of InputConfiguration 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:inputDescription:InputConfiguration', inputConfiguration_inputDescription - A brief description of the input.
$sel:inputName:InputConfiguration', inputConfiguration_inputName - The name of the input.
$sel:inputArn:InputConfiguration', inputConfiguration_inputArn - The ARN of the input.
$sel:creationTime:InputConfiguration', inputConfiguration_creationTime - The time the input was created.
$sel:lastUpdateTime:InputConfiguration', inputConfiguration_lastUpdateTime - The last time the input was updated.
$sel:status:InputConfiguration', inputConfiguration_status - The status of the input.
inputConfiguration_inputDescription :: Lens' InputConfiguration (Maybe Text) Source #
A brief description of the input.
inputConfiguration_inputName :: Lens' InputConfiguration Text Source #
The name of the input.
inputConfiguration_inputArn :: Lens' InputConfiguration Text Source #
The ARN of the input.
inputConfiguration_creationTime :: Lens' InputConfiguration UTCTime Source #
The time the input was created.
inputConfiguration_lastUpdateTime :: Lens' InputConfiguration UTCTime Source #
The last time the input was updated.
inputConfiguration_status :: Lens' InputConfiguration InputStatus Source #
The status of the input.
InputDefinition
data InputDefinition Source #
The definition of the input.
See: newInputDefinition smart constructor.
Constructors
| InputDefinition' | |
Fields
| |
Instances
Arguments
| :: NonEmpty Attribute | |
| -> InputDefinition |
Create a value of InputDefinition 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:attributes:InputDefinition', inputDefinition_attributes - The attributes from the JSON payload that are made available by the
input. Inputs are derived from messages sent to the AWS IoT Events
system using BatchPutMessage. Each such message contains a JSON
payload, and those attributes (and their paired values) specified here
are available for use in the condition expressions used by detectors
that monitor this input.
inputDefinition_attributes :: Lens' InputDefinition (NonEmpty Attribute) Source #
The attributes from the JSON payload that are made available by the
input. Inputs are derived from messages sent to the AWS IoT Events
system using BatchPutMessage. Each such message contains a JSON
payload, and those attributes (and their paired values) specified here
are available for use in the condition expressions used by detectors
that monitor this input.
InputIdentifier
data InputIdentifier Source #
The identifer of the input.
See: newInputIdentifier smart constructor.
Constructors
| InputIdentifier' | |
Fields
| |
Instances
newInputIdentifier :: InputIdentifier Source #
Create a value of InputIdentifier 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:iotSiteWiseInputIdentifier:InputIdentifier', inputIdentifier_iotSiteWiseInputIdentifier - The identifer of the input routed from AWS IoT SiteWise.
$sel:iotEventsInputIdentifier:InputIdentifier', inputIdentifier_iotEventsInputIdentifier - The identifier of the input routed to AWS IoT Events.
inputIdentifier_iotSiteWiseInputIdentifier :: Lens' InputIdentifier (Maybe IotSiteWiseInputIdentifier) Source #
The identifer of the input routed from AWS IoT SiteWise.
inputIdentifier_iotEventsInputIdentifier :: Lens' InputIdentifier (Maybe IotEventsInputIdentifier) Source #
The identifier of the input routed to AWS IoT Events.
InputSummary
data InputSummary Source #
Information about the input.
See: newInputSummary smart constructor.
Constructors
| InputSummary' | |
Fields
| |
Instances
newInputSummary :: InputSummary Source #
Create a value of InputSummary 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:InputSummary', inputSummary_creationTime - The time the input was created.
$sel:status:InputSummary', inputSummary_status - The status of the input.
$sel:inputName:InputSummary', inputSummary_inputName - The name of the input.
$sel:inputDescription:InputSummary', inputSummary_inputDescription - A brief description of the input.
$sel:inputArn:InputSummary', inputSummary_inputArn - The ARN of the input.
$sel:lastUpdateTime:InputSummary', inputSummary_lastUpdateTime - The last time the input was updated.
inputSummary_creationTime :: Lens' InputSummary (Maybe UTCTime) Source #
The time the input was created.
inputSummary_status :: Lens' InputSummary (Maybe InputStatus) Source #
The status of the input.
inputSummary_inputName :: Lens' InputSummary (Maybe Text) Source #
The name of the input.
inputSummary_inputDescription :: Lens' InputSummary (Maybe Text) Source #
A brief description of the input.
inputSummary_inputArn :: Lens' InputSummary (Maybe Text) Source #
The ARN of the input.
inputSummary_lastUpdateTime :: Lens' InputSummary (Maybe UTCTime) Source #
The last time the input was updated.
IotEventsAction
data IotEventsAction Source #
Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
See: newIotEventsAction smart constructor.
Constructors
| IotEventsAction' | |
Instances
Arguments
| :: Text | |
| -> IotEventsAction |
Create a value of IotEventsAction 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:payload:IotEventsAction', iotEventsAction_payload - You can configure the action payload when you send a message to an AWS
IoT Events input.
$sel:inputName:IotEventsAction', iotEventsAction_inputName - The name of the AWS IoT Events input where the data is sent.
iotEventsAction_payload :: Lens' IotEventsAction (Maybe Payload) Source #
You can configure the action payload when you send a message to an AWS IoT Events input.
iotEventsAction_inputName :: Lens' IotEventsAction Text Source #
The name of the AWS IoT Events input where the data is sent.
IotEventsInputIdentifier
data IotEventsInputIdentifier Source #
The identifier of the input routed to AWS IoT Events.
See: newIotEventsInputIdentifier smart constructor.
Constructors
| IotEventsInputIdentifier' | |
Instances
newIotEventsInputIdentifier Source #
Create a value of IotEventsInputIdentifier 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:IotEventsInputIdentifier', iotEventsInputIdentifier_inputName - The name of the input routed to AWS IoT Events.
iotEventsInputIdentifier_inputName :: Lens' IotEventsInputIdentifier Text Source #
The name of the input routed to AWS IoT Events.
IotSiteWiseAction
data IotSiteWiseAction Source #
Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise.
You must use expressions for all parameters in IotSiteWiseAction. The
expressions accept literals, operators, functions, references, and
substitutions templates.
Examples
- For literal values, the expressions must contain single quotes. For
example, the value for the
propertyAliasparameter can be'/company/windfarm/3/turbine/7/temperature'. - For references, you must specify either variables or input values.
For example, the value for the
assetIdparameter can be$input.TurbineInput.assetId1. For a substitution template, you must use
${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.In the following example, the value for the
propertyAliasparameter uses a substitution template.'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'
You must specify either propertyAlias or both assetId and
propertyId to identify the target asset property in AWS IoT SiteWise.
For more information, see Expressions in the AWS IoT Events Developer Guide.
See: newIotSiteWiseAction smart constructor.
Constructors
| IotSiteWiseAction' | |
Fields
| |
Instances
newIotSiteWiseAction :: IotSiteWiseAction Source #
Create a value of IotSiteWiseAction 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:entryId:IotSiteWiseAction', iotSiteWiseAction_entryId - A unique identifier for this entry. You can use the entry ID to track
which data entry causes an error in case of failure. The default is a
new unique identifier.
$sel:propertyAlias:IotSiteWiseAction', iotSiteWiseAction_propertyAlias - The alias of the asset property.
$sel:propertyValue:IotSiteWiseAction', iotSiteWiseAction_propertyValue - The value to send to the asset property. This value contains timestamp,
quality, and value (TQV) information.
$sel:propertyId:IotSiteWiseAction', iotSiteWiseAction_propertyId - The ID of the asset property.
$sel:assetId:IotSiteWiseAction', iotSiteWiseAction_assetId - The ID of the asset that has the specified property.
iotSiteWiseAction_entryId :: Lens' IotSiteWiseAction (Maybe Text) Source #
A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier.
iotSiteWiseAction_propertyAlias :: Lens' IotSiteWiseAction (Maybe Text) Source #
The alias of the asset property.
iotSiteWiseAction_propertyValue :: Lens' IotSiteWiseAction (Maybe AssetPropertyValue) Source #
The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.
iotSiteWiseAction_propertyId :: Lens' IotSiteWiseAction (Maybe Text) Source #
The ID of the asset property.
iotSiteWiseAction_assetId :: Lens' IotSiteWiseAction (Maybe Text) Source #
The ID of the asset that has the specified property.
IotSiteWiseAssetModelPropertyIdentifier
data IotSiteWiseAssetModelPropertyIdentifier Source #
The asset model property identifer of the input routed from AWS IoT SiteWise.
See: newIotSiteWiseAssetModelPropertyIdentifier smart constructor.
Constructors
| IotSiteWiseAssetModelPropertyIdentifier' | |
Fields
| |
Instances
newIotSiteWiseAssetModelPropertyIdentifier Source #
Arguments
| :: Text | |
| -> Text | |
| -> IotSiteWiseAssetModelPropertyIdentifier |
Create a value of IotSiteWiseAssetModelPropertyIdentifier 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:assetModelId:IotSiteWiseAssetModelPropertyIdentifier', iotSiteWiseAssetModelPropertyIdentifier_assetModelId - The ID of the AWS IoT SiteWise asset model.
$sel:propertyId:IotSiteWiseAssetModelPropertyIdentifier', iotSiteWiseAssetModelPropertyIdentifier_propertyId - The ID of the AWS IoT SiteWise asset property.
iotSiteWiseAssetModelPropertyIdentifier_assetModelId :: Lens' IotSiteWiseAssetModelPropertyIdentifier Text Source #
The ID of the AWS IoT SiteWise asset model.
iotSiteWiseAssetModelPropertyIdentifier_propertyId :: Lens' IotSiteWiseAssetModelPropertyIdentifier Text Source #
The ID of the AWS IoT SiteWise asset property.
IotSiteWiseInputIdentifier
data IotSiteWiseInputIdentifier Source #
The identifer of the input routed from AWS IoT SiteWise.
See: newIotSiteWiseInputIdentifier smart constructor.
Constructors
| IotSiteWiseInputIdentifier' | |
Fields
| |
Instances
newIotSiteWiseInputIdentifier :: IotSiteWiseInputIdentifier Source #
Create a value of IotSiteWiseInputIdentifier 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:iotSiteWiseAssetModelPropertyIdentifier:IotSiteWiseInputIdentifier', iotSiteWiseInputIdentifier_iotSiteWiseAssetModelPropertyIdentifier - The identifier of the AWS IoT SiteWise asset model property.
iotSiteWiseInputIdentifier_iotSiteWiseAssetModelPropertyIdentifier :: Lens' IotSiteWiseInputIdentifier (Maybe IotSiteWiseAssetModelPropertyIdentifier) Source #
The identifier of the AWS IoT SiteWise asset model property.
IotTopicPublishAction
data IotTopicPublishAction Source #
Information required to publish the MQTT message through the AWS IoT message broker.
See: newIotTopicPublishAction smart constructor.
Constructors
| IotTopicPublishAction' | |
Fields
| |
Instances
newIotTopicPublishAction Source #
Create a value of IotTopicPublishAction 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:payload:IotTopicPublishAction', iotTopicPublishAction_payload - You can configure the action payload when you publish a message to an
AWS IoT Core topic.
$sel:mqttTopic:IotTopicPublishAction', iotTopicPublishAction_mqttTopic - The MQTT topic of the message. You can use a string expression that
includes variables ($variable.<variable-name>) and input values
($input.<input-name>.<path-to-datum>) as the topic string.
iotTopicPublishAction_payload :: Lens' IotTopicPublishAction (Maybe Payload) Source #
You can configure the action payload when you publish a message to an AWS IoT Core topic.
iotTopicPublishAction_mqttTopic :: Lens' IotTopicPublishAction Text Source #
The MQTT topic of the message. You can use a string expression that
includes variables ($variable.<variable-name>) and input values
($input.<input-name>.<path-to-datum>) as the topic string.
LambdaAction
data LambdaAction Source #
Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
See: newLambdaAction smart constructor.
Constructors
| LambdaAction' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> LambdaAction |
Create a value of LambdaAction 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:payload:LambdaAction', lambdaAction_payload - You can configure the action payload when you send a message to a Lambda
function.
$sel:functionArn:LambdaAction', lambdaAction_functionArn - The ARN of the Lambda function that is executed.
lambdaAction_payload :: Lens' LambdaAction (Maybe Payload) Source #
You can configure the action payload when you send a message to a Lambda function.
lambdaAction_functionArn :: Lens' LambdaAction Text Source #
The ARN of the Lambda function that is executed.
LoggingOptions
data LoggingOptions Source #
The values of the AWS IoT Events logging options.
See: newLoggingOptions smart constructor.
Constructors
| LoggingOptions' | |
Fields
| |
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:detectorDebugOptions:LoggingOptions', loggingOptions_detectorDebugOptions - Information that identifies those detector models and their detectors
(instances) for which the logging level is given.
$sel:roleArn:LoggingOptions', loggingOptions_roleArn - The ARN of the role that grants permission to AWS IoT Events to perform
logging.
$sel:level:LoggingOptions', loggingOptions_level - The logging level.
$sel:enabled:LoggingOptions', loggingOptions_enabled - If TRUE, logging is enabled for AWS IoT Events.
loggingOptions_detectorDebugOptions :: Lens' LoggingOptions (Maybe (NonEmpty DetectorDebugOption)) Source #
Information that identifies those detector models and their detectors (instances) for which the logging level is given.
loggingOptions_roleArn :: Lens' LoggingOptions Text Source #
The ARN of the role that grants permission to AWS IoT Events to perform logging.
loggingOptions_level :: Lens' LoggingOptions LoggingLevel Source #
The logging level.
loggingOptions_enabled :: Lens' LoggingOptions Bool Source #
If TRUE, logging is enabled for AWS IoT Events.
NotificationAction
data NotificationAction Source #
Contains the notification settings of an alarm model. The settings apply to all alarms that were created based on this alarm model.
See: newNotificationAction smart constructor.
Constructors
| NotificationAction' | |
Fields
| |
Instances
newNotificationAction Source #
Create a value of NotificationAction 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:emailConfigurations:NotificationAction', notificationAction_emailConfigurations - Contains the configuration information of email notifications.
$sel:smsConfigurations:NotificationAction', notificationAction_smsConfigurations - Contains the configuration information of SMS notifications.
$sel:action:NotificationAction', notificationAction_action - Specifies an AWS Lambda function to manage alarm notifications. You can
create one or use the
AWS Lambda function provided by AWS IoT Events.
notificationAction_emailConfigurations :: Lens' NotificationAction (Maybe (NonEmpty EmailConfiguration)) Source #
Contains the configuration information of email notifications.
notificationAction_smsConfigurations :: Lens' NotificationAction (Maybe (NonEmpty SMSConfiguration)) Source #
Contains the configuration information of SMS notifications.
notificationAction_action :: Lens' NotificationAction NotificationTargetActions Source #
Specifies an AWS Lambda function to manage alarm notifications. You can create one or use the AWS Lambda function provided by AWS IoT Events.
NotificationTargetActions
data NotificationTargetActions Source #
Specifies an AWS Lambda function to manage alarm notifications. You can create one or use the AWS Lambda function provided by AWS IoT Events.
See: newNotificationTargetActions smart constructor.
Constructors
| NotificationTargetActions' | |
Fields | |
Instances
newNotificationTargetActions :: NotificationTargetActions Source #
Create a value of NotificationTargetActions 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:lambdaAction:NotificationTargetActions', notificationTargetActions_lambdaAction - Undocumented member.
notificationTargetActions_lambdaAction :: Lens' NotificationTargetActions (Maybe LambdaAction) Source #
Undocumented member.
OnEnterLifecycle
data OnEnterLifecycle Source #
When entering this state, perform these actions if the condition is
TRUE.
See: newOnEnterLifecycle smart constructor.
Constructors
| OnEnterLifecycle' | |
Instances
newOnEnterLifecycle :: OnEnterLifecycle Source #
Create a value of OnEnterLifecycle 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:events:OnEnterLifecycle', onEnterLifecycle_events - Specifies the actions that are performed when the state is entered and
the condition is TRUE.
onEnterLifecycle_events :: Lens' OnEnterLifecycle (Maybe [Event]) Source #
Specifies the actions that are performed when the state is entered and
the condition is TRUE.
OnExitLifecycle
data OnExitLifecycle Source #
When exiting this state, perform these actions if the specified
condition is TRUE.
See: newOnExitLifecycle smart constructor.
Constructors
| OnExitLifecycle' | |
Instances
newOnExitLifecycle :: OnExitLifecycle Source #
Create a value of OnExitLifecycle 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:events:OnExitLifecycle', onExitLifecycle_events - Specifies the actions that are performed when the state is exited and
the condition is TRUE.
onExitLifecycle_events :: Lens' OnExitLifecycle (Maybe [Event]) Source #
Specifies the actions that are performed when the state is exited and
the condition is TRUE.
OnInputLifecycle
data OnInputLifecycle Source #
Specifies the actions performed when the condition evaluates to TRUE.
See: newOnInputLifecycle smart constructor.
Constructors
| OnInputLifecycle' | |
Fields
| |
Instances
newOnInputLifecycle :: OnInputLifecycle Source #
Create a value of OnInputLifecycle 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:events:OnInputLifecycle', onInputLifecycle_events - Specifies the actions performed when the condition evaluates to TRUE.
$sel:transitionEvents:OnInputLifecycle', onInputLifecycle_transitionEvents - Specifies the actions performed, and the next state entered, when a
condition evaluates to TRUE.
onInputLifecycle_events :: Lens' OnInputLifecycle (Maybe [Event]) Source #
Specifies the actions performed when the condition evaluates to TRUE.
onInputLifecycle_transitionEvents :: Lens' OnInputLifecycle (Maybe [TransitionEvent]) Source #
Specifies the actions performed, and the next state entered, when a
condition evaluates to TRUE.
Payload
Information needed to configure the payload.
By default, AWS IoT Events generates a standard payload in JSON for any
action. This action payload contains all attribute-value pairs that have
the information about the detector model instance and the event
triggered the action. To configure the action payload, you can use
contentExpression.
See: newPayload smart constructor.
Constructors
| Payload' | |
Fields
| |
Instances
| Eq Payload Source # | |
| Read Payload Source # | |
| Show Payload Source # | |
| Generic Payload Source # | |
| NFData Payload Source # | |
Defined in Amazonka.IoTEvents.Types.Payload | |
| Hashable Payload Source # | |
Defined in Amazonka.IoTEvents.Types.Payload | |
| ToJSON Payload Source # | |
Defined in Amazonka.IoTEvents.Types.Payload | |
| FromJSON Payload Source # | |
| type Rep Payload Source # | |
Defined in Amazonka.IoTEvents.Types.Payload type Rep Payload = D1 ('MetaData "Payload" "Amazonka.IoTEvents.Types.Payload" "libZSservicesZSamazonka-ioteventsZSamazonka-iotevents" 'False) (C1 ('MetaCons "Payload'" 'PrefixI 'True) (S1 ('MetaSel ('Just "contentExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PayloadType))) | |
Arguments
| :: Text | |
| -> PayloadType | |
| -> Payload |
Create a value of Payload 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:contentExpression:Payload', payload_contentExpression - The content of the payload. You can use a string expression that
includes quoted strings ('<string>'), variables
($variable.<variable-name>), input values
($input.<input-name>.<path-to-datum>), string concatenations, and
quoted strings that contain ${} as the content. The recommended
maximum size of a content expression is 1 KB.
$sel:type':Payload', payload_type - The value of the payload type can be either STRING or JSON.
payload_contentExpression :: Lens' Payload Text Source #
The content of the payload. You can use a string expression that
includes quoted strings ('<string>'), variables
($variable.<variable-name>), input values
($input.<input-name>.<path-to-datum>), string concatenations, and
quoted strings that contain ${} as the content. The recommended
maximum size of a content expression is 1 KB.
payload_type :: Lens' Payload PayloadType Source #
The value of the payload type can be either STRING or JSON.
RecipientDetail
data RecipientDetail Source #
The information that identifies the recipient.
See: newRecipientDetail smart constructor.
Constructors
| RecipientDetail' | |
Fields
| |
Instances
newRecipientDetail :: RecipientDetail Source #
Create a value of RecipientDetail 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:ssoIdentity:RecipientDetail', recipientDetail_ssoIdentity - The AWS Single Sign-On (AWS SSO) authentication information.
recipientDetail_ssoIdentity :: Lens' RecipientDetail (Maybe SSOIdentity) Source #
The AWS Single Sign-On (AWS SSO) authentication information.
ResetTimerAction
data ResetTimerAction Source #
Information required to reset the timer. The timer is reset to the previously evaluated result of the duration. The duration expression isn't reevaluated when you reset the timer.
See: newResetTimerAction smart constructor.
Constructors
| ResetTimerAction' | |
Instances
Arguments
| :: Text | |
| -> ResetTimerAction |
Create a value of ResetTimerAction 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:timerName:ResetTimerAction', resetTimerAction_timerName - The name of the timer to reset.
resetTimerAction_timerName :: Lens' ResetTimerAction Text Source #
The name of the timer to reset.
RoutedResource
data RoutedResource Source #
Contains information about the routed resource.
See: newRoutedResource smart constructor.
Constructors
| RoutedResource' | |
Instances
newRoutedResource :: RoutedResource Source #
Create a value of RoutedResource 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:arn:RoutedResource', routedResource_arn - The ARN of the routed resource. For more information, see
Amazon Resource Names (ARNs)
in the AWS General Reference.
$sel:name:RoutedResource', routedResource_name - The name of the routed resource.
routedResource_arn :: Lens' RoutedResource (Maybe Text) Source #
The ARN of the routed resource. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
routedResource_name :: Lens' RoutedResource (Maybe Text) Source #
The name of the routed resource.
SMSConfiguration
data SMSConfiguration Source #
Contains the configuration information of SMS notifications.
See: newSMSConfiguration smart constructor.
Constructors
| SMSConfiguration' | |
Fields
| |
Instances
Create a value of SMSConfiguration 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:additionalMessage:SMSConfiguration', sMSConfiguration_additionalMessage - The message that you want to send. The message can be up to 200
characters.
$sel:senderId:SMSConfiguration', sMSConfiguration_senderId - The sender ID.
$sel:recipients:SMSConfiguration', sMSConfiguration_recipients - Specifies one or more recipients who receive the message.
You must add the users that receive SMS messages to your AWS SSO store.
sMSConfiguration_additionalMessage :: Lens' SMSConfiguration (Maybe Text) Source #
The message that you want to send. The message can be up to 200 characters.
sMSConfiguration_senderId :: Lens' SMSConfiguration (Maybe Text) Source #
The sender ID.
sMSConfiguration_recipients :: Lens' SMSConfiguration (NonEmpty RecipientDetail) Source #
Specifies one or more recipients who receive the message.
You must add the users that receive SMS messages to your AWS SSO store.
SNSTopicPublishAction
data SNSTopicPublishAction Source #
Information required to publish the Amazon SNS message.
See: newSNSTopicPublishAction smart constructor.
Constructors
| SNSTopicPublishAction' | |
Instances
newSNSTopicPublishAction Source #
Create a value of SNSTopicPublishAction 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:payload:SNSTopicPublishAction', sNSTopicPublishAction_payload - You can configure the action payload when you send a message as an
Amazon SNS push notification.
$sel:targetArn:SNSTopicPublishAction', sNSTopicPublishAction_targetArn - The ARN of the Amazon SNS target where the message is sent.
sNSTopicPublishAction_payload :: Lens' SNSTopicPublishAction (Maybe Payload) Source #
You can configure the action payload when you send a message as an Amazon SNS push notification.
sNSTopicPublishAction_targetArn :: Lens' SNSTopicPublishAction Text Source #
The ARN of the Amazon SNS target where the message is sent.
SSOIdentity
data SSOIdentity Source #
Contains information about your identity source in AWS Single Sign-On. For more information, see the AWS Single Sign-On User Guide.
See: newSSOIdentity smart constructor.
Constructors
| SSOIdentity' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> SSOIdentity |
Create a value of SSOIdentity 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:userId:SSOIdentity', sSOIdentity_userId - The user ID.
$sel:identityStoreId:SSOIdentity', sSOIdentity_identityStoreId - The ID of the AWS SSO identity store.
sSOIdentity_userId :: Lens' SSOIdentity (Maybe Text) Source #
The user ID.
sSOIdentity_identityStoreId :: Lens' SSOIdentity Text Source #
The ID of the AWS SSO identity store.
SetTimerAction
data SetTimerAction Source #
Information needed to set the timer.
See: newSetTimerAction smart constructor.
Constructors
| SetTimerAction' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> SetTimerAction |
Create a value of SetTimerAction 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:durationExpression:SetTimerAction', setTimerAction_durationExpression - The duration of the timer, in seconds. You can use a string expression
that includes numbers, variables ($variable.<variable-name>), and
input values ($input.<input-name>.<path-to-datum>) as the duration.
The range of the duration is 1-31622400 seconds. To ensure accuracy, the
minimum duration is 60 seconds. The evaluated result of the duration is
rounded down to the nearest whole number.
$sel:seconds:SetTimerAction', setTimerAction_seconds - The number of seconds until the timer expires. The minimum value is 60
seconds to ensure accuracy. The maximum value is 31622400 seconds.
$sel:timerName:SetTimerAction', setTimerAction_timerName - The name of the timer.
setTimerAction_durationExpression :: Lens' SetTimerAction (Maybe Text) Source #
The duration of the timer, in seconds. You can use a string expression
that includes numbers, variables ($variable.<variable-name>), and
input values ($input.<input-name>.<path-to-datum>) as the duration.
The range of the duration is 1-31622400 seconds. To ensure accuracy, the
minimum duration is 60 seconds. The evaluated result of the duration is
rounded down to the nearest whole number.
setTimerAction_seconds :: Lens' SetTimerAction (Maybe Natural) Source #
The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds.
setTimerAction_timerName :: Lens' SetTimerAction Text Source #
The name of the timer.
SetVariableAction
data SetVariableAction Source #
Information about the variable and its new value.
See: newSetVariableAction smart constructor.
Constructors
| SetVariableAction' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> SetVariableAction |
Create a value of SetVariableAction 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:variableName:SetVariableAction', setVariableAction_variableName - The name of the variable.
$sel:value:SetVariableAction', setVariableAction_value - The new value of the variable.
setVariableAction_variableName :: Lens' SetVariableAction Text Source #
The name of the variable.
setVariableAction_value :: Lens' SetVariableAction Text Source #
The new value of the variable.
SimpleRule
data SimpleRule Source #
A rule that compares an input property value to a threshold value with a comparison operator.
See: newSimpleRule smart constructor.
Constructors
| SimpleRule' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ComparisonOperator | |
| -> Text | |
| -> SimpleRule |
Create a value of SimpleRule 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:inputProperty:SimpleRule', simpleRule_inputProperty - The value on the left side of the comparison operator. You can specify
an AWS IoT Events input attribute as an input property.
$sel:comparisonOperator:SimpleRule', simpleRule_comparisonOperator - The comparison operator.
$sel:threshold:SimpleRule', simpleRule_threshold - The value on the right side of the comparison operator. You can enter a
number or specify an AWS IoT Events input attribute.
simpleRule_inputProperty :: Lens' SimpleRule Text Source #
The value on the left side of the comparison operator. You can specify an AWS IoT Events input attribute as an input property.
simpleRule_comparisonOperator :: Lens' SimpleRule ComparisonOperator Source #
The comparison operator.
simpleRule_threshold :: Lens' SimpleRule Text Source #
The value on the right side of the comparison operator. You can enter a number or specify an AWS IoT Events input attribute.
SqsAction
Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
See: newSqsAction smart constructor.
Constructors
| SqsAction' | |
Fields
| |
Instances
| Eq SqsAction Source # | |
| Read SqsAction Source # | |
| Show SqsAction Source # | |
| Generic SqsAction Source # | |
| NFData SqsAction Source # | |
Defined in Amazonka.IoTEvents.Types.SqsAction | |
| Hashable SqsAction Source # | |
Defined in Amazonka.IoTEvents.Types.SqsAction | |
| ToJSON SqsAction Source # | |
Defined in Amazonka.IoTEvents.Types.SqsAction | |
| FromJSON SqsAction Source # | |
| type Rep SqsAction Source # | |
Defined in Amazonka.IoTEvents.Types.SqsAction type Rep SqsAction = D1 ('MetaData "SqsAction" "Amazonka.IoTEvents.Types.SqsAction" "libZSservicesZSamazonka-ioteventsZSamazonka-iotevents" 'False) (C1 ('MetaCons "SqsAction'" 'PrefixI 'True) (S1 ('MetaSel ('Just "payload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Payload)) :*: (S1 ('MetaSel ('Just "useBase64") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "queueUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) | |
Create a value of SqsAction 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:payload:SqsAction', sqsAction_payload - You can configure the action payload when you send a message to an
Amazon SQS queue.
$sel:useBase64:SqsAction', sqsAction_useBase64 - Set this to TRUE if you want the data to be base-64 encoded before it is
written to the queue. Otherwise, set this to FALSE.
$sel:queueUrl:SqsAction', sqsAction_queueUrl - The URL of the SQS queue where the data is written.
sqsAction_payload :: Lens' SqsAction (Maybe Payload) Source #
You can configure the action payload when you send a message to an Amazon SQS queue.
sqsAction_useBase64 :: Lens' SqsAction (Maybe Bool) Source #
Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to FALSE.
sqsAction_queueUrl :: Lens' SqsAction Text Source #
The URL of the SQS queue where the data is written.
State
Information that defines a state of a detector.
See: newState smart constructor.
Constructors
| State' | |
Fields
| |
Instances
Create a value of State 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:onEnter:State', state_onEnter - When entering this state, perform these actions if the condition is
TRUE.
$sel:onInput:State', state_onInput - When an input is received and the condition is TRUE, perform the
specified actions.
$sel:onExit:State', state_onExit - When exiting this state, perform these actions if the specified
condition is TRUE.
$sel:stateName:State', state_stateName - The name of the state.
state_onEnter :: Lens' State (Maybe OnEnterLifecycle) Source #
When entering this state, perform these actions if the condition is
TRUE.
state_onInput :: Lens' State (Maybe OnInputLifecycle) Source #
When an input is received and the condition is TRUE, perform the
specified actions.
state_onExit :: Lens' State (Maybe OnExitLifecycle) Source #
When exiting this state, perform these actions if the specified
condition is TRUE.
Tag
Metadata that can be 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.IoTEvents.Types.Tag | |
| Hashable Tag Source # | |
Defined in Amazonka.IoTEvents.Types.Tag | |
| ToJSON Tag Source # | |
Defined in Amazonka.IoTEvents.Types.Tag | |
| FromJSON Tag Source # | |
| type Rep Tag Source # | |
Defined in Amazonka.IoTEvents.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.IoTEvents.Types.Tag" "libZSservicesZSamazonka-ioteventsZSamazonka-iotevents" '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.
TransitionEvent
data TransitionEvent Source #
Specifies the actions performed and the next state entered when a
condition evaluates to TRUE.
See: newTransitionEvent smart constructor.
Constructors
| TransitionEvent' | |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> TransitionEvent |
Create a value of TransitionEvent 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:actions:TransitionEvent', transitionEvent_actions - The actions to be performed.
$sel:eventName:TransitionEvent', transitionEvent_eventName - The name of the transition event.
$sel:condition:TransitionEvent', transitionEvent_condition - Required. A Boolean expression that when TRUE causes the actions to be
performed and the nextState to be entered.
$sel:nextState:TransitionEvent', transitionEvent_nextState - The next state to enter.
transitionEvent_actions :: Lens' TransitionEvent (Maybe [Action]) Source #
The actions to be performed.
transitionEvent_eventName :: Lens' TransitionEvent Text Source #
The name of the transition event.
transitionEvent_condition :: Lens' TransitionEvent Text Source #
Required. A Boolean expression that when TRUE causes the actions to be
performed and the nextState to be entered.
transitionEvent_nextState :: Lens' TransitionEvent Text Source #
The next state to enter.