Requirements Parameters Examples See also

SQS

The SQS (sqs) action sends data from an MQTT message to an Amazon Simple Queue Service (Amazon SQS) queue.

Note

The SQS action doesn't support Amazon SQS FIFO (First-In-First-Out) queues. Because the rules engine is a fully distributed service, there is no guarantee of message order when the SQS action is triggered.

Requirements

This rule action has the following requirements:

An IAM role that Amazon IoT can assume to perform the sqs:SendMessage operation. For more information, see Granting an Amazon IoT rule the access it requires.

In the Amazon IoT console, you can choose or create a role to allow Amazon IoT to perform this rule action.
If you use an Amazon KMS customer managed Amazon KMS key to encrypt data at rest in Amazon SQS, the service must have permission to use the Amazon KMS key on the caller's behalf. For more information, see Key management in the Amazon Simple Queue Service Developer Guide.

Parameters

When you create an Amazon IoT rule with this action, you must specify the following information:

queueUrl

The URL of the Amazon SQS queue to which to write the data. The region in this URL doesn't need to be the same Amazon Web Services Region as your Amazon IoT rule.

Note

There can be additional charges for data transfer cross Amazon Web Services Regions using the SQS rule action. For more information, see Amazon SQS pricing.

Supports substitution templates: API and Amazon CLI only

useBase64

Set this parameter to true to configure the rule action to base64-encode the message data before it writes the data to the Amazon SQS queue. Defaults to false.

Supports substitution templates: No

roleArn

The IAM role that allows access to the Amazon SQS queue. For more information, see Requirements.

Supports substitution templates: No

Examples

The following JSON example defines an SQS action in an Amazon IoT rule.


{
    "topicRulePayload": {
        "sql": "SELECT * FROM 'some/topic'", 
        "ruleDisabled": false, 
        "awsIotSqlVersion": "2016-03-23",
        "actions": [
            {
                "sqs": {
                    "queueUrl": "https://sqs.us-east-2.amazonaws.com/123456789012/my_sqs_queue", 
                    "roleArn": "arn:aws:iam::123456789012:role/aws_iot_sqs"
                }
            }
        ]
    }
}

The following JSON example defines an SQS action with substitution templates in an Amazon IoT rule.


{
    "topicRulePayload": {
        "sql": "SELECT * FROM 'some/topic'",
        "ruleDisabled": false,
        "awsIotSqlVersion": "2016-03-23",
        "actions": [
            {
                "sqs": {
                    "queueUrl": "https://sqs.us-east-2.amazonaws.com/123456789012/${topic()}",
                    "useBase64": true,
                    "roleArn": "arn:aws:iam::123456789012:role/aws_iot_sqs"
                }
            }
        ]
    }
}