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.IoT.Types.Action

Description

Synopsis

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

Documentation

data Action Source #

Describes the actions associated with a rule.

See: newAction smart constructor.

Constructors

Action'

Fields

cloudwatchMetric :: Maybe CloudwatchMetricAction
Capture a CloudWatch metric.
cloudwatchLogs :: Maybe CloudwatchLogsAction
Send data to CloudWatch Logs.
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.
stepFunctions :: Maybe StepFunctionsAction
Starts execution of a Step Functions state machine.
cloudwatchAlarm :: Maybe CloudwatchAlarmAction
Change the state of a CloudWatch alarm.
sns :: Maybe SnsAction
Publish to an Amazon SNS topic.
dynamoDB :: Maybe DynamoDBAction
Write to a DynamoDB table.
firehose :: Maybe FirehoseAction
Write to an Amazon Kinesis Firehose stream.
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.
iotSiteWise :: Maybe IotSiteWiseAction
Sends data from the MQTT message that triggered the rule to IoT SiteWise asset properties.
iotAnalytics :: Maybe IotAnalyticsAction
Sends message data to an IoT Analytics channel.
lambda :: Maybe LambdaAction
Invoke a Lambda function.
openSearch :: Maybe OpenSearchAction
Write data to an Amazon OpenSearch Service domain.
iotEvents :: Maybe IotEventsAction
Sends an input to an IoT Events detector.
salesforce :: Maybe SalesforceAction
Send a message to a Salesforce IoT Cloud Input Stream.
kinesis :: Maybe KinesisAction
Write data to an Amazon Kinesis stream.
s3 :: Maybe S3Action
Write to an Amazon S3 bucket.
http :: Maybe HttpAction
Send data to an HTTPS endpoint.
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.
kafka :: Maybe KafkaAction
Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
republish :: Maybe RepublishAction
Publish to another MQTT topic.
sqs :: Maybe SqsAction
Publish to an Amazon SQS queue.

Instances

Instances details

Eq Action Source #
Instance details Defined in Amazonka.IoT.Types.Action Methods (==) :: Action -> Action -> Bool # (/=) :: Action -> Action -> Bool #
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 #
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 #
NFData Action Source #
Instance details Defined in Amazonka.IoT.Types.Action Methods rnf :: Action -> () #
Hashable Action Source #
Instance details Defined in Amazonka.IoT.Types.Action Methods hashWithSalt :: Int -> Action -> Int # hash :: Action -> Int #
ToJSON Action Source #
Instance details Defined in Amazonka.IoT.Types.Action Methods toJSON :: Action -> Value # toEncoding :: Action -> Encoding # toJSONList :: [Action] -> Value # toEncodingList :: [Action] -> Encoding #
FromJSON Action Source #
Instance details Defined in Amazonka.IoT.Types.Action Methods parseJSON :: Value -> Parser Action # parseJSONList :: Value -> Parser [Action] #
type Rep Action Source #
Instance details Defined in Amazonka.IoT.Types.Action type Rep Action = D1 ('MetaData "Action" "Amazonka.IoT.Types.Action" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "Action'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "cloudwatchMetric") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudwatchMetricAction)) :: S1 ('MetaSel ('Just "cloudwatchLogs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudwatchLogsAction))) :: (S1 ('MetaSel ('Just "dynamoDBv2") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DynamoDBv2Action)) :: (S1 ('MetaSel ('Just "stepFunctions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StepFunctionsAction)) :: S1 ('MetaSel ('Just "cloudwatchAlarm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudwatchAlarmAction))))) :: ((S1 ('MetaSel ('Just "sns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SnsAction)) :: (S1 ('MetaSel ('Just "dynamoDB") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DynamoDBAction)) :: S1 ('MetaSel ('Just "firehose") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FirehoseAction)))) :: (S1 ('MetaSel ('Just "timestream") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimestreamAction)) :: (S1 ('MetaSel ('Just "iotSiteWise") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IotSiteWiseAction)) :: S1 ('MetaSel ('Just "iotAnalytics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IotAnalyticsAction)))))) :: (((S1 ('MetaSel ('Just "lambda") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LambdaAction)) :: S1 ('MetaSel ('Just "openSearch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OpenSearchAction))) :: (S1 ('MetaSel ('Just "iotEvents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IotEventsAction)) :: (S1 ('MetaSel ('Just "salesforce") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SalesforceAction)) :: S1 ('MetaSel ('Just "kinesis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KinesisAction))))) :: ((S1 ('MetaSel ('Just "s3") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Action)) :: (S1 ('MetaSel ('Just "http") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpAction)) :: S1 ('MetaSel ('Just "elasticsearch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ElasticsearchAction)))) :: (S1 ('MetaSel ('Just "kafka") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KafkaAction)) :: (S1 ('MetaSel ('Just "republish") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RepublishAction)) :*: 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:cloudwatchMetric:Action', action_cloudwatchMetric - Capture a CloudWatch metric.

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

$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:stepFunctions:Action', action_stepFunctions - Starts execution of a Step Functions state machine.

$sel:cloudwatchAlarm:Action', action_cloudwatchAlarm - Change the state of a CloudWatch alarm.

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

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

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

$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.

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

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

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

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

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

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

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

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

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

$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:kafka:Action', action_kafka - Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.

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

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

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

Capture a CloudWatch metric.

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

Send data to CloudWatch Logs.

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_stepFunctions :: Lens' Action (Maybe StepFunctionsAction) Source #

Starts execution of a Step Functions state machine.

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

Change the state of a CloudWatch alarm.

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

Publish to an Amazon SNS topic.

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

Write to a DynamoDB table.

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

Write to an Amazon Kinesis Firehose stream.

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.

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

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

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

Sends message data to an IoT Analytics channel.

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

Invoke a Lambda function.

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

Write data to an Amazon OpenSearch Service domain.

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

Sends an input to an IoT Events detector.

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

Send a message to a Salesforce IoT Cloud Input Stream.

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

Write data to an Amazon Kinesis stream.

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

Write to an Amazon S3 bucket.

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

Send data to an HTTPS endpoint.

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_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_republish :: Lens' Action (Maybe RepublishAction) Source #

Publish to another MQTT topic.

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

Publish to an Amazon SQS queue.