Requirements Parameters Examples See also

S3

The S3 (s3) action writes the data from an MQTT message to an Amazon Simple Storage Service (Amazon S3) bucket.

Requirements

This rule action has the following requirements:

An IAM role that Amazon IoT can assume to perform the s3:PutObject 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 customermanaged Amazon KMS key to encrypt data at rest in Amazon S3, the service must have permission to use the Amazon KMS key on the caller's behalf. For more information, see Amazon managed Amazon KMS keys and customer managed Amazon KMS keys in the Amazon Simple Storage Service Developer Guide.

Parameters

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

bucket

The Amazon S3 bucket to which to write data.

Supports substitution templates: API and Amazon CLI only

cannedacl

(Optional) The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, including allowed values, see Canned ACL.

Supports substitution templates: No

key

The path to the file where the data is written.

Consider an example where this parameter is ${topic()}/${timestamp()} and the rule receives a message where the topic is some/topic. If the current timestamp is 1460685389, then this action writes the data to a file called 1460685389 in the some/topic folder of the S3 bucket.

Note

If you use a static key, Amazon IoT overwrites a single file each time the rule invokes. We recommend that you use the message timestamp or another unique message identifier so that a new file is saved in Amazon S3 for each message received.

Supports substitution templates: Yes

roleArn

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

Supports substitution templates: No

Examples

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


{
    "topicRulePayload": {
        "sql": "SELECT * FROM 'some/topic'", 
        "ruleDisabled": false, 
        "awsIotSqlVersion": "2016-03-23",
        "actions": [
            {
                "s3": {
                    "bucketName": "my-bucket", 
                    "cannedacl": "public-read",
                    "key": "${topic()}/${timestamp()}",
                    "roleArn": "arn:aws:iam::123456789012:role/aws_iot_s3"
                }
            }
        ]
    }
}