Skip to content

Commit 08485aa

Browse files
committed
add sample usage disclaimers
1 parent 38aa353 commit 08485aa

File tree

13 files changed

+136
-7
lines changed

13 files changed

+136
-7
lines changed

samples/Android/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,4 +65,14 @@ Android sample app.
6565

6666
# Trouble Shooting
6767
### Error: The file name must end with .xml
68-
This error typically occurs when non-XML files are placed in the `app/src/main/res/` directory. Android enforces strict rules on what can be included in the `res/` folder. If you're working with test or data files (e.g., .txt in our sample), you **MUST** place them in the `app/src/main/assets/` directory instead.
68+
This error typically occurs when non-XML files are placed in the `app/src/main/res/` directory. Android enforces strict rules on what can be included in the `res/` folder. If you're working with test or data files (e.g., .txt in our sample), you **MUST** place them in the `app/src/main/assets/` directory instead.
69+
70+
## ⚠️ Usage disclaimer
71+
72+
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/).
73+
74+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
75+
76+
- Be aware of the resources that these examples create or delete.
77+
- Be aware of the costs that might be charged to your account as a result.
78+
- Back up your important data.

samples/BasicPubSub/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -361,3 +361,13 @@ builder.withHttpProxyOptions(proxyOptions);
361361
~~~
362362
363363
SDK Proxy support also includes support for basic authentication and TLS-to-proxy. SDK proxy support does not include any additional proxy authentication methods (kerberos, NTLM, etc...) nor does it include non-HTTP proxies (SOCKS5, for example).
364+
365+
## ⚠️ Usage disclaimer
366+
367+
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/).
368+
369+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
370+
371+
- Be aware of the resources that these examples create or delete.
372+
- Be aware of the costs that might be charged to your account as a result.
373+
- Back up your important data.

samples/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,3 +101,13 @@ The sample will not run without the required arguments.
101101
### Enable Logging
102102

103103
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).
104+
105+
## ⚠️ Usage disclaimer
106+
107+
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/).
108+
109+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
110+
111+
- Be aware of the resources that these examples create or delete.
112+
- Be aware of the costs that might be charged to your account as a result.
113+
- Back up your important data.

samples/mqtt/mqtt5awswebsocket/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,4 +105,14 @@ Optional:
105105
The sample will not run without the required arguments.
106106

107107
## Additional Information
108-
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#client-operations), [lifecycle events](../../../documents/MQTT5_Userguide.md#lifecycle-management), [connection methods](../../../documents/MQTT5_Userguide.md#how-to-setup-mqtt5-builder-based-on-desired-connection-method), and other useful information.
108+
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#client-operations), [lifecycle events](../../../documents/MQTT5_Userguide.md#lifecycle-management), [connection methods](../../../documents/MQTT5_Userguide.md#how-to-setup-mqtt5-builder-based-on-desired-connection-method), 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/mqtt/mqtt5customauthsigned/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,4 +114,14 @@ Optional:
114114
The sample will not run without the required arguments.
115115

116116
## Additional Information
117-
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#client-operations), [lifecycle events](../../../documents/MQTT5_Userguide.md#lifecycle-management), [connection methods](../../../documents/MQTT5_Userguide.md#how-to-setup-mqtt5-builder-based-on-desired-connection-method), and other useful information.
117+
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#client-operations), [lifecycle events](../../../documents/MQTT5_Userguide.md#lifecycle-management), [connection methods](../../../documents/MQTT5_Userguide.md#how-to-setup-mqtt5-builder-based-on-desired-connection-method), and other useful information.
118+
119+
## ⚠️ Usage disclaimer
120+
121+
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/).
122+
123+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
124+
125+
- Be aware of the resources that these examples create or delete.
126+
- Be aware of the costs that might be charged to your account as a result.
127+
- Back up your important data.

samples/mqtt/mqtt5customauthunsigned/README.md

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

110110
## Additional Information
111-
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#client-operations), [lifecycle events](../../../documents/MQTT5_Userguide.md#lifecycle-management), [connection methods](../../../documents/MQTT5_Userguide.md#how-to-setup-mqtt5-builder-based-on-desired-connection-method), and other useful information.
111+
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#client-operations), [lifecycle events](../../../documents/MQTT5_Userguide.md#lifecycle-management), [connection methods](../../../documents/MQTT5_Userguide.md#how-to-setup-mqtt5-builder-based-on-desired-connection-method), 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/mqtt/mqtt5pkcs11/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,4 +164,14 @@ The steps to use [SoftHSM2](https://www.opendnssec.org/softhsm/) as the PKCS#11
164164
```
165165

166166
## Additional Information
167-
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#client-operations), [lifecycle events](../../../documents/MQTT5_Userguide.md#lifecycle-management), [connection methods](../../../documents/MQTT5_Userguide.md#how-to-setup-mqtt5-builder-based-on-desired-connection-method), and other useful information.
167+
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#client-operations), [lifecycle events](../../../documents/MQTT5_Userguide.md#lifecycle-management), [connection methods](../../../documents/MQTT5_Userguide.md#how-to-setup-mqtt5-builder-based-on-desired-connection-method), and other useful information.
168+
169+
## ⚠️ Usage disclaimer
170+
171+
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/).
172+
173+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
174+
175+
- Be aware of the resources that these examples create or delete.
176+
- Be aware of the costs that might be charged to your account as a result.
177+
- Back up your important data.

samples/mqtt/mqtt5x509/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,4 +106,14 @@ Optional:
106106
The sample will not run without the required arguments.
107107

108108
## Additional Information
109-
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#client-operations), [lifecycle events](../../../documents/MQTT5_Userguide.md#lifecycle-management), [connection methods](../../../documents/MQTT5_Userguide.md#how-to-setup-mqtt5-builder-based-on-desired-connection-method), and other useful information.
109+
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#client-operations), [lifecycle events](../../../documents/MQTT5_Userguide.md#lifecycle-management), [connection methods](../../../documents/MQTT5_Userguide.md#how-to-setup-mqtt5-builder-based-on-desired-connection-method), and other useful information.
110+
111+
## ⚠️ Usage disclaimer
112+
113+
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/).
114+
115+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
116+
117+
- Be aware of the resources that these examples create or delete.
118+
- Be aware of the costs that might be charged to your account as a result.
119+
- Back up your important data.

samples/serviceclients/commandssandbox/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -432,3 +432,13 @@ distinguishes only JSON and CBOR, all other payload formats will be routed to th
432432
thread(s).
433433
3. If your application is expected to receive a lot of AWS IoT commands, monitor the number of them enqueued for processing.
434434
Consider introducing priorities based on AWS IoT command timeouts or another internal value.
435+
436+
## ⚠️ Usage disclaimer
437+
438+
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/).
439+
440+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
441+
442+
- Be aware of the resources that these examples create or delete.
443+
- Be aware of the costs that might be charged to your account as a result.
444+
- Back up your important data.

samples/serviceclients/jobssandbox/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -311,3 +311,13 @@ A device's persistent job executor should:
311311
2. On startup, get and cache the set of incomplete job executions using `getPendingJobExecutions`
312312
3. Keep the cached job execution set up to date by reacting appropriately to JobExecutionsChanged and NextJobExecutionChanged events
313313
4. While there are incomplete job executions, start and execute them one-at-a-time; otherwise wait for a new entry in the incomplete (queued) job executions set.
314+
315+
## ⚠️ Usage disclaimer
316+
317+
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/).
318+
319+
Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
320+
321+
- Be aware of the resources that these examples create or delete.
322+
- Be aware of the costs that might be charged to your account as a result.
323+
- Back up your important data.

0 commit comments

Comments
 (0)