Skip to content

Commit d9e58aa

Browse files
Mention the default ClientID in the sample readme (#321)
Commit log: * Mention the default ClientID in the sample readme * Fix typo
1 parent b2f035c commit d9e58aa

File tree

1 file changed

+10
-33
lines changed

1 file changed

+10
-33
lines changed

samples/README.md

Lines changed: 10 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,7 @@ Status updates are continually printed to the console.
3434

3535
Source: `samples/pubsub.py`
3636

37-
Your Thing's
38-
[Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html)
39-
must provide privileges for this sample to connect, subscribe, publish,
40-
and receive.
37+
Your Thing's [Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) must provide privileges for this sample to connect, subscribe, publish, and receive. Make sure your policy allows a client ID of `test-*` to connect or use `--client_id <client ID here>` to send the client ID your policy supports.
4138

4239
<details>
4340
<summary>(see sample policy)</summary>
@@ -90,10 +87,7 @@ This sample is for reference on connecting via certificate and key files.
9087

9188
Source: `samples/basic_connect.py`
9289

93-
Your Thing's
94-
[Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html)
95-
must provide privileges for this sample to connect, subscribe, publish,
96-
and receive.
90+
Your Thing's [Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) must provide privileges for this sample to connect. Make sure your policy allows a client ID of `test-*` to connect or use `--client_id <client ID here>` to send the client ID your policy supports.
9791

9892
<details>
9993
<summary>(see sample policy)</summary>
@@ -127,10 +121,7 @@ This sample is for reference on connecting via websockets.
127121

128122
Source: `samples/websocket_connect.py`
129123

130-
Your Thing's
131-
[Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html)
132-
must provide privileges for this sample to connect, subscribe, publish,
133-
and receive.
124+
Your Thing's [Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) must provide privileges for this sample to connect. Make sure your policy allows a client ID of `test-*` to connect or use `--client_id <client ID here>` to send the client ID your policy supports.
134125

135126
<details>
136127
<summary>(see sample policy)</summary>
@@ -168,10 +159,7 @@ WARNING: Unix only. Currently, TLS integration with PKCS#11 is only available on
168159

169160
source: `samples/pkcs11_connect.py`
170161

171-
Your Thing's
172-
[Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html)
173-
must provide privileges for this sample to connect, subscribe, publish,
174-
and receive.
162+
Your Thing's [Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) must provide privileges for this sample to connect. Make sure your policy allows a client ID of `test-*` to connect or use `--client_id <client ID here>` to send the client ID your policy supports.
175163

176164
<details>
177165
<summary>(see sample policy)</summary>
@@ -257,10 +245,7 @@ you would use them by passing their certificate store path.
257245

258246
source: `samples/windows_cert_connect.py`
259247

260-
Your Thing's
261-
[Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html)
262-
must provide privileges for this sample to connect, subscribe, publish,
263-
and receive.
248+
Your Thing's [Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) must provide privileges for this sample to connect. Make sure your policy allows a client ID of `test-*` to connect or use `--client_id <client ID here>` to send the client ID your policy supports.
264249
265250
<details>
266251
<summary>(see sample policy)</summary>
@@ -329,7 +314,7 @@ To run this sample with a basic certificate from AWS IoT Core:
329314
330315
This sample makes an MQTT connection and connects through a [Custom Authorizer](https://docs.aws.amazon.com/iot/latest/developerguide/custom-authentication.html). On startup, the device connects to the server and then disconnects. This sample is for reference on connecting using a custom authorizer.
331316
332-
Your Thing's [Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) must provide privileges for this sample to connect.
317+
Your Thing's [Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) must provide privileges for this sample to connect. Make sure your policy allows a client ID of `test-*` to connect or use `--client_id <client ID here>` to send the client ID your policy supports.
333318

334319
<details>
335320
<summary>(see sample policy)</summary>
@@ -385,10 +370,7 @@ Run the sample like this:
385370
python3 shadow.py --endpoint <endpoint> --ca_file <file> --cert <file> --key <file> --thing-name <name>
386371
```
387372
388-
Your Thing's
389-
[Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html)
390-
must provide privileges for this sample to connect, subscribe, publish,
391-
and receive.
373+
Your Thing's [Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) must provide privileges for this sample to connect, subscribe, publish, and receive. Make sure your policy allows a client ID of `test-*` to connect or use `--client_id <client ID here>` to send the client ID your policy supports.
392374

393375
<details>
394376
<summary>(see sample policy)</summary>
@@ -471,10 +453,8 @@ Run the sample like this:
471453
python3 jobs.py --endpoint <endpoint> --ca_file <file> --cert <file> --key <file> --thing_name <name>
472454
```
473455
474-
Your Thing's
475-
[Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html)
476-
must provide privileges for this sample to connect, subscribe, publish,
477-
and receive.
456+
Your Thing's [Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) must provide privileges for this sample to connect, subscribe, publish, and receive. Make sure your policy allows a client ID of `test-*` to connect or use `--client_id <client ID here>` to send the client ID your policy supports.
457+
478458
<details>
479459
<summary>(see sample policy)</summary>
480460
<pre>
@@ -548,10 +528,7 @@ Run the sample using createCertificateFromCsr:
548528
python3 fleetprovisioning.py --endpoint <endpoint> --ca_file <file> --cert <file> --key <file> --template_name <name> --template_parameters <parameters> --csr <csr file>
549529
```
550530

551-
Your Thing's
552-
[Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html)
553-
must provide privileges for this sample to connect, subscribe, publish,
554-
and receive.
531+
Your Thing's [Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) must provide privileges for this sample to connect, subscribe, publish, and receive. Make sure your policy allows a client ID of `test-*` to connect or use `--client_id <client ID here>` to send the client ID your policy supports.
555532
556533
<details>
557534
<summary>(see sample policy)</summary>

0 commit comments

Comments
 (0)