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

Amazonka.IoT.Types.Action

Description

Synopsis

data Action = Action' {
- cloudwatchAlarm :: Maybe CloudwatchAlarmAction
- cloudwatchLogs :: Maybe CloudwatchLogsAction
- cloudwatchMetric :: Maybe CloudwatchMetricAction
- dynamoDB :: Maybe DynamoDBAction
- dynamoDBv2 :: Maybe DynamoDBv2Action
- elasticsearch :: Maybe ElasticsearchAction
- firehose :: Maybe FirehoseAction
- http :: Maybe HttpAction
- iotAnalytics :: Maybe IotAnalyticsAction
- iotEvents :: Maybe IotEventsAction
- iotSiteWise :: Maybe IotSiteWiseAction
- kafka :: Maybe KafkaAction
- kinesis :: Maybe KinesisAction
- lambda :: Maybe LambdaAction
- location :: Maybe LocationAction
- openSearch :: Maybe OpenSearchAction
- republish :: Maybe RepublishAction
- s3 :: Maybe S3Action
- salesforce :: Maybe SalesforceAction
- sns :: Maybe SnsAction
- sqs :: Maybe SqsAction
- stepFunctions :: Maybe StepFunctionsAction
- timestream :: Maybe TimestreamAction
}
newAction :: Action
action_cloudwatchAlarm :: Lens' Action (Maybe CloudwatchAlarmAction)
action_cloudwatchLogs :: Lens' Action (Maybe CloudwatchLogsAction)
action_cloudwatchMetric :: Lens' Action (Maybe CloudwatchMetricAction)
action_dynamoDB :: Lens' Action (Maybe DynamoDBAction)
action_dynamoDBv2 :: Lens' Action (Maybe DynamoDBv2Action)
action_elasticsearch :: Lens' Action (Maybe ElasticsearchAction)
action_firehose :: Lens' Action (Maybe FirehoseAction)
action_http :: Lens' Action (Maybe HttpAction)
action_iotAnalytics :: Lens' Action (Maybe IotAnalyticsAction)
action_iotEvents :: Lens' Action (Maybe IotEventsAction)
action_iotSiteWise :: Lens' Action (Maybe IotSiteWiseAction)
action_kafka :: Lens' Action (Maybe KafkaAction)
action_kinesis :: Lens' Action (Maybe KinesisAction)
action_lambda :: Lens' Action (Maybe LambdaAction)
action_location :: Lens' Action (Maybe LocationAction)
action_openSearch :: Lens' Action (Maybe OpenSearchAction)
action_republish :: Lens' Action (Maybe RepublishAction)
action_s3 :: Lens' Action (Maybe S3Action)
action_salesforce :: Lens' Action (Maybe SalesforceAction)
action_sns :: Lens' Action (Maybe SnsAction)
action_sqs :: Lens' Action (Maybe SqsAction)
action_stepFunctions :: Lens' Action (Maybe StepFunctionsAction)
action_timestream :: Lens' Action (Maybe TimestreamAction)

Documentation

data Action Source #

Describes the actions associated with a rule.

See: newAction smart constructor.

Constructors

Action'

Fields

cloudwatchAlarm :: Maybe CloudwatchAlarmAction
Change the state of a CloudWatch alarm.
cloudwatchLogs :: Maybe CloudwatchLogsAction
Send data to CloudWatch Logs.
cloudwatchMetric :: Maybe CloudwatchMetricAction
Capture a CloudWatch metric.
dynamoDB :: Maybe DynamoDBAction
Write to a DynamoDB table.
dynamoDBv2 :: Maybe DynamoDBv2Action
Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column.
elasticsearch :: Maybe ElasticsearchAction
Write data to an Amazon OpenSearch Service domain.
The Elasticsearch action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use the OpenSearch rule action instead. For more information, see OpenSearchAction.
firehose :: Maybe FirehoseAction
Write to an Amazon Kinesis Firehose stream.
http :: Maybe HttpAction
Send data to an HTTPS endpoint.
iotAnalytics :: Maybe IotAnalyticsAction
Sends message data to an IoT Analytics channel.
iotEvents :: Maybe IotEventsAction
Sends an input to an IoT Events detector.
iotSiteWise :: Maybe IotSiteWiseAction
Sends data from the MQTT message that triggered the rule to IoT SiteWise asset properties.
kafka :: Maybe KafkaAction
Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
kinesis :: Maybe KinesisAction
Write data to an Amazon Kinesis stream.
lambda :: Maybe LambdaAction
Invoke a Lambda function.
location :: Maybe LocationAction
The Amazon Location Service rule action sends device location updates from an MQTT message to an Amazon Location tracker resource.
openSearch :: Maybe OpenSearchAction
Write data to an Amazon OpenSearch Service domain.
republish :: Maybe RepublishAction
Publish to another MQTT topic.
s3 :: Maybe S3Action
Write to an Amazon S3 bucket.
salesforce :: Maybe SalesforceAction
Send a message to a Salesforce IoT Cloud Input Stream.
sns :: Maybe SnsAction
Publish to an Amazon SNS topic.
sqs :: Maybe SqsAction
Publish to an Amazon SQS queue.
stepFunctions :: Maybe StepFunctionsAction
Starts execution of a Step Functions state machine.
timestream :: Maybe TimestreamAction
The Timestream rule action writes attributes (measures) from an MQTT message into an Amazon Timestream table. For more information, see the Timestream topic rule action documentation.

Instances

Instances details

FromJSON Action Source #
Instance details Defined in Amazonka.IoT.Types.Action Methods parseJSON :: Value -> Parser Action # parseJSONList :: Value -> Parser [Action] #
ToJSON Action Source #
Instance details Defined in Amazonka.IoT.Types.Action Methods toJSON :: Action -> Value # toEncoding :: Action -> Encoding # toJSONList :: [Action] -> Value # toEncodingList :: [Action] -> Encoding #
Generic Action Source #
Instance details Defined in Amazonka.IoT.Types.Action Associated Types type Rep Action :: Type -> Type # Methods from :: Action -> Rep Action x # to :: Rep Action x -> Action #
Read Action Source #
Instance details Defined in Amazonka.IoT.Types.Action Methods readsPrec :: Int -> ReadS Action # readList :: ReadS [Action] # readPrec :: ReadPrec Action # readListPrec :: ReadPrec [Action] #
Show Action Source #
Instance details Defined in Amazonka.IoT.Types.Action Methods showsPrec :: Int -> Action -> ShowS # show :: Action -> String # showList :: [Action] -> ShowS #
NFData Action Source #
Instance details Defined in Amazonka.IoT.Types.Action Methods rnf :: Action -> () #
Eq Action Source #
Instance details Defined in Amazonka.IoT.Types.Action Methods (==) :: Action -> Action -> Bool # (/=) :: Action -> Action -> Bool #
Hashable Action Source #
Instance details Defined in Amazonka.IoT.Types.Action Methods hashWithSalt :: Int -> Action -> Int # hash :: Action -> Int #
type Rep Action Source #
Instance details Defined in Amazonka.IoT.Types.Action type Rep Action = D1 ('MetaData "Action" "Amazonka.IoT.Types.Action" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "Action'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "cloudwatchAlarm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudwatchAlarmAction)) :: S1 ('MetaSel ('Just "cloudwatchLogs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudwatchLogsAction))) :: (S1 ('MetaSel ('Just "cloudwatchMetric") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudwatchMetricAction)) :: (S1 ('MetaSel ('Just "dynamoDB") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DynamoDBAction)) :: S1 ('MetaSel ('Just "dynamoDBv2") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DynamoDBv2Action))))) :: ((S1 ('MetaSel ('Just "elasticsearch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ElasticsearchAction)) :: (S1 ('MetaSel ('Just "firehose") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FirehoseAction)) :: S1 ('MetaSel ('Just "http") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpAction)))) :: (S1 ('MetaSel ('Just "iotAnalytics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IotAnalyticsAction)) :: (S1 ('MetaSel ('Just "iotEvents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IotEventsAction)) :: S1 ('MetaSel ('Just "iotSiteWise") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IotSiteWiseAction)))))) :: (((S1 ('MetaSel ('Just "kafka") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KafkaAction)) :: (S1 ('MetaSel ('Just "kinesis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KinesisAction)) :: S1 ('MetaSel ('Just "lambda") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LambdaAction)))) :: (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LocationAction)) :: (S1 ('MetaSel ('Just "openSearch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OpenSearchAction)) :: S1 ('MetaSel ('Just "republish") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RepublishAction))))) :: ((S1 ('MetaSel ('Just "s3") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Action)) :: (S1 ('MetaSel ('Just "salesforce") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SalesforceAction)) :: S1 ('MetaSel ('Just "sns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SnsAction)))) :: (S1 ('MetaSel ('Just "sqs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SqsAction)) :: (S1 ('MetaSel ('Just "stepFunctions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StepFunctionsAction)) :: S1 ('MetaSel ('Just "timestream") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimestreamAction))))))))

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:cloudwatchAlarm:Action', action_cloudwatchAlarm - Change the state of a CloudWatch alarm.

$sel:cloudwatchLogs:Action', action_cloudwatchLogs - Send data to CloudWatch Logs.

$sel:cloudwatchMetric:Action', action_cloudwatchMetric - Capture a CloudWatch metric.

$sel:dynamoDB:Action', action_dynamoDB - Write to a DynamoDB table.

$sel:dynamoDBv2:Action', action_dynamoDBv2 - Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column.

$sel:elasticsearch:Action', action_elasticsearch - Write data to an Amazon OpenSearch Service domain.

The Elasticsearch action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use the OpenSearch rule action instead. For more information, see OpenSearchAction.

$sel:firehose:Action', action_firehose - Write to an Amazon Kinesis Firehose stream.

$sel:http:Action', action_http - Send data to an HTTPS endpoint.

$sel:iotAnalytics:Action', action_iotAnalytics - Sends message data to an IoT Analytics channel.

$sel:iotEvents:Action', action_iotEvents - Sends an input to an IoT Events detector.

$sel:iotSiteWise:Action', action_iotSiteWise - Sends data from the MQTT message that triggered the rule to IoT SiteWise asset properties.

$sel:kafka:Action', action_kafka - Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.

$sel:kinesis:Action', action_kinesis - Write data to an Amazon Kinesis stream.

$sel:lambda:Action', action_lambda - Invoke a Lambda function.

$sel:location:Action', action_location - The Amazon Location Service rule action sends device location updates from an MQTT message to an Amazon Location tracker resource.

$sel:openSearch:Action', action_openSearch - Write data to an Amazon OpenSearch Service domain.

$sel:republish:Action', action_republish - Publish to another MQTT topic.

$sel:s3:Action', action_s3 - Write to an Amazon S3 bucket.

$sel:salesforce:Action', action_salesforce - Send a message to a Salesforce IoT Cloud Input Stream.

$sel:sns:Action', action_sns - Publish to an Amazon SNS topic.

$sel:sqs:Action', action_sqs - Publish to an Amazon SQS queue.

$sel:stepFunctions:Action', action_stepFunctions - Starts execution of a Step Functions state machine.

$sel:timestream:Action', action_timestream - The Timestream rule action writes attributes (measures) from an MQTT message into an Amazon Timestream table. For more information, see the Timestream topic rule action documentation.

action_cloudwatchAlarm :: Lens' Action (Maybe CloudwatchAlarmAction) Source #

Change the state of a CloudWatch alarm.

action_cloudwatchLogs :: Lens' Action (Maybe CloudwatchLogsAction) Source #

Send data to CloudWatch Logs.

action_cloudwatchMetric :: Lens' Action (Maybe CloudwatchMetricAction) Source #

Capture a CloudWatch metric.

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

Write to a DynamoDB table.

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

Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column.

action_elasticsearch :: Lens' Action (Maybe ElasticsearchAction) Source #

Write data to an Amazon OpenSearch Service domain.

The Elasticsearch action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use the OpenSearch rule action instead. For more information, see OpenSearchAction.

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

Write to an Amazon Kinesis Firehose stream.

action_http :: Lens' Action (Maybe HttpAction) Source #

Send data to an HTTPS endpoint.

action_iotAnalytics :: Lens' Action (Maybe IotAnalyticsAction) Source #

Sends message data to an IoT Analytics channel.

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

Sends an input to an IoT Events detector.

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

Sends data from the MQTT message that triggered the rule to IoT SiteWise asset properties.

action_kafka :: Lens' Action (Maybe KafkaAction) Source #

Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.

action_kinesis :: Lens' Action (Maybe KinesisAction) Source #

Write data to an Amazon Kinesis stream.

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

Invoke a Lambda function.

action_location :: Lens' Action (Maybe LocationAction) Source #

The Amazon Location Service rule action sends device location updates from an MQTT message to an Amazon Location tracker resource.

action_openSearch :: Lens' Action (Maybe OpenSearchAction) Source #

Write data to an Amazon OpenSearch Service domain.

action_republish :: Lens' Action (Maybe RepublishAction) Source #

Publish to another MQTT topic.

action_s3 :: Lens' Action (Maybe S3Action) Source #

Write to an Amazon S3 bucket.

action_salesforce :: Lens' Action (Maybe SalesforceAction) Source #

Send a message to a Salesforce IoT Cloud Input Stream.

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

Publish to an Amazon SNS topic.

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

Publish to an Amazon SQS queue.

action_stepFunctions :: Lens' Action (Maybe StepFunctionsAction) Source #

Starts execution of a Step Functions state machine.

action_timestream :: Lens' Action (Maybe TimestreamAction) Source #

The Timestream rule action writes attributes (measures) from an MQTT message into an Amazon Timestream table. For more information, see the Timestream topic rule action documentation.