Skip to content

Commit b474206

Browse files
committed
add usage disclaimer to samples
1 parent 7500cd2 commit b474206

File tree

13 files changed

+143
-10
lines changed

13 files changed

+143
-10
lines changed

samples/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,4 +85,14 @@ To:
8585
"aws-iot-device-sdk-v2": "<latest released version eg: ^1.3.0>",
8686
"yargs": "^14.0.0"
8787
}
88-
```
88+
```
89+
90+
## ⚠️ Usage disclaimer
91+
92+
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/).
93+
94+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
95+
96+
- Be aware of the resources that these examples create or delete.
97+
- Be aware of the costs that might be charged to your account as a result.
98+
- Back up your important data.

samples/node/mqtt/mqtt5_aws_websocket/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,4 +98,14 @@ Options:
9898
The sample will not run without the required arguments and will notify you of missing arguments.
9999

100100
## Additional Information
101-
Additional help with the MQTT5 Client can be found in the [MQTT5 Userguide](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md). This guide will provide more details on MQTT5 operations, lifecycle events, connection methods, and other useful information.
101+
Additional help with the MQTT5 Client can be found in the [MQTT5 Userguide](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md). This guide will provide more details on MQTT5 operations, lifecycle events, connection methods, and other useful information.
102+
103+
## ⚠️ Usage disclaimer
104+
105+
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/).
106+
107+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
108+
109+
- Be aware of the resources that these examples create or delete.
110+
- Be aware of the costs that might be charged to your account as a result.
111+
- Back up your important data.

samples/node/mqtt/mqtt5_custom_auth_signed/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,4 +109,14 @@ Options:
109109
The sample will not run without the required arguments and will notify you of missing arguments.
110110

111111
## Additional Information
112-
Additional help with the MQTT5 Client can be found in the [MQTT5 Userguide](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md). This guide will provide more details on MQTT5 operations, lifecycle events, connection methods, and other useful information.
112+
Additional help with the MQTT5 Client can be found in the [MQTT5 Userguide](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md). This guide will provide more details on MQTT5 operations, lifecycle events, connection methods, and other useful information.
113+
114+
## ⚠️ Usage disclaimer
115+
116+
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/).
117+
118+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
119+
120+
- Be aware of the resources that these examples create or delete.
121+
- Be aware of the costs that might be charged to your account as a result.
122+
- Back up your important data.

samples/node/mqtt/mqtt5_custom_auth_unsigned/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,4 +108,14 @@ Options:
108108
The sample will not run without the required arguments and will notify you of missing arguments.
109109

110110
## Additional Information
111-
Additional help with the MQTT5 Client can be found in the [MQTT5 Userguide](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md). This guide will provide more details on MQTT5 operations, lifecycle events, connection methods, and other useful information.
111+
Additional help with the MQTT5 Client can be found in the [MQTT5 Userguide](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md). This guide will provide more details on MQTT5 operations, lifecycle events, connection methods, and other useful information.
112+
113+
## ⚠️ Usage disclaimer
114+
115+
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/).
116+
117+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
118+
119+
- Be aware of the resources that these examples create or delete.
120+
- Be aware of the costs that might be charged to your account as a result.
121+
- Back up your important data.

samples/node/mqtt/mqtt5_pkcs11/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,4 +111,14 @@ Options:
111111
The sample will not run without the required arguments and will notify you of missing arguments.
112112

113113
## Additional Information
114-
Additional help with the MQTT5 Client can be found in the [MQTT5 Userguide](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md). This guide will provide more details on MQTT5 operations, lifecycle events, connection methods, and other useful information.
114+
Additional help with the MQTT5 Client can be found in the [MQTT5 Userguide](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md). This guide will provide more details on MQTT5 operations, lifecycle events, connection methods, and other useful information.
115+
116+
## ⚠️ Usage disclaimer
117+
118+
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/).
119+
120+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
121+
122+
- Be aware of the resources that these examples create or delete.
123+
- Be aware of the costs that might be charged to your account as a result.
124+
- Back up your important data.

samples/node/mqtt/mqtt5_x509/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,4 +102,14 @@ Options:
102102
The sample will not run without the required arguments and will notify you of missing arguments.
103103

104104
## Additional Information
105-
Additional help with the MQTT5 Client can be found in the [MQTT5 Userguide](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md). This guide will provide more details on MQTT5 operations, lifecycle events, connection methods, and other useful information.
105+
Additional help with the MQTT5 Client can be found in the [MQTT5 Userguide](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md). This guide will provide more details on MQTT5 operations, lifecycle events, connection methods, and other useful information.
106+
107+
## ⚠️ Usage disclaimer
108+
109+
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/).
110+
111+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
112+
113+
- Be aware of the resources that these examples create or delete.
114+
- Be aware of the costs that might be charged to your account as a result.
115+
- Back up your important data.

samples/node/pub_sub/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -272,4 +272,14 @@ by applying proxy configuration to the builder:
272272
```
273273

274274
SDK Proxy support also includes support for basic authentication and TLS-to-proxy. SDK proxy support does not include any additional
275-
proxy authentication methods (kerberos, NTLM, etc...) nor does it include non-HTTP proxies (SOCKS5, for example).
275+
proxy authentication methods (kerberos, NTLM, etc...) nor does it include non-HTTP proxies (SOCKS5, for example).
276+
277+
## ⚠️ Usage disclaimer
278+
279+
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/).
280+
281+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
282+
283+
- Be aware of the resources that these examples create or delete.
284+
- Be aware of the costs that might be charged to your account as a result.
285+
- Back up your important data.

samples/node/pub_sub_electron_node/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,3 +162,14 @@ You can open dev tool using the following API:
162162
```
163163
win.webContents.openDevTools()
164164
```
165+
166+
167+
## ⚠️ Usage disclaimer
168+
169+
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/).
170+
171+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
172+
173+
- Be aware of the resources that these examples create or delete.
174+
- Be aware of the costs that might be charged to your account as a result.
175+
- Back up your important data.

samples/node/pub_sub_mqtt5/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -272,4 +272,14 @@ by applying proxy configuration to the builder:
272272
```
273273

274274
SDK Proxy support also includes support for basic authentication and TLS-to-proxy. SDK proxy support does not include any additional
275-
proxy authentication methods (kerberos, NTLM, etc...) nor does it include non-HTTP proxies (SOCKS5, for example).
275+
proxy authentication methods (kerberos, NTLM, etc...) nor does it include non-HTTP proxies (SOCKS5, for example).
276+
277+
## ⚠️ Usage disclaimer
278+
279+
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/).
280+
281+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
282+
283+
- Be aware of the resources that these examples create or delete.
284+
- Be aware of the costs that might be charged to your account as a result.
285+
- Back up your important data.

samples/node/service_clients/fleet_provisioning/basic/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263,3 +263,14 @@ node ./dist/index.js --endpoint <endpoint> --cert <file> --key <file> --template
263263
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`.
264264

265265
With that, the sample should run and work as expected! You should then find you have a new AWS IoT Core thing!
266+
267+
268+
## ⚠️ Usage disclaimer
269+
270+
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/).
271+
272+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
273+
274+
- Be aware of the resources that these examples create or delete.
275+
- Be aware of the costs that might be charged to your account as a result.
276+
- Back up your important data.

0 commit comments

Comments
 (0)