Skip to content
This repository was archived by the owner on Jun 15, 2023. It is now read-only.

Commit 6ef670c

Browse files
committed
Periodic update - 9/29/20-3:32pm PDT
1 parent 488edac commit 6ef670c

18 files changed

+3253
-3204
lines changed

Diff for: developerguide/create-manage-jobs.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Managing jobs<a name="create-manage-jobs"></a>
22

3-
You can use the [AWS IoT console](https://console.aws.amazon.com/iot/), the Jobs HTTPS API, the AWS Command Line Interface, or the AWS SDKs to create and manage jobs\. For more information, see [Job management and control API](jobs-api.md#jobs-http-api), [AWS CLI Command Reference: iot](https://docs.aws.amazon.com/cli/latest/reference/iot/index.html) or [AWS SDKs and Tools](http://aws.amazon.com/tools/#sdk)\.
3+
You can use the [AWS IoT console](https://console.aws.amazon.com/iot/), the Jobs HTTPS API, the AWS Command Line Interface, or the AWS SDKs to create and manage jobs\. For more information, see [Job management and control API](jobs-http-api.md), [AWS CLI Command Reference: iot](https://docs.aws.amazon.com/cli/latest/reference/iot/index.html) or [AWS SDKs and Tools](http://aws.amazon.com/tools/#sdk)\.
44

55
The primary purpose of jobs is to notify devices of a software or firmware update\. When sending code to devices, the best practice is to sign the code file\. This allows devices to detect if the code has been modified in transit\. The instructions in the following section are written with the assumption that you want to code\-sign the software update you are sending to your devices\.
66

@@ -14,7 +14,7 @@ When a device requests the job document, AWS IoT generates the presigned URL and
1414

1515
When you create a job that uses presigned Amazon S3 URLs, you must provide an IAM role that grants permission to download files from the Amazon S3 bucket where the data or updates are stored\. The role must also grant permission for AWS IoT to assume the role\.
1616

17-
You can specify an optional timeout for the presigned URL\. For more information, see [CreateJob](jobs-api.md#jobs-CreateJob)\.
17+
You can specify an optional timeout for the presigned URL\. For more information, see [CreateJob](jobs-http-api.md#jobs-CreateJob)\.
1818

1919
**To grant the jobs service permission to assume your role**
2020

Diff for: developerguide/dynamic-thing-groups.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ You can specify a dynamic thing group as a target for a job\. Only things that m
88

99
For example, suppose that you want to update the firmware on your devices, but, to minimize the chance that the update is interrupted, you only want to update firmware on devices with battery life greater than 80%\. You can create a dynamic thing group that only includes devices with a reported battery life above 80%, and you can use that dynamic thing group as the target for your firmware update job\. Only devices that meet your battery life criteria receive the firmware update\. As devices reach the 80% battery life criteria, they are added to the dynamic thing group and receive the firmware update\.
1010

11-
For more information about specifying thing groups as job targets, see [CreateJob](jobs-api.md#jobs-CreateJob)\.
11+
For more information about specifying thing groups as job targets, see [CreateJob](jobs-http-api.md#jobs-CreateJob)\.
1212

1313
Dynamic thing groups differ from static thing groups in the following ways:
1414
+ Thing membership is not explicitly defined\. To create a dynamic thing group, you must define a query string that defines group membership\.

Diff for: developerguide/index.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ Amazon's trademarks and trade dress may not be used in
4949
+ [Creating a rule with a DynamoDB action](iot-ddb-rule.md)
5050
+ [Creating a rule with an AWS Lambda action](iot-lambda-rule.md)
5151
+ [Using the AWS IoT Device SDKs on a Raspberry Pi](sdk-tutorials.md)
52-
+ [Using the AWS IoT Device SDK for Embedded C](iot-embedded-c-sdk.md)
5352
+ [Using the AWS IoT Device SDK for JavaScript and node](iot-device-sdk-node.md)
53+
+ [Using the AWS IoT Device SDK for Embedded C](iot-embedded-c-sdk.md)
5454
+ [Other AWS IoT tutorials](iot-additional-tutorial.md)
5555
+ [Monitoring soil moisture with AWS IoT and Raspberry Pi](iot-moisture-tutorial.md)
5656
+ [Setting up AWS IoT](iot-moisture-setup.md)
@@ -194,6 +194,10 @@ Amazon's trademarks and trade dress may not be used in
194194
+ [Creating and managing jobs (CLI)](manage-job-cli.md)
195195
+ [Devices and jobs](jobs-devices.md)
196196
+ [Using the AWS IoT jobs APIs](jobs-api.md)
197+
+ [Job management and control API](jobs-http-api.md)
198+
+ [Job management and control data types](jobs-control-plane-data-types.md)
199+
+ [Jobs device MQTT and HTTPS APIs](jobs-mqtt-api.md)
200+
+ [Jobs device MQTT and HTTPS data types](jobs-data-plane-data-types.md)
197201
+ [Job rollout and abort configuration](job-rollout-abort.md)
198202
+ [Job limits](job-limits.md)
199203
+ [AWS IoT secure tunneling](secure-tunneling.md)

Diff for: developerguide/interactive-demo.md

-4
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,6 @@ You can expect to spend about 10 minutes with this demo\. The tile in the consol
1212
1. On the **See how AWS IoT works** tile, choose **Start the tutorial**\.
1313
![\[AWS IoT console Learn home page\]](http://docs.aws.amazon.com/iot/latest/developerguide/images/aws-iot-learn-home-demo.png)
1414

15-
1. On the **AWS IoT Interactive Tutorial** page, review the tutorial overview to get an idea of what you'll learn\.
16-
17-
Choose **Start tutorial** when you're ready to continue\.
18-
1915
1. On the **AWS IoT Interactive Tutorial** page, review the tutorial overview to get an idea of what you'll learn\.
2016

2117
Choose **Start tutorial** when you're ready to continue\.

Diff for: developerguide/iot-connect-devices.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Every customer has an `iot:Data-ATS` and an `iot:Data` endpoint\. Each endpoint
3030
| IoT data | `iot:Data-ATS` | Used to send and receive data to and from the message broker, [Device Shadow](iot-device-shadows.md), and [Rules Engine](iot-rules.md) components of AWS IoT\. `iot:Data-ATS` returns an ATS signed data endpoint\. |
3131
| IoT data \(legacy\) | `iot:Data` | iot:Data returns a VeriSign signed data endpoint provided for backward compatibility\. |
3232
| IoT credential access | `iot:CredentialProvider` | Used to exchange a device's built\-in X\.509 certificate for temporary credentials to connect directly with other AWS services\. For more information about connecting to other AWS services, see [Authorizing Direct Calls to AWS Services](authorizing-direct-aws.md)\. |
33-
| IoT job management | `iot:Jobs` | Used to enable devices to interact with the AWS IoT Jobs service using the [Jobs Device HTTPS APIs](jobs-api.md#jobs-mqtt-api)\. |
33+
| IoT job management | `iot:Jobs` | Used to enable devices to interact with the AWS IoT Jobs service using the [Jobs Device HTTPS APIs](jobs-mqtt-api.md)\. |
3434

3535
You can also use your own fully\-qualified domain name \(FQDN\), such as *example\.com*, and the associated server certificate to connect devices to AWS IoT by using [Configurable endpoints \(beta\)](iot-custom-endpoints-configurable.md), which is currently in public beta\.
3636

Diff for: developerguide/iot-ddb-rule.md

+33-7
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,19 @@ The DynamoDB action allows you to take information from an incoming MQTT message
1515
We do not recommend the use of personally identifiable information in rule names or descriptions\.
1616
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/iot/latest/developerguide/images/create-a-ddb-rule.png)
1717

18-
1. Under **Rule query statement**, choose the latest version from the **Using SQL version** list\. For **Rule query statement**, enter:
18+
1.
1919

20-
```
21-
SELECT * FROM 'my/greenhouse'
22-
```
20+
1. Under **Rule query statement**, choose the latest version from the **Using SQL version** list\. For **Rule query statement**, enter:
21+
22+
```
23+
SELECT * FROM 'my/greenhouse'
24+
```
25+
26+
`"SELECT *"` specifies that you want to send the entire MQTT message that initiated the rule\.
2327
24-
\(`"SELECT *"` specifies that you want to send the entire MQTT message that initiated the rule\. `"FROM 'my/greenhouse'"` tells the rules engine to initiate this rule when an MQTT message whose topic matches this topic filter is received\. Choose **Add action\.**
28+
`"FROM 'my/greenhouse'"` tells the rules engine to initiate this rule when an MQTT message whose topic matches this topic filter is received\.
29+
30+
1. Choose **Add action**\.
2531
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/iot/latest/developerguide/images/rule-query-ddb.png)
2632
2733
1. On **Select an action**, choose **Insert a message into a DynamoDB table**, and then choose **Configure action**\.
@@ -33,10 +39,30 @@ We do not recommend the use of personally identifiable information in rule names
3339
1. On the **Amazon DynamoDB** page, choose **Create table**\.
3440
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/iot/latest/developerguide/images/dynamodb-welcome.png)
3541
36-
1. On **Create DynamoDB table**, enter a name\. In **Partition key**, enter **Row**\. Select **Add sort key**, and then enter **PositionInRow** in the **Sort key** field\. `Row` represents a row of plants in a greenhouse\. `PositionInRow` represents the position of a plant in the row\. Choose **String** for both the partition and sort keys, and then choose **Create**\. It takes a few seconds to create your DynamoDB table\. Close the browser tab where the Amazon DynamoDB console is open\. If you don't close the tab, your DynamoDB table is not displayed in the **Table name** list on the **Configure action** page of the AWS IoT console\.
42+
1.
43+
44+
1. On **Create DynamoDB table**, enter a name\. In **Partition key**, enter **Row**\.
45+
46+
1. Select **Add sort key**, and then enter **PositionInRow** in the **Sort key** field\. `Row` represents a row of plants in a greenhouse\. `PositionInRow` represents the position of a plant in the row\.
47+
48+
1. Choose **String** for both the partition and sort keys, and then choose **Create**\. It takes a few seconds to create your DynamoDB table\.
49+
50+
1. Close the browser tab where the Amazon DynamoDB console is open\. If you don't close the tab, your DynamoDB table is not displayed in the **Table name** list on the **Configure action** page of the AWS IoT console\.
3751
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/iot/latest/developerguide/images/create-ddb-table.png)
3852
39-
1. On **Configure action**, choose your new table from the **Table name** list\. In **Partition key value**, enter **$\{row\}**\. This instructs the rule to take the value of the `row` attribute from the MQTT message and write it into the **Row** column in the DynamoDB table\. In **Sort key value**, enter **$\{pos\}**\. This writes the value of the `pos` attribute into the **PositionInRow** column\. In **Write message data to this column**, enter **Payload**\. This inserts the message payload into the `Payload` column\. Leave **Operation** blank\. This field allows you to specify which operation \(INSERT, UPDATE, or DELETE\) you want to perform when the action is initiated\. Choose **Create a new role**\.
53+
1.
54+
55+
1. On **Configure action**, choose your new table from the **Table name** list\.
56+
57+
1. In **Partition key value**, enter **$\{row\}**\. This instructs the rule to take the value of the `row` attribute from the MQTT message and write it into the **Row** column in the DynamoDB table\.
58+
59+
1. In **Sort key value**, enter **$\{pos\}**\. This writes the value of the `pos` attribute into the **PositionInRow** column\.
60+
61+
1. In **Write message data to this column**, enter **Payload**\. This inserts the message payload into the `Payload` column\.
62+
63+
1. Leave **Operation** blank\. Because you specified a value in the **Write message data to this column** field, the **Operation** must be blank\. This field allows you to specify which operation \(INSERT, UPDATE, or DELETE\) you want to perform when the action is initiated; however, entering **Payload** in **Write message data to this column** indicates that this rule action will perform an INSERT operation\.
64+
65+
1. Choose **Create a new role**\.
4066
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/iot/latest/developerguide/images/configure-action-with-resource.png)
4167
4268
1. In **Create a new role**, enter a unique name, and then choose **Create role**\.

Diff for: developerguide/iot-embedded-c-sdk.md

+11-5
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ This section describes how to run the AWS IoT Device SDK for Embedded C\.
66

77
The AWS IoT Device SDK for Embedded C is generally targeted at resource constrained devices that require an optimized C language runtime\. You can use the SDK on any operating system and host it on any processor type \(for example, MCUs and MPUs\)\. If you have more memory and processing resources available, we recommend that you use one of the higher order AWS IoT Device and Mobile SDKs \(for example, C\+\+, Java, JavaScript, and Python\)\.
88

9-
In general, the AWS IoT Device SDK for Embedded C is intended for systems that use MCUs or low\-end MPUs that run embedded operating systems\. For programming examples in the documentation, we use Raspberry Pi running embedded Linux\.
9+
In general, the AWS IoT Device SDK for Embedded C is intended for systems that use MCUs or low\-end MPUs that run embedded operating systems\. For the programming example in this section, we assume your device uses Linux\.
1010

1111
**Example**
1212

13-
1. Download the AWS IoT Device SDK for Embedded C to your Raspberry Pi from [GitHub](https://github.com/aws/aws-iot-device-sdk-embedded-C)\.
13+
1. Download the AWS IoT Device SDK for Embedded C to your device from [GitHub](https://github.com/aws/aws-iot-device-sdk-embedded-C)\.
1414

1515
```
1616
git clone https://github.com/aws/aws-iot-device-sdk-embedded-c.git --recurse-submodules
@@ -41,7 +41,7 @@ Device and root CA certificates are subject to expiration or revocation\. If the
4141

4242
1. You must configure the sample with your personal AWS IoT Core endpoint, private key, certificate, and root CA certificate\. Navigate to the `aws-iot-device-sdk-embedded-c/demos/mqtt/mqtt_demo_mutual_auth` directory\.
4343

44-
If you have the AWS CLI installed, you can use the aws iot describe\-endpoint \-\-endpoint\-type iot:Data\-ATS command to find your personal endpoint URL\. If you don't have the AWS CLI installed, open your [AWS IoT console](https://console.aws.amazon.com/iot/home)\. From the navigation pane, choose **Manage**, and then choose **Things**\. Choose the IoT thing for your Raspberry Pi, and then choose **Interact**\. Your endpoint is displayed in the ** HTTPS** section of the thing details page\.
44+
If you have the AWS CLI installed, you can use the aws iot describe\-endpoint \-\-endpoint\-type iot:Data\-ATS command to find your personal endpoint URL\. If you don't have the AWS CLI installed, open your [AWS IoT console](https://console.aws.amazon.com/iot/home)\. From the navigation pane, choose **Manage**, and then choose **Things**\. Choose the IoT thing for your device, and then choose **Interact**\. Your endpoint is displayed in the ** HTTPS** section of the thing details page\.
4545

4646
1. Open the `demo_config.h` file and update the values for the following:
4747
AWS\_IOT\_ENDPOINT
@@ -101,7 +101,13 @@ Your private key file name, for example `certificates/private.pem.key`\.
101101

102102
**To run the AWS IoT Device SDK for Embedded C sample applications**
103103

104-
1. Navigate to `aws-iot-device-sdk-embedded-c/build`, then enter the following CMake command to generate the Makefiles needed to build\.
104+
1. Navigate to `aws-iot-device-sdk-embedded-c` and create a build directory\.
105+
106+
```
107+
mkdir build && cd build
108+
```
109+
110+
1. Enter the following CMake command to generate the Makefiles needed to build\.
105111

106112
```
107113
cmake ..
@@ -123,6 +129,6 @@ Your private key file name, for example `certificates/private.pem.key`\.
123129
You should see output similar to the following:
124130
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/iot/latest/developerguide/images/successful-run2.png)
125131

126-
Your Raspberry Pi is now connected to AWS IoT using the AWS IoT Device SDK for Embedded C\.
132+
Your device is now connected to AWS IoT using the AWS IoT Device SDK for Embedded C\.
127133

128134
You can also use the AWS IoT console to view the MQTT messages that the sample app is publishing\. For information about how to use the MQTT client in the [AWS IoT console](https://console.aws.amazon.com/iot/home), see [View MQTT messages with the AWS IoT MQTT client](view-mqtt-messages.md) \.

Diff for: developerguide/iot-sdks.md

-3
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,7 @@ The AWS IoT Device SDK for Embedded C is generally targeted at resource constrai
6666

6767
For more information, see the following:
6868
+ [AWS IoT Device SDK for Embedded C on GitHub](https://github.com/aws/aws-iot-device-sdk-embedded-C)
69-
70-
[AWS IoT Device SDK for Embedded C on GitHub](https://github.com/aws/aws-iot-device-sdk-embedded-C)
7169
+ [ AWS IoT Device SDK for Embedded C Readme](https://github.com/aws/aws-iot-device-sdk-embedded-C#aws-iot-device-sdk-for-embedded-c)
72-
+ [AWS IoT Device SDK for Embedded C Readme](https://github.com/aws/aws-iot-device-sdk-embedded-C#aws-iot-device-sdk-for-embedded-c)
7370
+ [AWS IoT Device SDK for Embedded C Samples](https://docs.aws.amazon.com/freertos/latest/lib-ref/embedded-csdk/202009.00/lib-ref/docs/doxygen/output/html/demos_main.html)
7471

7572
## AWS Mobile SDKs<a name="iot-mobile-sdks"></a>

Diff for: developerguide/iot-tutorials.md

+1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,5 @@ These tutorials can help you learn how to apply a specific aspect of AWS IoT to
55
**Topics**
66
+ [AWS IoT rules tutorials](iot-rules-tutorial.md)
77
+ [Using the AWS IoT Device SDKs on a Raspberry Pi](sdk-tutorials.md)
8+
+ [Using the AWS IoT Device SDK for Embedded C](iot-embedded-c-sdk.md)
89
+ [Other AWS IoT tutorials](iot-additional-tutorial.md)

0 commit comments

Comments
 (0)