AWS IoT - Developer Guide

1 AWS IoTDeveloper GuideAWS IoT Developer GuideAWS IoT: Developer GuideCopyright 2018 Amazon Web Services, Inc. and/or its affiliates. All rights 's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any mannerthat is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks notowned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored IoT Developer GuideTable of ContentsWhat Is AWS IoT?

2 1 AWS IoT Components .. 1 How to Get Started with AWS IoT .. 2 Accessing AWS IoT .. 2 Related Services .. 3 How AWS IoT Works .. 3 Getting Started with AWS IoT .. 5 Sign in to the AWS IoT Console .. 5 Register a Device in the Registry .. 6 Create and Activate a Device Certificate .. 8 Create an AWS IoT Policy .. 10 Attach an AWS IoT Policy to a Device Certificate .. 12 Attach a Certificate to a Thing .. 14 Configure Your Device .. 17 Configure an AWS IoT Button .. 17 Configure a Different Device .. 18 View Device MQTT Messages with the AWS IoT MQTT Client.

3 18 Configure and Test Rules .. 21 Create an SNS Topic .. 21 Subscribe to an Amazon SNS Topic .. 23 Create a Rule .. 24 Test the Amazon SNS Rule .. 29 Next Steps .. 30 Create and Track an AWS IoT Job .. 30 Connect Your Device to AWS IoT .. 31 Run the Jobs 31 Create a Job Document .. 31 Create a Job .. 32 Execute the Job on a Device .. 39 Tracking Job Progress with Job and Job Execution Events .. 40 AWS IoT Button Quickstarts .. 44 AWS IoT Button Wizard Quickstart .. 44 AWS IoT Button AWS CloudFormation Quickstart.

4 53 Next Steps .. 58 AWS IoT Rule Tutorials .. 59 Creating a DynamoDB Rule .. 59 Creating a Lambda Rule .. 67 Create the Lambda Function .. 67 Test Your Lambda Function .. 73 Creating a Lambda Rule .. 75 Test Your Lambda Rule .. 78 Creating an Amazon SNS Rule .. 80 AWS IoT SDK Tutorials .. 88 Connecting Your Raspberry Pi .. 88 Prerequisites .. 88 Sign in to the AWS IoT Console .. 88 Create and Attach a Thing (Device) .. 90 Using the AWS IoT Embedded C SDK .. 97 Set Up the Runtime Environment for the AWS IoT Embedded C SDK.

5 97 Sample App 97 Run Sample 98 Using the AWS IoT Device SDK for JavaScript .. 99 Set Up the Runtime Environment for the AWS IoT Device SDK for JavaScript .. 100 Install the AWS IoT Device SDK for JavaScript .. 101iiiAWS IoT Developer GuidePrepare to Run the Sample Applications .. 101 Run the Sample 101 Managing Devices with AWS IoT .. 103 How to Manage Things with the Registry .. 103 Create a thing .. 103 List 104 Search for things .. 104 Update a 105 Delete a 106 Attach a principal to a thing .. 106 Detach a principal from a thing.

6 106 Thing Types .. 106 Create a Thing Type .. 107 List thing types .. 107 Describe a thing type .. 107 Associate a thing type with a thing .. 108 Deprecate a thing type .. 108 Delete a thing type .. 109 Thing Groups .. 109 Create a Thing Group .. 110 Describe a thing group .. 111 Add thing to thing group .. 111 Remove thing from thing group .. 112 List things in thing group .. 112 List thing groups .. 112 List groups for thing .. 114 Update a Thing Group .. 114 Delete a thing group .. 115 Attach a policy to a thing group.

7 115 Detach a policy from a thing group .. 115 List the policies attached to a thing group .. 116 List the groups for a policy .. 116 Get effective policies for a thing .. 116 Test authorization for MQTT actions .. 117 Security and Identity .. 119 AWS IoT Authentication .. Certificates .. 120 IAM Users, Groups, and Roles .. 126 Amazon Cognito Identities .. 127 Custom 127 Custom Authorizers .. 127 Configure a Custom Authorizer .. 129 Custom Authorizer Workflow .. 131 AWS IoT Policies .. 132 IAM IoT Policies.

8 153 Authorizing Direct Calls to AWS Services .. 159 How to Use a Certificate to Get a Security Token .. 160 Cross Account Access .. 163 Transport Security .. 164 TLS Cipher Suite Support .. 164 Message Broker .. 165 Protocols .. 165 Protocol/Port Mappings .. 165 MQTT .. 165 HTTP .. 166 MQTT Over the WebSocket Protocol .. 167ivAWS IoT Developer GuideTopics .. 170 Reserved Topics .. 171 Lifecycle Events .. 173 Connect/Disconnect Events .. 174 Subscribe/Unsubscribe Events .. 176 Granting AWS IoT the Required Access.

9 176 Pass Role Permissions .. 178 Creating an AWS IoT Rule .. 178 Viewing Your Rules .. 182 SQL Versions .. 182 What's New in the 2016-03-23 SQL Rules Engine Version .. 183 Troubleshooting a Rule .. 184 Rule Error Handling .. 184 Error Action Message Format .. 184 Error Action Example .. 185 Deleting a 186 AWS IoT Rule Actions .. 186 CloudWatch Alarm Action .. 187 CloudWatch Metric Action .. 187 DynamoDB Action .. 188 DynamoDBv2 Action .. 190 Amazon ES Action .. 191 Firehose Action .. 192 IoT Analytics Action.

10 192 Kinesis Action .. 193 Lambda Action .. 194 Republish Action .. 195S3 Action .. 196 Salesforce Action .. 197 SNS Action .. 198 SQS Action .. 198 Step Functions Action .. 199 AWS IoT SQL Reference .. 200 Data Types .. 204 Functions .. 209 SELECT Clause .. 242 FROM Clause .. 244 WHERE 245 Case 246 JSON Extensions .. 246 Substitution Templates .. 247 Device Shadow Service .. 249 Device Shadow Service Data Flow .. 249 Detecting a Thing Is Connected .. 255 Device Shadow Service Documents .. 256 Document Properties.