Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoTEvents.Types.Action

Description

Synopsis

data Action = Action' {
- iotTopicPublish :: Maybe IotTopicPublishAction
- dynamoDBv2 :: Maybe DynamoDBv2Action
- resetTimer :: Maybe ResetTimerAction
- setTimer :: Maybe SetTimerAction
- sns :: Maybe SNSTopicPublishAction
- clearTimer :: Maybe ClearTimerAction
- dynamoDB :: Maybe DynamoDBAction
- firehose :: Maybe FirehoseAction
- iotSiteWise :: Maybe IotSiteWiseAction
- setVariable :: Maybe SetVariableAction
- lambda :: Maybe LambdaAction
- iotEvents :: Maybe IotEventsAction
- sqs :: Maybe SqsAction
}
newAction :: Action
action_iotTopicPublish :: Lens' Action (Maybe IotTopicPublishAction)
action_dynamoDBv2 :: Lens' Action (Maybe DynamoDBv2Action)
action_resetTimer :: Lens' Action (Maybe ResetTimerAction)
action_setTimer :: Lens' Action (Maybe SetTimerAction)
action_sns :: Lens' Action (Maybe SNSTopicPublishAction)
action_clearTimer :: Lens' Action (Maybe ClearTimerAction)
action_dynamoDB :: Lens' Action (Maybe DynamoDBAction)
action_firehose :: Lens' Action (Maybe FirehoseAction)
action_iotSiteWise :: Lens' Action (Maybe IotSiteWiseAction)
action_setVariable :: Lens' Action (Maybe SetVariableAction)
action_lambda :: Lens' Action (Maybe LambdaAction)
action_iotEvents :: Lens' Action (Maybe IotEventsAction)
action_sqs :: Lens' Action (Maybe SqsAction)

Documentation

data Action Source #

An action to be performed when the condition is TRUE.

See: newAction smart constructor.

Constructors

Action'

Fields

iotTopicPublish :: Maybe IotTopicPublishAction
Publishes an MQTT message with the given topic to the AWS IoT message broker.
dynamoDBv2 :: Maybe DynamoDBv2Action
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.
resetTimer :: Maybe ResetTimerAction
Information needed to reset the timer.
setTimer :: Maybe SetTimerAction
Information needed to set the timer.
sns :: Maybe SNSTopicPublishAction
Sends an Amazon SNS message.
clearTimer :: Maybe ClearTimerAction
Information needed to clear the timer.
dynamoDB :: Maybe DynamoDBAction
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.
firehose :: Maybe FirehoseAction
Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
iotSiteWise :: Maybe IotSiteWiseAction
Sends information about the detector model instance and the event that triggered the action to an asset property in AWS IoT SiteWise .
setVariable :: Maybe SetVariableAction
Sets a variable to a specified value.
lambda :: Maybe LambdaAction
Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
iotEvents :: Maybe IotEventsAction
Sends AWS IoT Events input, which passes information about the detector model instance and the event that triggered the action.
sqs :: Maybe SqsAction
Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.

Instances

Instances details

Eq Action Source #
Instance details Defined in Amazonka.IoTEvents.Types.Action Methods (==) :: Action -> Action -> Bool # (/=) :: Action -> Action -> Bool #
Read Action Source #
Instance details Defined in Amazonka.IoTEvents.Types.Action Methods readsPrec :: Int -> ReadS Action # readList :: ReadS [Action] # readPrec :: ReadPrec Action # readListPrec :: ReadPrec [Action] #
Show Action Source #
Instance details Defined in Amazonka.IoTEvents.Types.Action Methods showsPrec :: Int -> Action -> ShowS # show :: Action -> String # showList :: [Action] -> ShowS #
Generic Action Source #
Instance details Defined in Amazonka.IoTEvents.Types.Action Associated Types type Rep Action :: Type -> Type # Methods from :: Action -> Rep Action x # to :: Rep Action x -> Action #
NFData Action Source #
Instance details Defined in Amazonka.IoTEvents.Types.Action Methods rnf :: Action -> () #
Hashable Action Source #
Instance details Defined in Amazonka.IoTEvents.Types.Action Methods hashWithSalt :: Int -> Action -> Int # hash :: Action -> Int #
ToJSON Action Source #
Instance details Defined in Amazonka.IoTEvents.Types.Action Methods toJSON :: Action -> Value # toEncoding :: Action -> Encoding # toJSONList :: [Action] -> Value # toEncodingList :: [Action] -> Encoding #
FromJSON Action Source #
Instance details Defined in Amazonka.IoTEvents.Types.Action Methods parseJSON :: Value -> Parser Action # parseJSONList :: Value -> Parser [Action] #
type Rep Action Source #
Instance details Defined in Amazonka.IoTEvents.Types.Action type Rep Action = D1 ('MetaData "Action" "Amazonka.IoTEvents.Types.Action" "libZSservicesZSamazonka-ioteventsZSamazonka-iotevents" 'False) (C1 ('MetaCons "Action'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "iotTopicPublish") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IotTopicPublishAction)) :: (S1 ('MetaSel ('Just "dynamoDBv2") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DynamoDBv2Action)) :: S1 ('MetaSel ('Just "resetTimer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResetTimerAction)))) :: (S1 ('MetaSel ('Just "setTimer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SetTimerAction)) :: (S1 ('MetaSel ('Just "sns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SNSTopicPublishAction)) :: S1 ('MetaSel ('Just "clearTimer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClearTimerAction))))) :: ((S1 ('MetaSel ('Just "dynamoDB") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DynamoDBAction)) :: (S1 ('MetaSel ('Just "firehose") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FirehoseAction)) :: S1 ('MetaSel ('Just "iotSiteWise") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IotSiteWiseAction)))) :: ((S1 ('MetaSel ('Just "setVariable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SetVariableAction)) :: S1 ('MetaSel ('Just "lambda") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LambdaAction))) :: (S1 ('MetaSel ('Just "iotEvents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IotEventsAction)) :: S1 ('MetaSel ('Just "sqs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SqsAction)))))))

newAction :: Action Source #

Create a value of Action with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:iotTopicPublish:Action', action_iotTopicPublish - Publishes an MQTT message with the given topic to the AWS IoT message broker.

$sel:dynamoDBv2:Action', action_dynamoDBv2 - Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the payload. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide.

$sel:resetTimer:Action', action_resetTimer - Information needed to reset the timer.

$sel:setTimer:Action', action_setTimer - Information needed to set the timer.

$sel:sns:Action', action_sns - Sends an Amazon SNS message.

$sel:clearTimer:Action', action_clearTimer - Information needed to clear the timer.

$sel:dynamoDB:Action', action_dynamoDB - Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide.

$sel:firehose:Action', action_firehose - Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.

$sel:iotSiteWise:Action', action_iotSiteWise - Sends information about the detector model instance and the event that triggered the action to an asset property in AWS IoT SiteWise .

$sel:setVariable:Action', action_setVariable - Sets a variable to a specified value.

$sel:lambda:Action', action_lambda - Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.

$sel:iotEvents:Action', action_iotEvents - Sends AWS IoT Events input, which passes information about the detector model instance and the event that triggered the action.

$sel:sqs:Action', action_sqs - Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.

action_iotTopicPublish :: Lens' Action (Maybe IotTopicPublishAction) Source #

Publishes an MQTT message with the given topic to the AWS IoT message broker.

action_dynamoDBv2 :: Lens' Action (Maybe DynamoDBv2Action) Source #

Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the payload. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide.

action_resetTimer :: Lens' Action (Maybe ResetTimerAction) Source #

Information needed to reset the timer.

action_setTimer :: Lens' Action (Maybe SetTimerAction) Source #

Information needed to set the timer.

action_sns :: Lens' Action (Maybe SNSTopicPublishAction) Source #

Sends an Amazon SNS message.

action_clearTimer :: Lens' Action (Maybe ClearTimerAction) Source #

Information needed to clear the timer.

action_dynamoDB :: Lens' Action (Maybe DynamoDBAction) Source #

Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide.

action_firehose :: Lens' Action (Maybe FirehoseAction) Source #

Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.

action_iotSiteWise :: Lens' Action (Maybe IotSiteWiseAction) Source #

Sends information about the detector model instance and the event that triggered the action to an asset property in AWS IoT SiteWise .

action_setVariable :: Lens' Action (Maybe SetVariableAction) Source #

Sets a variable to a specified value.

action_lambda :: Lens' Action (Maybe LambdaAction) Source #

Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.

action_iotEvents :: Lens' Action (Maybe IotEventsAction) Source #

Sends AWS IoT Events input, which passes information about the detector model instance and the event that triggered the action.

action_sqs :: Lens' Action (Maybe SqsAction) Source #

Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.