Skip to content

Commit 03b6a1c

Browse files
committed
add content table
1 parent 4a62a87 commit 03b6a1c

File tree

5 files changed

+72
-11
lines changed

5 files changed

+72
-11
lines changed

samples/service_clients/commands/commands-sandbox/README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
11
# Commands Sandbox
22

3-
[**Return to main sample list**](../../README.md)
3+
[**Return to main sample list**](../../../README.md)
4+
5+
*__Jump To:__*
6+
* [Introduction](#introduction)
7+
* [Prerequisites](#prerequisites)
8+
* [Walkthrough](#walkthrough)
9+
* [Run the sample](#run-the-sample)
10+
* [Creating AWS IoT Commands](#creating-aws-iot-commands)
11+
* [Running sample and subscribing to AWS IoT Command Executions](#running-sample-and-subscribing-to-aws-iot-command-executions)
12+
* [Sending AWS IoT Command Executions](#sending-aws-iot-command-executions)
13+
* [Updating and monitoring AWS IoT command execution status](#updating-and-monitoring-aws-iot-command-execution-status)
14+
* [Cleaning up](#cleaning-up)
15+
* [FAQ](#faq)
16+
* [Usage disclaimer](#️-usage-disclaimer)
417

518
## Introduction
619
This is a semi-interactive sample that allows you to use the AWS IoT [Commands](https://docs.aws.amazon.com/iot/latest/developerguide/iot-remote-command.html)
@@ -506,7 +519,7 @@ to perform:
506519
aws iot delete-command --command-id <command-id>
507520
```
508521

509-
### Misc Topics
522+
## FAQ
510523

511524
### What happens if I open the same stream twice?
512525

samples/service_clients/fleet_provisioning/provision-basic/README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11
# Fleet provisioning
22

3-
[**Return to main sample list**](../../README.md)
3+
[**Return to main sample list**](../../../README.md)
4+
5+
*__Jump To:__*
6+
* [Introduction](#introduction)
7+
* [Prerequisites](#prerequisites)
8+
* [Build and Run the Sample](#build-and-run-the-sample)
9+
* [Fleet Provisioning Detailed Instructions](#fleet-provisioning-detailed-instructions)
10+
* [Aws Resource Setup](#aws-resource-setup)
11+
* [Create a provisioning certificate and key pair from a provisioning claim](#create-a-provisioning-certificate-and-key-pair-from-a-provisioning-claim)
12+
* [Running the sample using a certificate-key set](#running-the-sample-using-a-certificate-key-set)
13+
* [Usage disclaimer](#️-usage-disclaimer)
14+
415
## Introduction
516
This sample uses the AWS IoT [Fleet provisioning service](https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html) to provision devices using the CreateKeysAndCertificate and RegisterThing APIs. This allows you to create new AWS IoT Core thing resources using a Fleet Provisioning Template.
617

@@ -251,7 +262,7 @@ And here is the same JSON document, but as a single line for easier copy-pasting
251262

252263
You can use this JSON document as the `<TemplateJSON>` in the AWS CLI command. This sample will assume you have used the template JSON above, so you may need to adjust if you are using a different template JSON. Thankfully, all of these steps need to only be done and, now that they are complete, you will need not perform them again.
253264

254-
### Creating a provisioning certificate and key pair from a provisioning claim
265+
### Create a provisioning certificate and key pair from a provisioning claim
255266

256267
To run the provisioning sample, you'll need a provisioning certificate and key set with sufficient permissions (see the policy at the top). Provisioning certificates are normally created ahead of time and placed on your device, but for this sample, we will just create them on the fly. This is primarily done for example purposes.
257268

samples/service_clients/fleet_provisioning/provision-csr/README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
# Fleet provisioning via CSR
22

3-
[**Return to main sample list**](../../README.md)
3+
[**Return to main sample list**](../../../README.md)
4+
5+
*__Jump To:__*
6+
* [Introduction](#introduction)
7+
* [Prerequisites](#prerequisites)
8+
* [Build and Run the Sample](#build-and-run-the-sample)
9+
* [Fleet Provisioning Detailed Instructions](#fleet-provisioning-detailed-instructions)
10+
* [Aws Resource Setup](#aws-resource-setup)
11+
* [Create a certificate-key set from a provisioning claim](#create-a-certificate-key-set-from-a-provisioning-claim)
12+
* [Create a certificate signing request](#create-a-certificate-signing-request)
13+
* [Running the sample using a certificate-key set](#running-the-sample-using-a-certificate-key-set)
14+
* [Usage disclaimer](#️-usage-disclaimer)
15+
416
## Introduction
517
This sample uses the AWS IoT [Fleet provisioning service](https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html) to provision devices using the CreateCertificateFromCsr and RegisterThing APIs. This allows you to create new AWS IoT Core thing resources using a Fleet Provisioning Template. The primary difference between this sample and the basic provisioning sample is that, by using the CreateCertificateFromCsr API, your provisioned certificates can be rooted to the certificate authority of your choice (as opposed to AmazonRootCA1) via the properties of the certificate signing request used.
618

@@ -64,7 +76,7 @@ Note that in a real application, you may want to avoid the use of wildcards in y
6476
</details>
6577

6678

67-
## Build and run the sample
79+
## Build and Run the Sample
6880

6981
### Install the SDK
7082
Before building and running the sample, you must first build and install the SDK:
@@ -254,7 +266,7 @@ And here is the same JSON document, but as a single line for easier copy-pasting
254266

255267
You can use this JSON document as the `<TemplateJSON>` in the AWS CLI command. This sample will assume you have used the template JSON above, so you may need to adjust if you are using a different template JSON. Thankfully, all of these steps need to only be done and, now that they are complete, you will need not perform them again.
256268

257-
#### Creating a certificate-key set from a provisioning claim
269+
#### Create a certificate-key set from a provisioning claim
258270

259271
To run the provisioning sample, you'll need a provisioning certificate and key set with sufficient permissions (see the policy at the top). Provisioning certificates are normally created ahead of time and placed on your device, but for this sample, we will just create them on the fly. This is primarily done for example purposes.
260272

samples/service_clients/jobs/jobs-sandbox/README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
# Jobs Sandbox
22

3-
[**Return to main sample list**](../../README.md)
3+
[**Return to main sample list**](../../../README.md)
4+
5+
*__Jump To:__*
6+
* [Introduction](#introduction)
7+
* [Commands](#commands)
8+
* [Prerequisites](#prerequisites)
9+
* [Walkthrough](#walkthrough)
10+
* [Run the Sample](#run-the-sample)
11+
* [Job Creation](#job-creation)
12+
* [Job Execution](#job-execution)
13+
* [Job Cleanup](#job-cleanup)
14+
* [FAQ](#faq)
15+
* [Usage disclaimer](#️-usage-disclaimer)
416

517
## Introduction
618
This is an interactive sample that supports a set of commands that allow you to interact with the AWS IoT [Jobs](https://docs.aws.amazon.com/iot/latest/developerguide/iot-jobs.html) Service. The sample walkthrough assumes the [AWS CLI](https://aws.amazon.com/cli/) has been installed and configured in order to invoke control plane operations that are not possible with the device SDK.
@@ -322,7 +334,7 @@ aws iot delete-job --job-id QuestionableJob
322334

323335
Deleting a job fails if an incomplete (non success/failure) job execution exists for the job.
324336

325-
### FAQ
337+
## FAQ
326338
#### What happens if I call `StartNextPendingJobExecution` and there are no jobs to execute?
327339
The request will not fail, but the `execution` field of the response will be empty, indicating that there is nothing to do.
328340

samples/service_clients/shadow/shadow-sandbox/README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
11
# Shadow
22

3-
[**Return to main sample list**](../../README.md)
3+
[**Return to main sample list**](../../../README.md)
4+
5+
*__Jump To:__*
6+
* [Introduction](#introduction)
7+
* [Commands](#commands)
8+
* [Prerequisites](#prerequisites)
9+
* [Walkthrough](#walkthrough)
10+
* [Run the Sample](#run-the-sample)
11+
* [Initialization](#initialization)
12+
* [Changing Properties](#changing-properties)
13+
* [Multiple Properties](#multiple-properties)
14+
* [Removing properties](#removing-properties)
15+
* [Removing a shadow](#removing-a-shadow)
16+
* [Usage disclaimer](#️-usage-disclaimer)
417

518
## Introduction
619
This is an interactive sample that supports a set of commands that allow you to interact with "classic" (unnamed) shadows of the AWS IoT [Device Shadow](https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html) Service.
@@ -79,7 +92,7 @@ Note that in a real application, you may want to avoid the use of wildcards in y
7992

8093
## Walkthrough
8194

82-
### Run the sample
95+
### Run the Sample
8396
#### Install the SDK
8497
Before building and running the sample, you must first build and install the SDK:
8598

0 commit comments

Comments
 (0)