Skip to content

Commit 4961400

Browse files
authored
add usage disclaimer to sample README (#663)
1 parent c9c16e6 commit 4961400

File tree

12 files changed

+121
-3
lines changed

12 files changed

+121
-3
lines changed

samples/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,3 +82,13 @@ The sample will not run without the required arguments and will notify you of mi
8282
### Enable Logging
8383

8484
Instructions to enable logging are available in the [FAQ](../documents/FAQ.md) under [How do I enable logging](../documents/FAQ.md#how-do-i-enable-logging).
85+
86+
## ⚠️ Usage disclaimer
87+
88+
These code examples interact with services that may incur charges to your AWS account. For more information, see [AWS Pricing](https://aws.amazon.com/pricing/).
89+
90+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
91+
92+
- Be aware of the resources that these examples create or delete.
93+
- Be aware of the costs that might be charged to your account as a result.
94+
- Back up your important data.

samples/greengrass/basic_discovery.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,14 @@ This sample is intended for use with the following tutorials in the AWS IoT Gree
77

88
* [Connect and test client devices](https://docs.aws.amazon.com/greengrass/v2/developerguide/client-devices-tutorial.html)
99
* [Test client device communications](https://docs.aws.amazon.com/greengrass/v2/developerguide/test-client-device-communications.html)
10-
* [Getting Started with AWS IoT Greengrass](https://docs.aws.amazon.com/greengrass/latest/developerguide/gg-gs.html)
10+
* [Getting Started with AWS IoT Greengrass](https://docs.aws.amazon.com/greengrass/latest/developerguide/gg-gs.html)
11+
12+
## ⚠️ Usage disclaimer
13+
14+
These code examples interact with services that may incur charges to your AWS account. For more information, see [AWS Pricing](https://aws.amazon.com/pricing/).
15+
16+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
17+
18+
- Be aware of the resources that these examples create or delete.
19+
- Be aware of the costs that might be charged to your account as a result.
20+
- Back up your important data.

samples/greengrass/ipc_greengrass.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,3 +97,13 @@ Replace the following with your information:
9797
<br />
9898

9999
Note that you will need to have the Python V2 SDK installed on the Greengrass device in order to compile the sample on the Greengrass device.
100+
101+
## ⚠️ Usage disclaimer
102+
103+
These code examples interact with services that may incur charges to your AWS account. For more information, see [AWS Pricing](https://aws.amazon.com/pricing/).
104+
105+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
106+
107+
- Be aware of the resources that these examples create or delete.
108+
- Be aware of the costs that might be charged to your account as a result.
109+
- Back up your important data.

samples/mqtt/mqtt5_aws_websocket.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,3 +102,13 @@ The sample will not run without the required arguments and will notify you of mi
102102

103103
## Additional Information
104104
Additional help with the MQTT5 Client can be found in the [MQTT5 Userguide](../../documents/MQTT5_Userguide.md). This guide will provide more details on MQTT5 [operations](../../documents/MQTT5_Userguide.md#optional-keyword-arguments), [lifecycle events](../../documents/MQTT5_Userguide.md#lifecycle-events), [connection methods](../../documents/MQTT5_Userguide.md#connecting-to-aws-iot-core), and other useful information.
105+
106+
## ⚠️ Usage disclaimer
107+
108+
These code examples interact with services that may incur charges to your AWS account. For more information, see [AWS Pricing](https://aws.amazon.com/pricing/).
109+
110+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
111+
112+
- Be aware of the resources that these examples create or delete.
113+
- Be aware of the costs that might be charged to your account as a result.
114+
- Back up your important data.

samples/mqtt/mqtt5_custom_auth.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,3 +131,13 @@ The sample will not run without the required arguments and will notify you of mi
131131

132132
## Additional Information
133133
Additional help with the MQTT5 Client can be found in the [MQTT5 Userguide](../../documents/MQTT5_Userguide.md). This guide will provide more details on MQTT5 [operations](../../documents/MQTT5_Userguide.md#optional-keyword-arguments), [lifecycle events](../../documents/MQTT5_Userguide.md#lifecycle-events), [connection methods](../../documents/MQTT5_Userguide.md#connecting-to-aws-iot-core), and other useful information.
134+
135+
## ⚠️ Usage disclaimer
136+
137+
These code examples interact with services that may incur charges to your AWS account. For more information, see [AWS Pricing](https://aws.amazon.com/pricing/).
138+
139+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
140+
141+
- Be aware of the resources that these examples create or delete.
142+
- Be aware of the costs that might be charged to your account as a result.
143+
- Back up your important data.

samples/mqtt/mqtt5_pkcs11_connect.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,3 +169,13 @@ The steps to use [SoftHSM2](https://www.opendnssec.org/softhsm/) as the PKCS#11
169169

170170
## Additional Information
171171
Additional help with the MQTT5 Client can be found in the [MQTT5 Userguide](../../documents/MQTT5_Userguide.md). This guide will provide more details on MQTT5 [operations](../../documents/MQTT5_Userguide.md#optional-keyword-arguments), [lifecycle events](../../documents/MQTT5_Userguide.md#lifecycle-events), [connection methods](../../documents/MQTT5_Userguide.md#connecting-to-aws-iot-core), and other useful information.
172+
173+
## ⚠️ Usage disclaimer
174+
175+
These code examples interact with services that may incur charges to your AWS account. For more information, see [AWS Pricing](https://aws.amazon.com/pricing/).
176+
177+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
178+
179+
- Be aware of the resources that these examples create or delete.
180+
- Be aware of the costs that might be charged to your account as a result.
181+
- Back up your important data.

samples/mqtt/mqtt5_x509.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,3 +106,13 @@ The sample will not run without the required arguments and will notify you of mi
106106

107107
## Additional Information
108108
Additional help with the MQTT5 Client can be found in the [MQTT5 Userguide](../../documents/MQTT5_Userguide.md). This guide will provide more details on MQTT5 [operations](../../documents/MQTT5_Userguide.md#optional-keyword-arguments), [lifecycle events](../../documents/MQTT5_Userguide.md#lifecycle-events), [connection methods](../../documents/MQTT5_Userguide.md#connecting-to-aws-iot-core), and other useful information.
109+
110+
## ⚠️ Usage disclaimer
111+
112+
These code examples interact with services that may incur charges to your AWS account. For more information, see [AWS Pricing](https://aws.amazon.com/pricing/).
113+
114+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
115+
116+
- Be aware of the resources that these examples create or delete.
117+
- Be aware of the costs that might be charged to your account as a result.
118+
- Back up your important data.

samples/pubsub.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,3 +71,13 @@ You can also pass a Certificate Authority file (CA) if your certificate and key
7171
# For Windows: replace 'python3' with 'python' and '/' with '\'
7272
python3 pubsub.py --endpoint <endpoint> --cert <file> --key <file> --ca_file <file>
7373
```
74+
75+
## ⚠️ Usage disclaimer
76+
77+
These code examples interact with services that may incur charges to your AWS account. For more information, see [AWS Pricing](https://aws.amazon.com/pricing/).
78+
79+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
80+
81+
- Be aware of the resources that these examples create or delete.
82+
- Be aware of the costs that might be charged to your account as a result.
83+
- Back up your important data.

samples/service_clients/fleet_provisioning_basic.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -279,3 +279,13 @@ python3 samples/service_clients/fleet_provisioning_basic.py --endpoint <endpoint
279279
As per normal, replace the `<>` parameters with the proper values. Notice that we provided substitution values for the two parameters in the template body, `DeviceLocation` and `SerialNumber`.
280280

281281
With that, the sample should run and work as expected! You should then find you have a new AWS IoT Core thing!
282+
283+
## ⚠️ Usage disclaimer
284+
285+
These code examples interact with services that may incur charges to your AWS account. For more information, see [AWS Pricing](https://aws.amazon.com/pricing/).
286+
287+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
288+
289+
- Be aware of the resources that these examples create or delete.
290+
- Be aware of the costs that might be charged to your account as a result.
291+
- Back up your important data.

samples/service_clients/fleet_provisioning_csr.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -288,4 +288,12 @@ Finally, you pass the certificate signing request while invoking the Fleet Provi
288288
python3 samples/service_clients/fleet_provisioning_csr.py --endpoint <endpoint> --cert <file> --key <file> --csr_file <file> --template_name <template name> --template_parameters '{"SerialNumber":"1","DeviceLocation":"Seattle"}'
289289
```
290290

291+
## ⚠️ Usage disclaimer
291292

293+
These code examples interact with services that may incur charges to your AWS account. For more information, see [AWS Pricing](https://aws.amazon.com/pricing/).
294+
295+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
296+
297+
- Be aware of the resources that these examples create or delete.
298+
- Be aware of the costs that might be charged to your account as a result.
299+
- Back up your important data.

0 commit comments

Comments
 (0)