Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- CreateAlarmModel
- CreateDetectorModel
- CreateInput
- DeleteAlarmModel
- DeleteDetectorModel
- DeleteInput
- DescribeAlarmModel
- DescribeDetectorModel
- DescribeDetectorModelAnalysis
- DescribeInput
- DescribeLoggingOptions
- GetDetectorModelAnalysisResults
- ListAlarmModelVersions
- ListAlarmModels
- ListDetectorModelVersions
- ListDetectorModels
- ListInputRoutings
- ListInputs
- ListTagsForResource
- PutLoggingOptions
- StartDetectorModelAnalysis
- TagResource
- UntagResource
- UpdateAlarmModel
- UpdateDetectorModel
- UpdateInput
- Types
- 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
Derived from API version 2018-07-27
of the AWS service descriptions, licensed under Apache 2.0.
AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use AWS IoT Events API operations to create, read, update, and delete inputs and detector models, and to list their versions.
Synopsis
- defaultService :: Service
- _InternalFailureException :: AsError a => Fold a ServiceError
- _InvalidRequestException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Fold a ServiceError
- _ResourceInUseException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceUnavailableException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _UnsupportedOperationException :: AsError a => Fold a ServiceError
- data CreateAlarmModel = CreateAlarmModel' (Maybe AlarmCapabilities) (Maybe AlarmEventActions) (Maybe Text) (Maybe AlarmNotification) (Maybe Text) (Maybe Natural) (Maybe [Tag]) Text Text AlarmRule
- newCreateAlarmModel :: Text -> Text -> AlarmRule -> CreateAlarmModel
- data CreateAlarmModelResponse = CreateAlarmModelResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe AlarmModelVersionStatus) Int
- newCreateAlarmModelResponse :: Int -> CreateAlarmModelResponse
- data CreateDetectorModel = CreateDetectorModel' (Maybe Text) (Maybe EvaluationMethod) (Maybe Text) (Maybe [Tag]) Text DetectorModelDefinition Text
- newCreateDetectorModel :: Text -> DetectorModelDefinition -> Text -> CreateDetectorModel
- data CreateDetectorModelResponse = CreateDetectorModelResponse' (Maybe DetectorModelConfiguration) Int
- newCreateDetectorModelResponse :: Int -> CreateDetectorModelResponse
- data CreateInput = CreateInput' (Maybe Text) (Maybe [Tag]) Text InputDefinition
- newCreateInput :: Text -> InputDefinition -> CreateInput
- data CreateInputResponse = CreateInputResponse' (Maybe InputConfiguration) Int
- newCreateInputResponse :: Int -> CreateInputResponse
- data DeleteAlarmModel = DeleteAlarmModel' Text
- newDeleteAlarmModel :: Text -> DeleteAlarmModel
- data DeleteAlarmModelResponse = DeleteAlarmModelResponse' Int
- newDeleteAlarmModelResponse :: Int -> DeleteAlarmModelResponse
- data DeleteDetectorModel = DeleteDetectorModel' Text
- newDeleteDetectorModel :: Text -> DeleteDetectorModel
- data DeleteDetectorModelResponse = DeleteDetectorModelResponse' Int
- newDeleteDetectorModelResponse :: Int -> DeleteDetectorModelResponse
- data DeleteInput = DeleteInput' Text
- newDeleteInput :: Text -> DeleteInput
- data DeleteInputResponse = DeleteInputResponse' Int
- newDeleteInputResponse :: Int -> DeleteInputResponse
- data DescribeAlarmModel = DescribeAlarmModel' (Maybe Text) Text
- newDescribeAlarmModel :: Text -> DescribeAlarmModel
- data DescribeAlarmModelResponse = DescribeAlarmModelResponse' (Maybe AlarmCapabilities) (Maybe AlarmEventActions) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe AlarmNotification) (Maybe AlarmRule) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe AlarmModelVersionStatus) (Maybe Text) Int
- newDescribeAlarmModelResponse :: Int -> DescribeAlarmModelResponse
- data DescribeDetectorModel = DescribeDetectorModel' (Maybe Text) Text
- newDescribeDetectorModel :: Text -> DescribeDetectorModel
- data DescribeDetectorModelResponse = DescribeDetectorModelResponse' (Maybe DetectorModel) Int
- newDescribeDetectorModelResponse :: Int -> DescribeDetectorModelResponse
- data DescribeDetectorModelAnalysis = DescribeDetectorModelAnalysis' Text
- newDescribeDetectorModelAnalysis :: Text -> DescribeDetectorModelAnalysis
- data DescribeDetectorModelAnalysisResponse = DescribeDetectorModelAnalysisResponse' (Maybe AnalysisStatus) Int
- newDescribeDetectorModelAnalysisResponse :: Int -> DescribeDetectorModelAnalysisResponse
- data DescribeInput = DescribeInput' Text
- newDescribeInput :: Text -> DescribeInput
- data DescribeInputResponse = DescribeInputResponse' (Maybe Input) Int
- newDescribeInputResponse :: Int -> DescribeInputResponse
- data DescribeLoggingOptions = DescribeLoggingOptions' {
- newDescribeLoggingOptions :: DescribeLoggingOptions
- data DescribeLoggingOptionsResponse = DescribeLoggingOptionsResponse' (Maybe LoggingOptions) Int
- newDescribeLoggingOptionsResponse :: Int -> DescribeLoggingOptionsResponse
- data GetDetectorModelAnalysisResults = GetDetectorModelAnalysisResults' (Maybe Int) (Maybe Text) Text
- newGetDetectorModelAnalysisResults :: Text -> GetDetectorModelAnalysisResults
- data GetDetectorModelAnalysisResultsResponse = GetDetectorModelAnalysisResultsResponse' (Maybe [AnalysisResult]) (Maybe Text) Int
- newGetDetectorModelAnalysisResultsResponse :: Int -> GetDetectorModelAnalysisResultsResponse
- data ListAlarmModelVersions = ListAlarmModelVersions' (Maybe Natural) (Maybe Text) Text
- newListAlarmModelVersions :: Text -> ListAlarmModelVersions
- data ListAlarmModelVersionsResponse = ListAlarmModelVersionsResponse' (Maybe [AlarmModelVersionSummary]) (Maybe Text) Int
- newListAlarmModelVersionsResponse :: Int -> ListAlarmModelVersionsResponse
- data ListAlarmModels = ListAlarmModels' (Maybe Natural) (Maybe Text)
- newListAlarmModels :: ListAlarmModels
- data ListAlarmModelsResponse = ListAlarmModelsResponse' (Maybe [AlarmModelSummary]) (Maybe Text) Int
- newListAlarmModelsResponse :: Int -> ListAlarmModelsResponse
- data ListDetectorModelVersions = ListDetectorModelVersions' (Maybe Natural) (Maybe Text) Text
- newListDetectorModelVersions :: Text -> ListDetectorModelVersions
- data ListDetectorModelVersionsResponse = ListDetectorModelVersionsResponse' (Maybe [DetectorModelVersionSummary]) (Maybe Text) Int
- newListDetectorModelVersionsResponse :: Int -> ListDetectorModelVersionsResponse
- data ListDetectorModels = ListDetectorModels' (Maybe Natural) (Maybe Text)
- newListDetectorModels :: ListDetectorModels
- data ListDetectorModelsResponse = ListDetectorModelsResponse' (Maybe [DetectorModelSummary]) (Maybe Text) Int
- newListDetectorModelsResponse :: Int -> ListDetectorModelsResponse
- data ListInputRoutings = ListInputRoutings' (Maybe Natural) (Maybe Text) InputIdentifier
- newListInputRoutings :: InputIdentifier -> ListInputRoutings
- data ListInputRoutingsResponse = ListInputRoutingsResponse' (Maybe Text) (Maybe [RoutedResource]) Int
- newListInputRoutingsResponse :: Int -> ListInputRoutingsResponse
- data ListInputs = ListInputs' (Maybe Natural) (Maybe Text)
- newListInputs :: ListInputs
- data ListInputsResponse = ListInputsResponse' (Maybe [InputSummary]) (Maybe Text) Int
- newListInputsResponse :: Int -> ListInputsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data PutLoggingOptions = PutLoggingOptions' LoggingOptions
- newPutLoggingOptions :: LoggingOptions -> PutLoggingOptions
- data PutLoggingOptionsResponse = PutLoggingOptionsResponse' {
- newPutLoggingOptionsResponse :: PutLoggingOptionsResponse
- data StartDetectorModelAnalysis = StartDetectorModelAnalysis' DetectorModelDefinition
- newStartDetectorModelAnalysis :: DetectorModelDefinition -> StartDetectorModelAnalysis
- data StartDetectorModelAnalysisResponse = StartDetectorModelAnalysisResponse' (Maybe Text) Int
- newStartDetectorModelAnalysisResponse :: Int -> StartDetectorModelAnalysisResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateAlarmModel = UpdateAlarmModel' (Maybe AlarmCapabilities) (Maybe AlarmEventActions) (Maybe Text) (Maybe AlarmNotification) (Maybe Natural) Text Text AlarmRule
- newUpdateAlarmModel :: Text -> Text -> AlarmRule -> UpdateAlarmModel
- data UpdateAlarmModelResponse = UpdateAlarmModelResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe AlarmModelVersionStatus) Int
- newUpdateAlarmModelResponse :: Int -> UpdateAlarmModelResponse
- data UpdateDetectorModel = UpdateDetectorModel' (Maybe Text) (Maybe EvaluationMethod) Text DetectorModelDefinition Text
- newUpdateDetectorModel :: Text -> DetectorModelDefinition -> Text -> UpdateDetectorModel
- data UpdateDetectorModelResponse = UpdateDetectorModelResponse' (Maybe DetectorModelConfiguration) Int
- newUpdateDetectorModelResponse :: Int -> UpdateDetectorModelResponse
- data UpdateInput = UpdateInput' (Maybe Text) Text InputDefinition
- newUpdateInput :: Text -> InputDefinition -> UpdateInput
- data UpdateInputResponse = UpdateInputResponse' (Maybe InputConfiguration) Int
- newUpdateInputResponse :: Int -> UpdateInputResponse
- 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' Bool
- newAcknowledgeFlow :: Bool -> AcknowledgeFlow
- data Action = Action' (Maybe ClearTimerAction) (Maybe DynamoDBAction) (Maybe DynamoDBv2Action) (Maybe FirehoseAction) (Maybe IotEventsAction) (Maybe IotSiteWiseAction) (Maybe IotTopicPublishAction) (Maybe LambdaAction) (Maybe ResetTimerAction) (Maybe SetTimerAction) (Maybe SetVariableAction) (Maybe SNSTopicPublishAction) (Maybe SqsAction)
- newAction :: Action
- data AlarmAction = AlarmAction' (Maybe DynamoDBAction) (Maybe DynamoDBv2Action) (Maybe FirehoseAction) (Maybe IotEventsAction) (Maybe IotSiteWiseAction) (Maybe IotTopicPublishAction) (Maybe LambdaAction) (Maybe SNSTopicPublishAction) (Maybe SqsAction)
- newAlarmAction :: AlarmAction
- data AlarmCapabilities = AlarmCapabilities' (Maybe AcknowledgeFlow) (Maybe InitializationConfiguration)
- newAlarmCapabilities :: AlarmCapabilities
- data AlarmEventActions = AlarmEventActions' (Maybe [AlarmAction])
- newAlarmEventActions :: AlarmEventActions
- data AlarmModelSummary = AlarmModelSummary' (Maybe Text) (Maybe Text) (Maybe POSIX)
- newAlarmModelSummary :: AlarmModelSummary
- data AlarmModelVersionSummary = AlarmModelVersionSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe AlarmModelVersionStatus) (Maybe Text)
- newAlarmModelVersionSummary :: AlarmModelVersionSummary
- data AlarmNotification = AlarmNotification' (Maybe (NonEmpty NotificationAction))
- newAlarmNotification :: AlarmNotification
- data AlarmRule = AlarmRule' (Maybe SimpleRule)
- newAlarmRule :: AlarmRule
- data AnalysisResult = AnalysisResult' (Maybe AnalysisResultLevel) (Maybe [AnalysisResultLocation]) (Maybe Text) (Maybe Text)
- newAnalysisResult :: AnalysisResult
- data AnalysisResultLocation = AnalysisResultLocation' (Maybe Text)
- newAnalysisResultLocation :: AnalysisResultLocation
- data AssetPropertyTimestamp = AssetPropertyTimestamp' (Maybe Text) Text
- newAssetPropertyTimestamp :: Text -> AssetPropertyTimestamp
- data AssetPropertyValue = AssetPropertyValue' (Maybe Text) (Maybe AssetPropertyTimestamp) (Maybe AssetPropertyVariant)
- newAssetPropertyValue :: AssetPropertyValue
- data AssetPropertyVariant = AssetPropertyVariant' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newAssetPropertyVariant :: AssetPropertyVariant
- data Attribute = Attribute' Text
- newAttribute :: Text -> Attribute
- data ClearTimerAction = ClearTimerAction' Text
- newClearTimerAction :: Text -> ClearTimerAction
- data DetectorDebugOption = DetectorDebugOption' (Maybe Text) Text
- newDetectorDebugOption :: Text -> DetectorDebugOption
- data DetectorModel = DetectorModel' (Maybe DetectorModelConfiguration) (Maybe DetectorModelDefinition)
- newDetectorModel :: DetectorModel
- data DetectorModelConfiguration = DetectorModelConfiguration' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe EvaluationMethod) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe DetectorModelVersionStatus)
- newDetectorModelConfiguration :: DetectorModelConfiguration
- data DetectorModelDefinition = DetectorModelDefinition' (NonEmpty State) Text
- newDetectorModelDefinition :: NonEmpty State -> Text -> DetectorModelDefinition
- data DetectorModelSummary = DetectorModelSummary' (Maybe POSIX) (Maybe Text) (Maybe Text)
- newDetectorModelSummary :: DetectorModelSummary
- data DetectorModelVersionSummary = DetectorModelVersionSummary' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe EvaluationMethod) (Maybe POSIX) (Maybe Text) (Maybe DetectorModelVersionStatus)
- newDetectorModelVersionSummary :: DetectorModelVersionSummary
- data DynamoDBAction = DynamoDBAction' (Maybe Text) (Maybe Text) (Maybe Payload) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text Text Text
- newDynamoDBAction :: Text -> Text -> Text -> DynamoDBAction
- data DynamoDBv2Action = DynamoDBv2Action' (Maybe Payload) Text
- newDynamoDBv2Action :: Text -> DynamoDBv2Action
- data EmailConfiguration = EmailConfiguration' (Maybe EmailContent) Text EmailRecipients
- newEmailConfiguration :: Text -> EmailRecipients -> EmailConfiguration
- data EmailContent = EmailContent' (Maybe Text) (Maybe Text)
- newEmailContent :: EmailContent
- data EmailRecipients = EmailRecipients' (Maybe (NonEmpty RecipientDetail))
- newEmailRecipients :: EmailRecipients
- data Event = Event' (Maybe [Action]) (Maybe Text) Text
- newEvent :: Text -> Event
- data FirehoseAction = FirehoseAction' (Maybe Payload) (Maybe Text) Text
- newFirehoseAction :: Text -> FirehoseAction
- data InitializationConfiguration = InitializationConfiguration' Bool
- newInitializationConfiguration :: Bool -> InitializationConfiguration
- data Input = Input' (Maybe InputConfiguration) (Maybe InputDefinition)
- newInput :: Input
- data InputConfiguration = InputConfiguration' (Maybe Text) Text Text POSIX POSIX InputStatus
- newInputConfiguration :: Text -> Text -> UTCTime -> UTCTime -> InputStatus -> InputConfiguration
- data InputDefinition = InputDefinition' (NonEmpty Attribute)
- newInputDefinition :: NonEmpty Attribute -> InputDefinition
- data InputIdentifier = InputIdentifier' (Maybe IotEventsInputIdentifier) (Maybe IotSiteWiseInputIdentifier)
- newInputIdentifier :: InputIdentifier
- data InputSummary = InputSummary' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe InputStatus)
- newInputSummary :: InputSummary
- data IotEventsAction = IotEventsAction' (Maybe Payload) Text
- newIotEventsAction :: Text -> IotEventsAction
- data IotEventsInputIdentifier = IotEventsInputIdentifier' Text
- newIotEventsInputIdentifier :: Text -> IotEventsInputIdentifier
- data IotSiteWiseAction = IotSiteWiseAction' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe AssetPropertyValue)
- newIotSiteWiseAction :: IotSiteWiseAction
- data IotSiteWiseAssetModelPropertyIdentifier = IotSiteWiseAssetModelPropertyIdentifier' Text Text
- newIotSiteWiseAssetModelPropertyIdentifier :: Text -> Text -> IotSiteWiseAssetModelPropertyIdentifier
- data IotSiteWiseInputIdentifier = IotSiteWiseInputIdentifier' (Maybe IotSiteWiseAssetModelPropertyIdentifier)
- newIotSiteWiseInputIdentifier :: IotSiteWiseInputIdentifier
- data IotTopicPublishAction = IotTopicPublishAction' (Maybe Payload) Text
- newIotTopicPublishAction :: Text -> IotTopicPublishAction
- data LambdaAction = LambdaAction' (Maybe Payload) Text
- newLambdaAction :: Text -> LambdaAction
- data LoggingOptions = LoggingOptions' (Maybe (NonEmpty DetectorDebugOption)) Text LoggingLevel Bool
- newLoggingOptions :: Text -> LoggingLevel -> Bool -> LoggingOptions
- data NotificationAction = NotificationAction' (Maybe (NonEmpty EmailConfiguration)) (Maybe (NonEmpty SMSConfiguration)) NotificationTargetActions
- newNotificationAction :: NotificationTargetActions -> NotificationAction
- data NotificationTargetActions = NotificationTargetActions' (Maybe LambdaAction)
- newNotificationTargetActions :: NotificationTargetActions
- data OnEnterLifecycle = OnEnterLifecycle' (Maybe [Event])
- newOnEnterLifecycle :: OnEnterLifecycle
- data OnExitLifecycle = OnExitLifecycle' (Maybe [Event])
- newOnExitLifecycle :: OnExitLifecycle
- data OnInputLifecycle = OnInputLifecycle' (Maybe [Event]) (Maybe [TransitionEvent])
- newOnInputLifecycle :: OnInputLifecycle
- data Payload = Payload' Text PayloadType
- newPayload :: Text -> PayloadType -> Payload
- data RecipientDetail = RecipientDetail' (Maybe SSOIdentity)
- newRecipientDetail :: RecipientDetail
- data ResetTimerAction = ResetTimerAction' Text
- newResetTimerAction :: Text -> ResetTimerAction
- data RoutedResource = RoutedResource' (Maybe Text) (Maybe Text)
- newRoutedResource :: RoutedResource
- data SMSConfiguration = SMSConfiguration' (Maybe Text) (Maybe Text) (NonEmpty RecipientDetail)
- newSMSConfiguration :: NonEmpty RecipientDetail -> SMSConfiguration
- data SNSTopicPublishAction = SNSTopicPublishAction' (Maybe Payload) Text
- newSNSTopicPublishAction :: Text -> SNSTopicPublishAction
- data SSOIdentity = SSOIdentity' (Maybe Text) Text
- newSSOIdentity :: Text -> SSOIdentity
- data SetTimerAction = SetTimerAction' (Maybe Text) (Maybe Natural) Text
- newSetTimerAction :: Text -> SetTimerAction
- data SetVariableAction = SetVariableAction' Text Text
- newSetVariableAction :: Text -> Text -> SetVariableAction
- data SimpleRule = SimpleRule' Text ComparisonOperator Text
- newSimpleRule :: Text -> ComparisonOperator -> Text -> SimpleRule
- data SqsAction = SqsAction' (Maybe Payload) (Maybe Bool) Text
- newSqsAction :: Text -> SqsAction
- data State = State' (Maybe OnEnterLifecycle) (Maybe OnExitLifecycle) (Maybe OnInputLifecycle) Text
- newState :: Text -> State
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data TransitionEvent = TransitionEvent' (Maybe [Action]) Text Text Text
- newTransitionEvent :: Text -> Text -> Text -> TransitionEvent
Service Configuration
defaultService :: Service Source #
API version 2018-07-27
of the Amazon IoT Events SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by IoTEvents
.
InternalFailureException
_InternalFailureException :: AsError a => Fold a ServiceError Source #
An internal failure occurred.
InvalidRequestException
_InvalidRequestException :: AsError a => Fold a ServiceError Source #
The request was invalid.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
A limit was exceeded.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The resource already exists.
ResourceInUseException
_ResourceInUseException :: AsError a => Fold a ServiceError Source #
The resource is in use.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The resource was not found.
ServiceUnavailableException
_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #
The service is currently unavailable.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request could not be completed due to throttling.
UnsupportedOperationException
_UnsupportedOperationException :: AsError a => Fold a ServiceError Source #
The requested operation is not supported.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateAlarmModel
data CreateAlarmModel Source #
See: newCreateAlarmModel
smart constructor.
CreateAlarmModel' (Maybe AlarmCapabilities) (Maybe AlarmEventActions) (Maybe Text) (Maybe AlarmNotification) (Maybe Text) (Maybe Natural) (Maybe [Tag]) Text Text AlarmRule |
Instances
:: Text | |
-> Text | |
-> AlarmRule | |
-> CreateAlarmModel |
Create a value of CreateAlarmModel
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:alarmCapabilities:CreateAlarmModel'
, createAlarmModel_alarmCapabilities
- Contains the configuration information of alarm state changes.
$sel:alarmEventActions:CreateAlarmModel'
, createAlarmModel_alarmEventActions
- Contains information about one or more alarm actions.
CreateAlarmModel
, createAlarmModel_alarmModelDescription
- A description that tells you what the alarm model detects.
$sel:alarmNotification:CreateAlarmModel'
, createAlarmModel_alarmNotification
- Contains information about one or more notification actions.
CreateAlarmModel
, createAlarmModel_key
- An input attribute used as a key to create an alarm. AWS IoT Events
routes
inputs
associated with this key to the alarm.
$sel:severity:CreateAlarmModel'
, createAlarmModel_severity
- A non-negative integer that reflects the severity level of the alarm.
$sel:tags:CreateAlarmModel'
, createAlarmModel_tags
- A list of key-value pairs that contain metadata for the alarm model. The
tags help you manage the alarm model. For more information, see
Tagging your AWS IoT Events resources
in the AWS IoT Events Developer Guide.
You can create up to 50 tags for one alarm model.
CreateAlarmModel
, createAlarmModel_alarmModelName
- A unique name that helps you identify the alarm model. You can't change
this name after you create the alarm model.
CreateAlarmModel
, createAlarmModel_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.
$sel:alarmRule:CreateAlarmModel'
, createAlarmModel_alarmRule
- Defines when your alarm is invoked.
data CreateAlarmModelResponse Source #
See: newCreateAlarmModelResponse
smart constructor.
CreateAlarmModelResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe AlarmModelVersionStatus) Int |
Instances
newCreateAlarmModelResponse Source #
Create a value of CreateAlarmModelResponse
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:
CreateAlarmModelResponse
, createAlarmModelResponse_alarmModelArn
- The ARN of the alarm model. For more information, see
Amazon Resource Names (ARNs)
in the AWS General Reference.
CreateAlarmModelResponse
, createAlarmModelResponse_alarmModelVersion
- The version of the alarm model.
CreateAlarmModelResponse
, createAlarmModelResponse_creationTime
- The time the alarm model was created, in the Unix epoch format.
CreateAlarmModelResponse
, createAlarmModelResponse_lastUpdateTime
- The time the alarm model was last updated, in the Unix epoch format.
CreateAlarmModelResponse
, createAlarmModelResponse_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:httpStatus:CreateAlarmModelResponse'
, createAlarmModelResponse_httpStatus
- The response's http status code.
CreateDetectorModel
data CreateDetectorModel Source #
See: newCreateDetectorModel
smart constructor.
CreateDetectorModel' (Maybe Text) (Maybe EvaluationMethod) (Maybe Text) (Maybe [Tag]) Text DetectorModelDefinition Text |
Instances
newCreateDetectorModel Source #
Create a value of CreateDetectorModel
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:
CreateDetectorModel
, createDetectorModel_detectorModelDescription
- A brief description of the detector model.
CreateDetectorModel
, createDetectorModel_evaluationMethod
- Information about the order in which events are evaluated and how
actions are executed.
CreateDetectorModel
, createDetectorModel_key
- The input attribute key used to identify a device or system to create a
detector (an instance of the detector model) and then to route each
input received to the appropriate detector (instance). This parameter
uses a JSON-path expression in the message payload of each input to
specify the attribute-value pair that is used to identify the device
associated with the input.
$sel:tags:CreateDetectorModel'
, createDetectorModel_tags
- Metadata that can be used to manage the detector model.
CreateDetectorModel
, createDetectorModel_detectorModelName
- The name of the detector model.
CreateDetectorModel
, createDetectorModel_detectorModelDefinition
- Information that defines how the detectors operate.
CreateDetectorModel
, createDetectorModel_roleArn
- The ARN of the role that grants permission to AWS IoT Events to perform
its operations.
data CreateDetectorModelResponse Source #
See: newCreateDetectorModelResponse
smart constructor.
Instances
newCreateDetectorModelResponse Source #
Create a value of CreateDetectorModelResponse
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:
CreateDetectorModelResponse
, createDetectorModelResponse_detectorModelConfiguration
- Information about how the detector model is configured.
$sel:httpStatus:CreateDetectorModelResponse'
, createDetectorModelResponse_httpStatus
- The response's http status code.
CreateInput
data CreateInput Source #
See: newCreateInput
smart constructor.
CreateInput' (Maybe Text) (Maybe [Tag]) Text InputDefinition |
Instances
Create a value of CreateInput
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:
CreateInput
, createInput_inputDescription
- A brief description of the input.
$sel:tags:CreateInput'
, createInput_tags
- Metadata that can be used to manage the input.
CreateInput
, createInput_inputName
- The name you want to give to the input.
CreateInput
, createInput_inputDefinition
- The definition of the input.
data CreateInputResponse Source #
See: newCreateInputResponse
smart constructor.
Instances
newCreateInputResponse Source #
Create a value of CreateInputResponse
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:
CreateInputResponse
, createInputResponse_inputConfiguration
- Information about the configuration of the input.
$sel:httpStatus:CreateInputResponse'
, createInputResponse_httpStatus
- The response's http status code.
DeleteAlarmModel
data DeleteAlarmModel Source #
See: newDeleteAlarmModel
smart constructor.
Instances
Create a value of DeleteAlarmModel
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:
DeleteAlarmModel
, deleteAlarmModel_alarmModelName
- The name of the alarm model.
data DeleteAlarmModelResponse Source #
See: newDeleteAlarmModelResponse
smart constructor.
Instances
newDeleteAlarmModelResponse Source #
Create a value of DeleteAlarmModelResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteAlarmModelResponse'
, deleteAlarmModelResponse_httpStatus
- The response's http status code.
DeleteDetectorModel
data DeleteDetectorModel Source #
See: newDeleteDetectorModel
smart constructor.
Instances
newDeleteDetectorModel Source #
Create a value of DeleteDetectorModel
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:
DeleteDetectorModel
, deleteDetectorModel_detectorModelName
- The name of the detector model to be deleted.
data DeleteDetectorModelResponse Source #
See: newDeleteDetectorModelResponse
smart constructor.
Instances
newDeleteDetectorModelResponse Source #
Create a value of DeleteDetectorModelResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteDetectorModelResponse'
, deleteDetectorModelResponse_httpStatus
- The response's http status code.
DeleteInput
data DeleteInput Source #
See: newDeleteInput
smart constructor.
Instances
Create a value of DeleteInput
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:
DeleteInput
, deleteInput_inputName
- The name of the input to delete.
data DeleteInputResponse Source #
See: newDeleteInputResponse
smart constructor.
Instances
newDeleteInputResponse Source #
Create a value of DeleteInputResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteInputResponse'
, deleteInputResponse_httpStatus
- The response's http status code.
DescribeAlarmModel
data DescribeAlarmModel Source #
See: newDescribeAlarmModel
smart constructor.
Instances
newDescribeAlarmModel Source #
Create a value of DescribeAlarmModel
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:
DescribeAlarmModel
, describeAlarmModel_alarmModelVersion
- The version of the alarm model.
DescribeAlarmModel
, describeAlarmModel_alarmModelName
- The name of the alarm model.
data DescribeAlarmModelResponse Source #
See: newDescribeAlarmModelResponse
smart constructor.
DescribeAlarmModelResponse' (Maybe AlarmCapabilities) (Maybe AlarmEventActions) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe AlarmNotification) (Maybe AlarmRule) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe AlarmModelVersionStatus) (Maybe Text) Int |
Instances
newDescribeAlarmModelResponse Source #
Create a value of DescribeAlarmModelResponse
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:alarmCapabilities:DescribeAlarmModelResponse'
, describeAlarmModelResponse_alarmCapabilities
- Contains the configuration information of alarm state changes.
$sel:alarmEventActions:DescribeAlarmModelResponse'
, describeAlarmModelResponse_alarmEventActions
- Contains information about one or more alarm actions.
DescribeAlarmModelResponse
, describeAlarmModelResponse_alarmModelArn
- The ARN of the alarm model. For more information, see
Amazon Resource Names (ARNs)
in the AWS General Reference.
DescribeAlarmModelResponse
, describeAlarmModelResponse_alarmModelDescription
- The description of the alarm model.
DescribeAlarmModel
, describeAlarmModelResponse_alarmModelName
- The name of the alarm model.
DescribeAlarmModel
, describeAlarmModelResponse_alarmModelVersion
- The version of the alarm model.
$sel:alarmNotification:DescribeAlarmModelResponse'
, describeAlarmModelResponse_alarmNotification
- Contains information about one or more notification actions.
$sel:alarmRule:DescribeAlarmModelResponse'
, describeAlarmModelResponse_alarmRule
- Defines when your alarm is invoked.
DescribeAlarmModelResponse
, describeAlarmModelResponse_creationTime
- The time the alarm model was created, in the Unix epoch format.
DescribeAlarmModelResponse
, describeAlarmModelResponse_key
- An input attribute used as a key to create an alarm. AWS IoT Events
routes
inputs
associated with this key to the alarm.
DescribeAlarmModelResponse
, describeAlarmModelResponse_lastUpdateTime
- The time the alarm model was last updated, in the Unix epoch format.
DescribeAlarmModelResponse
, describeAlarmModelResponse_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.
$sel:severity:DescribeAlarmModelResponse'
, describeAlarmModelResponse_severity
- A non-negative integer that reflects the severity level of the alarm.
DescribeAlarmModelResponse
, describeAlarmModelResponse_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.
DescribeAlarmModelResponse
, describeAlarmModelResponse_statusMessage
- Contains information about the status of the alarm model.
$sel:httpStatus:DescribeAlarmModelResponse'
, describeAlarmModelResponse_httpStatus
- The response's http status code.
DescribeDetectorModel
data DescribeDetectorModel Source #
See: newDescribeDetectorModel
smart constructor.
Instances
newDescribeDetectorModel Source #
Create a value of DescribeDetectorModel
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:
DescribeDetectorModel
, describeDetectorModel_detectorModelVersion
- The version of the detector model.
DescribeDetectorModel
, describeDetectorModel_detectorModelName
- The name of the detector model.
data DescribeDetectorModelResponse Source #
See: newDescribeDetectorModelResponse
smart constructor.
Instances
newDescribeDetectorModelResponse Source #
Create a value of DescribeDetectorModelResponse
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:detectorModel:DescribeDetectorModelResponse'
, describeDetectorModelResponse_detectorModel
- Information about the detector model.
$sel:httpStatus:DescribeDetectorModelResponse'
, describeDetectorModelResponse_httpStatus
- The response's http status code.
DescribeDetectorModelAnalysis
data DescribeDetectorModelAnalysis Source #
See: newDescribeDetectorModelAnalysis
smart constructor.
Instances
newDescribeDetectorModelAnalysis Source #
Create a value of DescribeDetectorModelAnalysis
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:analysisId:DescribeDetectorModelAnalysis'
, describeDetectorModelAnalysis_analysisId
- The ID of the analysis result that you want to retrieve.
data DescribeDetectorModelAnalysisResponse Source #
See: newDescribeDetectorModelAnalysisResponse
smart constructor.
Instances
newDescribeDetectorModelAnalysisResponse Source #
Create a value of DescribeDetectorModelAnalysisResponse
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:
DescribeDetectorModelAnalysisResponse
, describeDetectorModelAnalysisResponse_status
- The status of the analysis activity. The status can be one of the
following values:
RUNNING
- AWS IoT Events is analyzing your detector model. This process can take several minutes to complete.COMPLETE
- AWS IoT Events finished analyzing your detector model.FAILED
- AWS IoT Events couldn't analyze your detector model. Try again later.
$sel:httpStatus:DescribeDetectorModelAnalysisResponse'
, describeDetectorModelAnalysisResponse_httpStatus
- The response's http status code.
DescribeInput
data DescribeInput Source #
See: newDescribeInput
smart constructor.
Instances
Create a value of DescribeInput
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:
DescribeInput
, describeInput_inputName
- The name of the input.
data DescribeInputResponse Source #
See: newDescribeInputResponse
smart constructor.
Instances
newDescribeInputResponse Source #
Create a value of DescribeInputResponse
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:input:DescribeInputResponse'
, describeInputResponse_input
- Information about the input.
$sel:httpStatus:DescribeInputResponse'
, describeInputResponse_httpStatus
- The response's http status code.
DescribeLoggingOptions
data DescribeLoggingOptions Source #
See: newDescribeLoggingOptions
smart constructor.
Instances
newDescribeLoggingOptions :: DescribeLoggingOptions Source #
Create a value of DescribeLoggingOptions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DescribeLoggingOptionsResponse Source #
See: newDescribeLoggingOptionsResponse
smart constructor.
Instances
Generic DescribeLoggingOptionsResponse Source # | |
Read DescribeLoggingOptionsResponse Source # | |
Show DescribeLoggingOptionsResponse Source # | |
Defined in Amazonka.IoTEvents.DescribeLoggingOptions | |
NFData DescribeLoggingOptionsResponse Source # | |
Defined in Amazonka.IoTEvents.DescribeLoggingOptions rnf :: DescribeLoggingOptionsResponse -> () # | |
Eq DescribeLoggingOptionsResponse Source # | |
type Rep DescribeLoggingOptionsResponse Source # | |
Defined in Amazonka.IoTEvents.DescribeLoggingOptions type Rep DescribeLoggingOptionsResponse = D1 ('MetaData "DescribeLoggingOptionsResponse" "Amazonka.IoTEvents.DescribeLoggingOptions" "amazonka-iotevents-2.0-6xKaLx5KciSK3LEs0FyRYn" 'False) (C1 ('MetaCons "DescribeLoggingOptionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "loggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoggingOptions)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDescribeLoggingOptionsResponse Source #
Create a value of DescribeLoggingOptionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:loggingOptions:DescribeLoggingOptionsResponse'
, describeLoggingOptionsResponse_loggingOptions
- The current settings of the AWS IoT Events logging options.
$sel:httpStatus:DescribeLoggingOptionsResponse'
, describeLoggingOptionsResponse_httpStatus
- The response's http status code.
GetDetectorModelAnalysisResults
data GetDetectorModelAnalysisResults Source #
See: newGetDetectorModelAnalysisResults
smart constructor.
Instances
newGetDetectorModelAnalysisResults Source #
Create a value of GetDetectorModelAnalysisResults
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:maxResults:GetDetectorModelAnalysisResults'
, getDetectorModelAnalysisResults_maxResults
- The maximum number of results to be returned per request.
GetDetectorModelAnalysisResults
, getDetectorModelAnalysisResults_nextToken
- The token that you can use to return the next set of results.
$sel:analysisId:GetDetectorModelAnalysisResults'
, getDetectorModelAnalysisResults_analysisId
- The ID of the analysis result that you want to retrieve.
data GetDetectorModelAnalysisResultsResponse Source #
See: newGetDetectorModelAnalysisResultsResponse
smart constructor.
Instances
newGetDetectorModelAnalysisResultsResponse Source #
Create a value of GetDetectorModelAnalysisResultsResponse
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:analysisResults:GetDetectorModelAnalysisResultsResponse'
, getDetectorModelAnalysisResultsResponse_analysisResults
- Contains information about one or more analysis results.
GetDetectorModelAnalysisResults
, getDetectorModelAnalysisResultsResponse_nextToken
- The token that you can use to return the next set of results, or null
if there are no more results.
$sel:httpStatus:GetDetectorModelAnalysisResultsResponse'
, getDetectorModelAnalysisResultsResponse_httpStatus
- The response's http status code.
ListAlarmModelVersions
data ListAlarmModelVersions Source #
See: newListAlarmModelVersions
smart constructor.
Instances
newListAlarmModelVersions Source #
Create a value of ListAlarmModelVersions
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:maxResults:ListAlarmModelVersions'
, listAlarmModelVersions_maxResults
- The maximum number of results to be returned per request.
ListAlarmModelVersions
, listAlarmModelVersions_nextToken
- The token that you can use to return the next set of results.
ListAlarmModelVersions
, listAlarmModelVersions_alarmModelName
- The name of the alarm model.
data ListAlarmModelVersionsResponse Source #
See: newListAlarmModelVersionsResponse
smart constructor.
Instances
newListAlarmModelVersionsResponse Source #
Create a value of ListAlarmModelVersionsResponse
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:alarmModelVersionSummaries:ListAlarmModelVersionsResponse'
, listAlarmModelVersionsResponse_alarmModelVersionSummaries
- A list that summarizes each alarm model version.
ListAlarmModelVersions
, listAlarmModelVersionsResponse_nextToken
- The token that you can use to return the next set of results, or null
if there are no more results.
$sel:httpStatus:ListAlarmModelVersionsResponse'
, listAlarmModelVersionsResponse_httpStatus
- The response's http status code.
ListAlarmModels
data ListAlarmModels Source #
See: newListAlarmModels
smart constructor.
Instances
newListAlarmModels :: ListAlarmModels Source #
Create a value of ListAlarmModels
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:maxResults:ListAlarmModels'
, listAlarmModels_maxResults
- The maximum number of results to be returned per request.
ListAlarmModels
, listAlarmModels_nextToken
- The token that you can use to return the next set of results.
data ListAlarmModelsResponse Source #
See: newListAlarmModelsResponse
smart constructor.
Instances
newListAlarmModelsResponse Source #
Create a value of ListAlarmModelsResponse
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:alarmModelSummaries:ListAlarmModelsResponse'
, listAlarmModelsResponse_alarmModelSummaries
- A list that summarizes each alarm model.
ListAlarmModels
, listAlarmModelsResponse_nextToken
- The token that you can use to return the next set of results, or null
if there are no more results.
$sel:httpStatus:ListAlarmModelsResponse'
, listAlarmModelsResponse_httpStatus
- The response's http status code.
ListDetectorModelVersions
data ListDetectorModelVersions Source #
See: newListDetectorModelVersions
smart constructor.
Instances
newListDetectorModelVersions Source #
Create a value of ListDetectorModelVersions
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:maxResults:ListDetectorModelVersions'
, listDetectorModelVersions_maxResults
- The maximum number of results to be returned per request.
ListDetectorModelVersions
, listDetectorModelVersions_nextToken
- The token that you can use to return the next set of results.
ListDetectorModelVersions
, listDetectorModelVersions_detectorModelName
- The name of the detector model whose versions are returned.
data ListDetectorModelVersionsResponse Source #
See: newListDetectorModelVersionsResponse
smart constructor.
Instances
newListDetectorModelVersionsResponse Source #
Create a value of ListDetectorModelVersionsResponse
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:detectorModelVersionSummaries:ListDetectorModelVersionsResponse'
, listDetectorModelVersionsResponse_detectorModelVersionSummaries
- Summary information about the detector model versions.
ListDetectorModelVersions
, listDetectorModelVersionsResponse_nextToken
- The token that you can use to return the next set of results, or null
if there are no more results.
$sel:httpStatus:ListDetectorModelVersionsResponse'
, listDetectorModelVersionsResponse_httpStatus
- The response's http status code.
ListDetectorModels
data ListDetectorModels Source #
See: newListDetectorModels
smart constructor.
Instances
newListDetectorModels :: ListDetectorModels Source #
Create a value of ListDetectorModels
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:maxResults:ListDetectorModels'
, listDetectorModels_maxResults
- The maximum number of results to be returned per request.
ListDetectorModels
, listDetectorModels_nextToken
- The token that you can use to return the next set of results.
data ListDetectorModelsResponse Source #
See: newListDetectorModelsResponse
smart constructor.
Instances
newListDetectorModelsResponse Source #
Create a value of ListDetectorModelsResponse
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:detectorModelSummaries:ListDetectorModelsResponse'
, listDetectorModelsResponse_detectorModelSummaries
- Summary information about the detector models.
ListDetectorModels
, listDetectorModelsResponse_nextToken
- The token that you can use to return the next set of results, or null
if there are no more results.
$sel:httpStatus:ListDetectorModelsResponse'
, listDetectorModelsResponse_httpStatus
- The response's http status code.
ListInputRoutings
data ListInputRoutings Source #
See: newListInputRoutings
smart constructor.
Instances
Create a value of ListInputRoutings
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:maxResults:ListInputRoutings'
, listInputRoutings_maxResults
- The maximum number of results to be returned per request.
ListInputRoutings
, listInputRoutings_nextToken
- The token that you can use to return the next set of results.
$sel:inputIdentifier:ListInputRoutings'
, listInputRoutings_inputIdentifier
- The identifer of the routed input.
data ListInputRoutingsResponse Source #
See: newListInputRoutingsResponse
smart constructor.
Instances
newListInputRoutingsResponse Source #
Create a value of ListInputRoutingsResponse
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:
ListInputRoutings
, listInputRoutingsResponse_nextToken
- The token that you can use to return the next set of results, or null
if there are no more results.
$sel:routedResources:ListInputRoutingsResponse'
, listInputRoutingsResponse_routedResources
- Summary information about the routed resources.
$sel:httpStatus:ListInputRoutingsResponse'
, listInputRoutingsResponse_httpStatus
- The response's http status code.
ListInputs
data ListInputs Source #
See: newListInputs
smart constructor.
ListInputs' (Maybe Natural) (Maybe Text) |
Instances
newListInputs :: ListInputs Source #
Create a value of ListInputs
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:maxResults:ListInputs'
, listInputs_maxResults
- The maximum number of results to be returned per request.
ListInputs
, listInputs_nextToken
- The token that you can use to return the next set of results.
data ListInputsResponse Source #
See: newListInputsResponse
smart constructor.
Instances
newListInputsResponse Source #
Create a value of ListInputsResponse
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:inputSummaries:ListInputsResponse'
, listInputsResponse_inputSummaries
- Summary information about the inputs.
ListInputs
, listInputsResponse_nextToken
- The token that you can use to return the next set of results, or null
if there are no more results.
$sel:httpStatus:ListInputsResponse'
, listInputsResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- The ARN of the resource.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- The list of tags assigned to the resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
PutLoggingOptions
data PutLoggingOptions Source #
See: newPutLoggingOptions
smart constructor.
Instances
Create a value of PutLoggingOptions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:loggingOptions:PutLoggingOptions'
, putLoggingOptions_loggingOptions
- The new values of the AWS IoT Events logging options.
data PutLoggingOptionsResponse Source #
See: newPutLoggingOptionsResponse
smart constructor.
Instances
Generic PutLoggingOptionsResponse Source # | |
Defined in Amazonka.IoTEvents.PutLoggingOptions type Rep PutLoggingOptionsResponse :: Type -> Type # | |
Read PutLoggingOptionsResponse Source # | |
Show PutLoggingOptionsResponse Source # | |
Defined in Amazonka.IoTEvents.PutLoggingOptions showsPrec :: Int -> PutLoggingOptionsResponse -> ShowS # show :: PutLoggingOptionsResponse -> String # showList :: [PutLoggingOptionsResponse] -> ShowS # | |
NFData PutLoggingOptionsResponse Source # | |
Defined in Amazonka.IoTEvents.PutLoggingOptions rnf :: PutLoggingOptionsResponse -> () # | |
Eq PutLoggingOptionsResponse Source # | |
type Rep PutLoggingOptionsResponse Source # | |
Defined in Amazonka.IoTEvents.PutLoggingOptions |
newPutLoggingOptionsResponse :: PutLoggingOptionsResponse Source #
Create a value of PutLoggingOptionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
StartDetectorModelAnalysis
data StartDetectorModelAnalysis Source #
See: newStartDetectorModelAnalysis
smart constructor.
Instances
newStartDetectorModelAnalysis Source #
Create a value of StartDetectorModelAnalysis
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:
StartDetectorModelAnalysis
, startDetectorModelAnalysis_detectorModelDefinition
- Undocumented member.
data StartDetectorModelAnalysisResponse Source #
See: newStartDetectorModelAnalysisResponse
smart constructor.
Instances
Generic StartDetectorModelAnalysisResponse Source # | |
Read StartDetectorModelAnalysisResponse Source # | |
Show StartDetectorModelAnalysisResponse Source # | |
NFData StartDetectorModelAnalysisResponse Source # | |
Defined in Amazonka.IoTEvents.StartDetectorModelAnalysis rnf :: StartDetectorModelAnalysisResponse -> () # | |
Eq StartDetectorModelAnalysisResponse Source # | |
type Rep StartDetectorModelAnalysisResponse Source # | |
Defined in Amazonka.IoTEvents.StartDetectorModelAnalysis type Rep StartDetectorModelAnalysisResponse = D1 ('MetaData "StartDetectorModelAnalysisResponse" "Amazonka.IoTEvents.StartDetectorModelAnalysis" "amazonka-iotevents-2.0-6xKaLx5KciSK3LEs0FyRYn" 'False) (C1 ('MetaCons "StartDetectorModelAnalysisResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "analysisId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newStartDetectorModelAnalysisResponse Source #
Create a value of StartDetectorModelAnalysisResponse
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:analysisId:StartDetectorModelAnalysisResponse'
, startDetectorModelAnalysisResponse_analysisId
- The ID that you can use to retrieve the analysis result.
$sel:httpStatus:StartDetectorModelAnalysisResponse'
, startDetectorModelAnalysisResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagResource'
, tagResource_resourceArn
- The ARN of the resource.
$sel:tags:TagResource'
, tagResource_tags
- The new or modified tags for the resource.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:UntagResource'
, untagResource_resourceArn
- The ARN of the resource.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- A list of the keys of the tags to be removed from the resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
UpdateAlarmModel
data UpdateAlarmModel Source #
See: newUpdateAlarmModel
smart constructor.
UpdateAlarmModel' (Maybe AlarmCapabilities) (Maybe AlarmEventActions) (Maybe Text) (Maybe AlarmNotification) (Maybe Natural) Text Text AlarmRule |
Instances
:: Text | |
-> Text | |
-> AlarmRule | |
-> UpdateAlarmModel |
Create a value of UpdateAlarmModel
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:alarmCapabilities:UpdateAlarmModel'
, updateAlarmModel_alarmCapabilities
- Contains the configuration information of alarm state changes.
$sel:alarmEventActions:UpdateAlarmModel'
, updateAlarmModel_alarmEventActions
- Contains information about one or more alarm actions.
UpdateAlarmModel
, updateAlarmModel_alarmModelDescription
- The description of the alarm model.
$sel:alarmNotification:UpdateAlarmModel'
, updateAlarmModel_alarmNotification
- Contains information about one or more notification actions.
$sel:severity:UpdateAlarmModel'
, updateAlarmModel_severity
- A non-negative integer that reflects the severity level of the alarm.
UpdateAlarmModel
, updateAlarmModel_alarmModelName
- The name of the alarm model.
UpdateAlarmModel
, updateAlarmModel_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.
$sel:alarmRule:UpdateAlarmModel'
, updateAlarmModel_alarmRule
- Defines when your alarm is invoked.
data UpdateAlarmModelResponse Source #
See: newUpdateAlarmModelResponse
smart constructor.
UpdateAlarmModelResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe AlarmModelVersionStatus) Int |
Instances
newUpdateAlarmModelResponse Source #
Create a value of UpdateAlarmModelResponse
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:
UpdateAlarmModelResponse
, updateAlarmModelResponse_alarmModelArn
- The ARN of the alarm model. For more information, see
Amazon Resource Names (ARNs)
in the AWS General Reference.
UpdateAlarmModelResponse
, updateAlarmModelResponse_alarmModelVersion
- The version of the alarm model.
UpdateAlarmModelResponse
, updateAlarmModelResponse_creationTime
- The time the alarm model was created, in the Unix epoch format.
UpdateAlarmModelResponse
, updateAlarmModelResponse_lastUpdateTime
- The time the alarm model was last updated, in the Unix epoch format.
UpdateAlarmModelResponse
, updateAlarmModelResponse_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:httpStatus:UpdateAlarmModelResponse'
, updateAlarmModelResponse_httpStatus
- The response's http status code.
UpdateDetectorModel
data UpdateDetectorModel Source #
See: newUpdateDetectorModel
smart constructor.
Instances
newUpdateDetectorModel Source #
Create a value of UpdateDetectorModel
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:
UpdateDetectorModel
, updateDetectorModel_detectorModelDescription
- A brief description of the detector model.
UpdateDetectorModel
, updateDetectorModel_evaluationMethod
- Information about the order in which events are evaluated and how
actions are executed.
UpdateDetectorModel
, updateDetectorModel_detectorModelName
- The name of the detector model that is updated.
UpdateDetectorModel
, updateDetectorModel_detectorModelDefinition
- Information that defines how a detector operates.
UpdateDetectorModel
, updateDetectorModel_roleArn
- The ARN of the role that grants permission to AWS IoT Events to perform
its operations.
data UpdateDetectorModelResponse Source #
See: newUpdateDetectorModelResponse
smart constructor.
Instances
newUpdateDetectorModelResponse Source #
Create a value of UpdateDetectorModelResponse
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:
UpdateDetectorModelResponse
, updateDetectorModelResponse_detectorModelConfiguration
- Information about how the detector model is configured.
$sel:httpStatus:UpdateDetectorModelResponse'
, updateDetectorModelResponse_httpStatus
- The response's http status code.
UpdateInput
data UpdateInput Source #
See: newUpdateInput
smart constructor.
Instances
Create a value of UpdateInput
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:
UpdateInput
, updateInput_inputDescription
- A brief description of the input.
UpdateInput
, updateInput_inputName
- The name of the input you want to update.
UpdateInput
, updateInput_inputDefinition
- The definition of the input.
data UpdateInputResponse Source #
See: newUpdateInputResponse
smart constructor.
Instances
newUpdateInputResponse Source #
Create a value of UpdateInputResponse
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:
UpdateInputResponse
, updateInputResponse_inputConfiguration
- Information about the configuration of the input.
$sel:httpStatus:UpdateInputResponse'
, updateInputResponse_httpStatus
- The response's http status code.
Types
AlarmModelVersionStatus
newtype AlarmModelVersionStatus Source #
Instances
AnalysisResultLevel
newtype AnalysisResultLevel Source #
pattern AnalysisResultLevel_ERROR :: AnalysisResultLevel | |
pattern AnalysisResultLevel_INFO :: AnalysisResultLevel | |
pattern AnalysisResultLevel_WARNING :: AnalysisResultLevel |
Instances
AnalysisStatus
newtype AnalysisStatus Source #
pattern AnalysisStatus_COMPLETE :: AnalysisStatus | |
pattern AnalysisStatus_FAILED :: AnalysisStatus | |
pattern AnalysisStatus_RUNNING :: AnalysisStatus |
Instances
ComparisonOperator
newtype ComparisonOperator Source #
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 #
Instances
EvaluationMethod
newtype EvaluationMethod Source #
pattern EvaluationMethod_BATCH :: EvaluationMethod | |
pattern EvaluationMethod_SERIAL :: EvaluationMethod |
Instances
InputStatus
newtype InputStatus Source #
pattern InputStatus_ACTIVE :: InputStatus | |
pattern InputStatus_CREATING :: InputStatus | |
pattern InputStatus_DELETING :: InputStatus | |
pattern InputStatus_UPDATING :: InputStatus |
Instances
LoggingLevel
newtype LoggingLevel Source #
pattern LoggingLevel_DEBUG :: LoggingLevel | |
pattern LoggingLevel_ERROR :: LoggingLevel | |
pattern LoggingLevel_INFO :: LoggingLevel |
Instances
PayloadType
newtype PayloadType Source #
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.
Instances
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.
Action
An action to be performed when the condition
is TRUE.
See: newAction
smart constructor.
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: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: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: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: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: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:iotTopicPublish:Action'
, action_iotTopicPublish
- Publishes an MQTT message with the given topic to the AWS IoT message
broker.
$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:resetTimer:Action'
, action_resetTimer
- Information needed to reset the timer.
$sel:setTimer:Action'
, action_setTimer
- Information needed to set the timer.
$sel:setVariable:Action'
, action_setVariable
- Sets a variable to a specified value.
$sel:sns:Action'
, action_sns
- Sends an Amazon SNS message.
$sel:sqs:Action'
, action_sqs
- 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.
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:dynamoDB:AlarmAction'
, alarmAction_dynamoDB
- Undocumented member.
$sel:dynamoDBv2:AlarmAction'
, alarmAction_dynamoDBv2
- Undocumented member.
$sel:firehose:AlarmAction'
, alarmAction_firehose
- Undocumented member.
$sel:iotEvents:AlarmAction'
, alarmAction_iotEvents
- Undocumented member.
$sel:iotSiteWise:AlarmAction'
, alarmAction_iotSiteWise
- Undocumented member.
$sel:iotTopicPublish:AlarmAction'
, alarmAction_iotTopicPublish
- Undocumented member.
$sel:lambda:AlarmAction'
, alarmAction_lambda
- Undocumented member.
$sel:sns:AlarmAction'
, alarmAction_sns
- Undocumented member.
$sel:sqs:AlarmAction'
, alarmAction_sqs
- Undocumented member.
AlarmCapabilities
data AlarmCapabilities Source #
Contains the configuration information of alarm state changes.
See: newAlarmCapabilities
smart constructor.
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.
AlarmEventActions
data AlarmEventActions Source #
Contains information about one or more alarm actions.
See: newAlarmEventActions
smart constructor.
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.
AlarmModelSummary
data AlarmModelSummary Source #
Contains a summary of an alarm model.
See: newAlarmModelSummary
smart constructor.
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:alarmModelDescription:AlarmModelSummary'
, alarmModelSummary_alarmModelDescription
- The description of the alarm model.
$sel:alarmModelName:AlarmModelSummary'
, alarmModelSummary_alarmModelName
- The name of the alarm model.
$sel:creationTime:AlarmModelSummary'
, alarmModelSummary_creationTime
- The time the alarm model was created, in the Unix epoch format.
AlarmModelVersionSummary
data AlarmModelVersionSummary Source #
Contains a summary of an alarm model version.
See: newAlarmModelVersionSummary
smart constructor.
AlarmModelVersionSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe AlarmModelVersionStatus) (Maybe Text) |
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:alarmModelArn:AlarmModelVersionSummary'
, alarmModelVersionSummary_alarmModelArn
- The ARN of the alarm model. For more information, see
Amazon Resource Names (ARNs)
in the AWS General Reference.
$sel:alarmModelName:AlarmModelVersionSummary'
, alarmModelVersionSummary_alarmModelName
- The name of the alarm model.
$sel:alarmModelVersion:AlarmModelVersionSummary'
, alarmModelVersionSummary_alarmModelVersion
- The version of the alarm model.
$sel:creationTime:AlarmModelVersionSummary'
, alarmModelVersionSummary_creationTime
- The time the alarm model was created, in the Unix epoch format.
$sel:lastUpdateTime:AlarmModelVersionSummary'
, alarmModelVersionSummary_lastUpdateTime
- The time the alarm model was last updated, in the Unix epoch format.
$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.
$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:statusMessage:AlarmModelVersionSummary'
, alarmModelVersionSummary_statusMessage
- Contains information about the status of the alarm model version.
AlarmNotification
data AlarmNotification Source #
Contains information about one or more notification actions.
See: newAlarmNotification
smart constructor.
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.
AlarmRule
Defines when your alarm is invoked.
See: newAlarmRule
smart constructor.
Instances
FromJSON AlarmRule Source # | |
ToJSON AlarmRule Source # | |
Defined in Amazonka.IoTEvents.Types.AlarmRule | |
Generic AlarmRule Source # | |
Read AlarmRule Source # | |
Show AlarmRule Source # | |
NFData AlarmRule Source # | |
Defined in Amazonka.IoTEvents.Types.AlarmRule | |
Eq AlarmRule Source # | |
Hashable AlarmRule Source # | |
Defined in Amazonka.IoTEvents.Types.AlarmRule | |
type Rep AlarmRule Source # | |
Defined in Amazonka.IoTEvents.Types.AlarmRule type Rep AlarmRule = D1 ('MetaData "AlarmRule" "Amazonka.IoTEvents.Types.AlarmRule" "amazonka-iotevents-2.0-6xKaLx5KciSK3LEs0FyRYn" '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.
AnalysisResult
data AnalysisResult Source #
Contains the result of the analysis.
See: newAnalysisResult
smart constructor.
AnalysisResult' (Maybe AnalysisResultLevel) (Maybe [AnalysisResultLocation]) (Maybe Text) (Maybe Text) |
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: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.
$sel:message:AnalysisResult'
, analysisResult_message
- Contains additional information about the analysis result.
$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.
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.
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.
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
timeInSeconds
parameter can be'1586400675'
. - For references, you must specify either variables or input values.
For example, the value for the
offsetInNanos
parameter 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
timeInSeconds
parameter 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.
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.
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
quality
parameter can be'GOOD'
. - For references, you must specify either variables or input values.
For example, the value for the
quality
parameter can be$input.TemperatureInput.sensorData.quality
.
For more information, see Expressions in the AWS IoT Events Developer Guide.
See: newAssetPropertyValue
smart constructor.
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: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.
$sel:value:AssetPropertyValue'
, assetPropertyValue_value
- The value to send to an asset property.
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
integerValue
parameter can be'100'
. - For references, you must specify either variables or parameters. For
example, the value for the
booleanValue
parameter 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
doubleValue
parameter 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.
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: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.
$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: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:stringValue:AssetPropertyVariant'
, assetPropertyVariant_stringValue
- The asset property value is a string. You must use an expression, and
the evaluated result should be a string.
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.
Instances
FromJSON Attribute Source # | |
ToJSON Attribute Source # | |
Defined in Amazonka.IoTEvents.Types.Attribute | |
Generic Attribute Source # | |
Read Attribute Source # | |
Show Attribute Source # | |
NFData Attribute Source # | |
Defined in Amazonka.IoTEvents.Types.Attribute | |
Eq Attribute Source # | |
Hashable Attribute Source # | |
Defined in Amazonka.IoTEvents.Types.Attribute | |
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>...
ClearTimerAction
data ClearTimerAction Source #
Information needed to clear the timer.
See: newClearTimerAction
smart constructor.
Instances
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.
DetectorDebugOption
data DetectorDebugOption Source #
The detector model and the specific detectors (instances) for which the logging level is given.
See: newDetectorDebugOption
smart constructor.
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.
DetectorModel
data DetectorModel Source #
Information about the detector model.
See: newDetectorModel
smart constructor.
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.
DetectorModelConfiguration
data DetectorModelConfiguration Source #
Information about how the detector model is configured.
See: newDetectorModelConfiguration
smart constructor.
DetectorModelConfiguration' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe EvaluationMethod) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe DetectorModelVersionStatus) |
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:detectorModelArn:DetectorModelConfiguration'
, detectorModelConfiguration_detectorModelArn
- The ARN of the detector model.
$sel:detectorModelDescription:DetectorModelConfiguration'
, detectorModelConfiguration_detectorModelDescription
- A brief description of the detector model.
$sel:detectorModelName:DetectorModelConfiguration'
, detectorModelConfiguration_detectorModelName
- The name of the detector model.
$sel:detectorModelVersion:DetectorModelConfiguration'
, detectorModelConfiguration_detectorModelVersion
- The version of the detector model.
$sel:evaluationMethod:DetectorModelConfiguration'
, detectorModelConfiguration_evaluationMethod
- Information about the order in which events are evaluated and how
actions are executed.
$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:lastUpdateTime:DetectorModelConfiguration'
, detectorModelConfiguration_lastUpdateTime
- The time the detector model was last updated.
$sel:roleArn:DetectorModelConfiguration'
, detectorModelConfiguration_roleArn
- The ARN of the role that grants permission to AWS IoT Events to perform
its operations.
$sel:status:DetectorModelConfiguration'
, detectorModelConfiguration_status
- The status of the detector model.
DetectorModelDefinition
data DetectorModelDefinition Source #
Information that defines how a detector operates.
See: newDetectorModelDefinition
smart constructor.
Instances
newDetectorModelDefinition Source #
:: 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).
DetectorModelSummary
data DetectorModelSummary Source #
Information about the detector model.
See: newDetectorModelSummary
smart constructor.
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:detectorModelDescription:DetectorModelSummary'
, detectorModelSummary_detectorModelDescription
- A brief description of the detector model.
$sel:detectorModelName:DetectorModelSummary'
, detectorModelSummary_detectorModelName
- The name of the detector model.
DetectorModelVersionSummary
data DetectorModelVersionSummary Source #
Information about the detector model version.
See: newDetectorModelVersionSummary
smart constructor.
DetectorModelVersionSummary' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe EvaluationMethod) (Maybe POSIX) (Maybe Text) (Maybe DetectorModelVersionStatus) |
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:detectorModelArn:DetectorModelVersionSummary'
, detectorModelVersionSummary_detectorModelArn
- The ARN of the detector model version.
$sel:detectorModelName:DetectorModelVersionSummary'
, detectorModelVersionSummary_detectorModelName
- The name of the detector model.
$sel:detectorModelVersion:DetectorModelVersionSummary'
, detectorModelVersionSummary_detectorModelVersion
- The ID of the detector model version.
$sel:evaluationMethod:DetectorModelVersionSummary'
, detectorModelVersionSummary_evaluationMethod
- Information about the order in which events are evaluated and how
actions are executed.
$sel:lastUpdateTime:DetectorModelVersionSummary'
, detectorModelVersionSummary_lastUpdateTime
- The last time the detector model version was updated.
$sel:roleArn:DetectorModelVersionSummary'
, detectorModelVersionSummary_roleArn
- The ARN of the role that grants the detector model permission to perform
its tasks.
$sel:status:DetectorModelVersionSummary'
, detectorModelVersionSummary_status
- The status of the detector model version.
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
hashKeyType
parameter can be'STRING'
. - For references, you must specify either variables or input values.
For example, the value for the
hashKeyField
parameter 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
hashKeyValue
parameter 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
tableName
parameter 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.
DynamoDBAction' (Maybe Text) (Maybe Text) (Maybe Payload) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text Text Text |
Instances
:: 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: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: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: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.
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
tableName
parameter can be'GreenhouseTemperatureTable'
. - For references, you must specify either variables or input values.
For example, the value for the
tableName
parameter 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
contentExpression
parameter inPayload
uses 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
tableName
parameter 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.
Instances
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.
EmailConfiguration
data EmailConfiguration Source #
Contains the configuration information of email notifications.
See: newEmailConfiguration
smart constructor.
Instances
newEmailConfiguration Source #
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.
EmailContent
data EmailContent Source #
Contains the subject and message of an email.
See: newEmailContent
smart constructor.
EmailContent' (Maybe Text) (Maybe Text) |
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:additionalMessage:EmailContent'
, emailContent_additionalMessage
- The message that you want to send. The message can be up to 200
characters.
$sel:subject:EmailContent'
, emailContent_subject
- The subject of the email.
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.
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.
Event
Specifies the actions
to be performed when the condition
evaluates
to TRUE.
See: newEvent
smart constructor.
Instances
FromJSON Event Source # | |
ToJSON Event Source # | |
Defined in Amazonka.IoTEvents.Types.Event | |
Generic Event Source # | |
Read Event Source # | |
Show Event Source # | |
NFData Event Source # | |
Defined in Amazonka.IoTEvents.Types.Event | |
Eq Event Source # | |
Hashable Event Source # | |
Defined in Amazonka.IoTEvents.Types.Event | |
type Rep Event Source # | |
Defined in Amazonka.IoTEvents.Types.Event type Rep Event = D1 ('MetaData "Event" "Amazonka.IoTEvents.Types.Event" "amazonka-iotevents-2.0-6xKaLx5KciSK3LEs0FyRYn" '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.
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.
Instances
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:payload:FirehoseAction'
, firehoseAction_payload
- You can configure the action payload when you send a message to an
Amazon Kinesis Data Firehose delivery stream.
$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:deliveryStreamName:FirehoseAction'
, firehoseAction_deliveryStreamName
- 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.
Instances
newInitializationConfiguration Source #
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
.
Input
Information about the input.
See: newInput
smart constructor.
Instances
FromJSON Input Source # | |
Generic Input Source # | |
Read Input Source # | |
Show Input Source # | |
NFData Input Source # | |
Defined in Amazonka.IoTEvents.Types.Input | |
Eq Input Source # | |
Hashable Input Source # | |
Defined in Amazonka.IoTEvents.Types.Input | |
type Rep Input Source # | |
Defined in Amazonka.IoTEvents.Types.Input type Rep Input = D1 ('MetaData "Input" "Amazonka.IoTEvents.Types.Input" "amazonka-iotevents-2.0-6xKaLx5KciSK3LEs0FyRYn" 'False) (C1 ('MetaCons "Input'" 'PrefixI 'True) (S1 ('MetaSel ('Just "inputConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputConfiguration)) :*: S1 ('MetaSel ('Just "inputDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputDefinition)))) |
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:inputConfiguration:Input'
, input_inputConfiguration
- Information about the configuration of an input.
$sel:inputDefinition:Input'
, input_inputDefinition
- The definition of the input.
InputConfiguration
data InputConfiguration Source #
Information about the configuration of an input.
See: newInputConfiguration
smart constructor.
Instances
newInputConfiguration Source #
:: 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.
InputDefinition
data InputDefinition Source #
The definition of the input.
See: newInputDefinition
smart constructor.
Instances
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.
InputIdentifier
data InputIdentifier Source #
The identifer of the input.
See: newInputIdentifier
smart constructor.
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:iotEventsInputIdentifier:InputIdentifier'
, inputIdentifier_iotEventsInputIdentifier
- The identifier of the input routed to AWS IoT Events.
$sel:iotSiteWiseInputIdentifier:InputIdentifier'
, inputIdentifier_iotSiteWiseInputIdentifier
- The identifer of the input routed from AWS IoT SiteWise.
InputSummary
data InputSummary Source #
Information about the input.
See: newInputSummary
smart constructor.
InputSummary' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe InputStatus) |
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:inputArn:InputSummary'
, inputSummary_inputArn
- The ARN of the input.
$sel:inputDescription:InputSummary'
, inputSummary_inputDescription
- A brief description of the input.
$sel:inputName:InputSummary'
, inputSummary_inputName
- The name of the input.
$sel:lastUpdateTime:InputSummary'
, inputSummary_lastUpdateTime
- The last time the input was updated.
$sel:status:InputSummary'
, inputSummary_status
- The status of the input.
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.
Instances
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.
IotEventsInputIdentifier
data IotEventsInputIdentifier Source #
The identifier of the input routed to AWS IoT Events.
See: newIotEventsInputIdentifier
smart constructor.
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.
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
propertyAlias
parameter can be'/company/windfarm/3/turbine/7/temperature'
. - For references, you must specify either variables or input values.
For example, the value for the
assetId
parameter 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
propertyAlias
parameter 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.
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:assetId:IotSiteWiseAction'
, iotSiteWiseAction_assetId
- The ID of the asset that has the specified property.
$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:propertyId:IotSiteWiseAction'
, iotSiteWiseAction_propertyId
- The ID 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.
IotSiteWiseAssetModelPropertyIdentifier
data IotSiteWiseAssetModelPropertyIdentifier Source #
The asset model property identifer of the input routed from AWS IoT SiteWise.
See: newIotSiteWiseAssetModelPropertyIdentifier
smart constructor.
Instances
newIotSiteWiseAssetModelPropertyIdentifier Source #
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.
IotSiteWiseInputIdentifier
data IotSiteWiseInputIdentifier Source #
The identifer of the input routed from AWS IoT SiteWise.
See: newIotSiteWiseInputIdentifier
smart constructor.
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.
IotTopicPublishAction
data IotTopicPublishAction Source #
Information required to publish the MQTT message through the AWS IoT message broker.
See: newIotTopicPublishAction
smart constructor.
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.
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.
Instances
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.
LoggingOptions
data LoggingOptions Source #
The values of the AWS IoT Events logging options.
See: newLoggingOptions
smart constructor.
Instances
:: 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.
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.
NotificationAction' (Maybe (NonEmpty EmailConfiguration)) (Maybe (NonEmpty SMSConfiguration)) NotificationTargetActions |
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.
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.
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.
OnEnterLifecycle
data OnEnterLifecycle Source #
When entering this state, perform these actions
if the condition
is
TRUE.
See: newOnEnterLifecycle
smart constructor.
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
.
OnExitLifecycle
data OnExitLifecycle Source #
When exiting this state, perform these actions
if the specified
condition
is TRUE
.
See: newOnExitLifecycle
smart constructor.
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
.
OnInputLifecycle
data OnInputLifecycle Source #
Specifies the actions performed when the condition
evaluates to TRUE.
See: newOnInputLifecycle
smart constructor.
OnInputLifecycle' (Maybe [Event]) (Maybe [TransitionEvent]) |
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.
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.
Instances
FromJSON Payload Source # | |
ToJSON Payload Source # | |
Defined in Amazonka.IoTEvents.Types.Payload | |
Generic Payload Source # | |
Read Payload Source # | |
Show Payload Source # | |
NFData Payload Source # | |
Defined in Amazonka.IoTEvents.Types.Payload | |
Eq Payload Source # | |
Hashable Payload Source # | |
Defined in Amazonka.IoTEvents.Types.Payload | |
type Rep Payload Source # | |
Defined in Amazonka.IoTEvents.Types.Payload type Rep Payload = D1 ('MetaData "Payload" "Amazonka.IoTEvents.Types.Payload" "amazonka-iotevents-2.0-6xKaLx5KciSK3LEs0FyRYn" 'False) (C1 ('MetaCons "Payload'" 'PrefixI 'True) (S1 ('MetaSel ('Just "contentExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PayloadType))) |
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
.
RecipientDetail
data RecipientDetail Source #
The information that identifies the recipient.
See: newRecipientDetail
smart constructor.
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.
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.
Instances
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.
RoutedResource
data RoutedResource Source #
Contains information about the routed resource.
See: newRoutedResource
smart constructor.
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.
SMSConfiguration
data SMSConfiguration Source #
Contains the configuration information of SMS notifications.
See: newSMSConfiguration
smart constructor.
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.
SNSTopicPublishAction
data SNSTopicPublishAction Source #
Information required to publish the Amazon SNS message.
See: newSNSTopicPublishAction
smart constructor.
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.
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.
Instances
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.
SetTimerAction
data SetTimerAction Source #
Information needed to set the timer.
See: newSetTimerAction
smart constructor.
Instances
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.
SetVariableAction
data SetVariableAction Source #
Information about the variable and its new value.
See: newSetVariableAction
smart constructor.
Instances
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.
SimpleRule
data SimpleRule Source #
A rule that compares an input property value to a threshold value with a comparison operator.
See: newSimpleRule
smart constructor.
Instances
:: 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.
SqsAction
Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
See: newSqsAction
smart constructor.
Instances
FromJSON SqsAction Source # | |
ToJSON SqsAction Source # | |
Defined in Amazonka.IoTEvents.Types.SqsAction | |
Generic SqsAction Source # | |
Read SqsAction Source # | |
Show SqsAction Source # | |
NFData SqsAction Source # | |
Defined in Amazonka.IoTEvents.Types.SqsAction | |
Eq SqsAction Source # | |
Hashable SqsAction Source # | |
Defined in Amazonka.IoTEvents.Types.SqsAction | |
type Rep SqsAction Source # | |
Defined in Amazonka.IoTEvents.Types.SqsAction type Rep SqsAction = D1 ('MetaData "SqsAction" "Amazonka.IoTEvents.Types.SqsAction" "amazonka-iotevents-2.0-6xKaLx5KciSK3LEs0FyRYn" '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.
State
Information that defines a state of a detector.
See: newState
smart constructor.
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:onExit:State'
, state_onExit
- When exiting this state, perform these actions
if the specified
condition
is TRUE
.
$sel:onInput:State'
, state_onInput
- When an input is received and the condition
is TRUE, perform the
specified actions
.
$sel:stateName:State'
, state_stateName
- The name of the state.
Tag
Metadata that can be used to manage the resource.
See: newTag
smart constructor.
Instances
FromJSON Tag Source # | |
ToJSON Tag Source # | |
Defined in Amazonka.IoTEvents.Types.Tag | |
Generic Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.IoTEvents.Types.Tag | |
Eq Tag Source # | |
Hashable Tag Source # | |
Defined in Amazonka.IoTEvents.Types.Tag | |
type Rep Tag Source # | |
Defined in Amazonka.IoTEvents.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.IoTEvents.Types.Tag" "amazonka-iotevents-2.0-6xKaLx5KciSK3LEs0FyRYn" '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.
Instances
:: 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.