update service sample

xiazhvera · xiazhvera · commit 4a62a87c12ae · 2025-10-17T11:06:59.000-07:00
diff --git a/samples/mqtt/mqtt5_aws_websocket/README.md b/samples/mqtt/mqtt5_aws_websocket/README.md
@@ -68,7 +68,7 @@ Note that in a real application, you may want to avoid the use of wildcards in y
 
 ## How to build
 
-To build the sample, change directory into the samples folder and run the cmake commands. The sample executable will be built under `samples/mqtt/mqtt5_aws_websocket/build` folder.
+To build the sample, change directory into the sample's folder and run the cmake commands. The sample executable will be built into the `samples/mqtt/mqtt5_aws_websocket/build` folder.
 ```sh
 cd samples/mqtt/mqtt5_aws_websocket/
 # If you followed the SDK build instruction, you would use the path to `sdk-workspace` folder for `CMAKE_PREFIX_PATH` here
@@ -78,9 +78,10 @@ cmake --build build --config "Debug"
 
 ## How to run
 
-To run this sample from the `samples/mqtt/mqtt5_aws_websocket` folder, use the following command:
+To run this sample, navigate to the build directory where the executable was created:
 
 ```sh
+# From samples/mqtt/mqtt5_aws_websocket/, go to the build directory
 cd build
 ./mqtt5_aws_websocket \
   --endpoint <AWS IoT endpoint> \
@@ -112,4 +113,4 @@ optional arguments:
 The sample will not run without the required arguments and will notify you of missing arguments.
 
 ## Additional Information
-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#client-lifecycle-management), [connection methods](../../../documents/MQTT5_Userguide.md#connecting-to-aws-iot-core), and other useful information.
+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#client-lifecycle-management), [connection methods](../../../documents/MQTT5_Userguide.md#connecting-to-aws-iot-core), and other useful information.
diff --git a/samples/mqtt/mqtt5_custom_auth_signed/README.md b/samples/mqtt/mqtt5_custom_auth_signed/README.md
@@ -70,7 +70,7 @@ Note that in a real application, you may want to avoid the use of wildcards in y
 
 ## How to build
 
-To build the sample, change directory into the samples folder and run the cmake commands. The sample executable will be built under `samples/mqtt/mqtt5_custom_auth_signed/build` folder.
+To build the sample, change directory into the sample's folder and run the cmake commands. The sample executable will be built into the `samples/mqtt/mqtt5_custom_auth_signed/build` folder.
 ```sh
 cd samples/mqtt/mqtt5_custom_auth_signed/
 # If you followed the SDK build instruction, you would use the path to `sdk-workspace` folder for `CMAKE_PREFIX_PATH` here
@@ -80,9 +80,10 @@ cmake --build build --config "Debug"
 
 ## How to run
 
-To run this sample from the `samples/mqtt/mqtt5_custom_auth_signed` folder, use the following command:
+To run this sample, navigate to the build directory where the executable was created:
 
 ```sh
+# From samples/mqtt/mqtt5_custom_auth_signed/, go to the build directory
 cd build
 # For a signed custom authorizer
 ./mqtt5_custom_auth_signed \
@@ -122,4 +123,4 @@ optional arguments:
 The sample will not run without the required arguments and will notify you of missing arguments.
 
 ## Additional Information
-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#client-lifecycle-management), [connection methods](../../../documents/MQTT5_Userguide.md#connecting-to-aws-iot-core), and other useful information.
+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#client-lifecycle-management), [connection methods](../../../documents/MQTT5_Userguide.md#connecting-to-aws-iot-core), and other useful information.
diff --git a/samples/mqtt/mqtt5_custom_auth_unsigned/README.md b/samples/mqtt/mqtt5_custom_auth_unsigned/README.md
@@ -70,7 +70,7 @@ Note that in a real application, you may want to avoid the use of wildcards in y
 
 ## How to build
 
-To build the sample, change directory into the samples folder and run the cmake commands. The sample executable will be built under `samples/mqtt/mqtt5_custom_auth_unsigned/build` folder.
+To build the sample, change directory into the sample's folder and run the cmake commands. The sample executable will be built into the `samples/mqtt/mqtt5_custom_auth_unsigned/build` folder.
 ```sh
 cd samples/mqtt/mqtt5_custom_auth_unsigned/
 # If you followed the SDK build instruction, you would use the path to `sdk-workspace` folder for `CMAKE_PREFIX_PATH` here
@@ -80,9 +80,10 @@ cmake --build build --config "Debug"
 
 ## How to run
 
-To run this sample from the `samples/mqtt/mqtt5_custom_auth_unsigned` folder, use the following command:
+To run this sample, navigate to the build directory where the executable was created:
 
 ```sh
+# From samples/mqtt/mqtt5_custom_auth_unsigned/, go to the build directory
 cd build
 ./mqtt5_custom_auth_unsigned \
   --endpoint <AWS IoT endpoint> \
@@ -116,4 +117,4 @@ optional arguments:
 The sample will not run without the required arguments and will notify you of missing arguments.
 
 ## Additional Information
-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#client-lifecycle-management), [connection methods](../../../documents/MQTT5_Userguide.md#connecting-to-aws-iot-core), and other useful information.
+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#client-lifecycle-management), [connection methods](../../../documents/MQTT5_Userguide.md#connecting-to-aws-iot-core), and other useful information.
diff --git a/samples/mqtt/mqtt5_pkcs11/README.md b/samples/mqtt/mqtt5_pkcs11/README.md
@@ -71,7 +71,7 @@ Note that in a real application, you may want to avoid the use of wildcards in y
 
 ## How to build
 
-To build the sample, change directory into the samples folder and run the cmake commands. The sample executable will be built under `samples/mqtt/mqtt5_pkcs11/build` folder.
+To build the sample, change directory into the sample's folder and run the cmake commands. The sample executable will be built into the `samples/mqtt/mqtt5_pkcs11/build` folder.
 ```sh
 cd samples/mqtt/mqtt5_pkcs11/
 # If you followed the SDK build instruction, you would use the path to `sdk-workspace` folder for `CMAKE_PREFIX_PATH` here
@@ -81,9 +81,10 @@ cmake --build build --config "Debug"
 
 ## How to run
 
-To run this sample from the `samples/mqtt/mqtt5_pkcs11` folder, use the following command:
+To run this sample, navigate to the build directory where the executable was created:
 
 ```sh
+# From samples/mqtt/mqtt5_pkcs11/, go to the build directory
 cd build
 ./mqtt5_pkcs11 \
   --endpoint <AWS IoT endpoint> \
@@ -180,4 +181,4 @@ The steps to use [SoftHSM2](https://www.opendnssec.org/softhsm/) as the PKCS#11
     ```
   
 ## Additional Information
-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#client-lifecycle-management), [connection methods](../../../documents/MQTT5_Userguide.md#connecting-to-aws-iot-core), and other useful information.
+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#client-lifecycle-management), [connection methods](../../../documents/MQTT5_Userguide.md#connecting-to-aws-iot-core), and other useful information.
diff --git a/samples/mqtt/mqtt5_x509/README.md b/samples/mqtt/mqtt5_x509/README.md
@@ -69,7 +69,7 @@ Note that in a real application, you may want to avoid the use of wildcards in y
 
 ## How to build
 
-To build the sample, change directory into the samples folder and run the cmake commands. The sample executable will be built under `samples/mqtt/mqtt5_x509/build` folder.
+To build the sample, change directory into the sample's folder and run the cmake commands. The sample executable will be built into the `samples/mqtt/mqtt5_x509/build` folder.
 ```sh
 cd samples/mqtt/mqtt5_x509/
 # If you followed the SDK build instruction, you would use the path to `sdk-workspace` folder for `CMAKE_PREFIX_PATH` here
@@ -79,9 +79,10 @@ cmake --build build --config "Debug"
 
 ## How to run
 
-To run this sample from the `samples/mqtt/mqtt5_x509` folder, use the following command:
+To run this sample, navigate to the build directory where the executable was created:
 
 ```sh
+# From samples/mqtt/mqtt5_x509/, go to the build directory
 cd build
 ./mqtt5_x509 --endpoint <endpoint> --cert <path to the certificate> --key <path to the private key>
 ```
@@ -109,4 +110,4 @@ optional arguments:
 The sample will not run without the required arguments and will notify you of missing arguments.
 
 ## Additional Information
-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#client-lifecycle-management), [connection methods](../../../documents/MQTT5_Userguide.md#connecting-to-aws-iot-core), and other useful information.
+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#client-lifecycle-management), [connection methods](../../../documents/MQTT5_Userguide.md#connecting-to-aws-iot-core), and other useful information.
diff --git a/samples/others/device_defender/mqtt5_basic_report/README.md b/samples/others/device_defender/mqtt5_basic_report/README.md
@@ -65,7 +65,7 @@ This sample expects and requires the following custom metrics:
 
 ## How to build
 
-To build the sample, change directory into the samples folder and run the cmake commands. The sample executable will be built under `samples/others/device_defender/mqtt5_basic_report/build` folder.
+To build the sample, change directory into the sample's folder and run the cmake commands. The sample executable will be built into the `samples/others/device_defender/mqtt5_basic_report/build` folder.
 ```sh
 cd samples/others/device_defender/mqtt5_basic_report/
 # If you followed the SDK build instruction, you would use the path to `sdk-workspace` folder for `CMAKE_PREFIX_PATH` here
@@ -75,9 +75,10 @@ cmake --build build --config "Debug"
 
 ## How to run
 
-To run this sample from the `samples/others/device_defender/mqtt5_basic_report` folder, use the following command:
+To run this sample, navigate to the build directory where the executable was created:
 
 ```sh
+# From samples/others/device_defender/mqtt5_basic_report/, go to the build directory
 cd build
 ./mqtt5-basic-report --endpoint <endpoint> --cert <path to the certificate> --key <path to the private key> --thing_name <thing name>
 ```
diff --git a/samples/others/secure_tunneling/secure_tunnel/README.md b/samples/others/secure_tunneling/secure_tunnel/README.md
@@ -6,7 +6,7 @@ This sample uses AWS IoT [Secure Tunneling](https://docs.aws.amazon.com/iot/late
 
 ## How to build
 
-To build the sample, change directory into the samples folder and run the cmake commands. The sample executable will be built under `samples/others/secure_tunneling/secure_tunnel/build` folder.
+To build the sample, change directory into the sample's folder and run the cmake commands. The sample executable will be built into the `samples/others/secure_tunneling/secure_tunnel/build` folder.
 ```sh
 cd samples/others/secure_tunneling/secure_tunnel/
 # If you followed the SDK build instruction, you would use the path to `sdk-workspace` folder for `CMAKE_PREFIX_PATH` here
@@ -20,9 +20,10 @@ Create a new secure tunnel in the AWS IoT console (https://console.aws.amazon.co
 
 ### Destination Mode
 
-To run the sample with a destination access token in destination mode (default) from the `samples/others/secure_tunneling/secure_tunnel` folder, use the following command:
+To run the sample with a destination access token in destination mode (default), navigate to the build directory where the executable was created:
 
 ```sh
+# From samples/others/secure_tunneling/secure_tunnel/, go to the build directory
 cd build
 ./secure-tunnel --signing_region <signing_region> --access_token_file <path to destination access token>
 ```
@@ -34,6 +35,7 @@ The sample will create a Secure Tunnel connection and remain connected in `DESTI
 While the focus of the Secure Tunnel Client for the IoT Device SDK is to connect with Secure Tunnels in `DESTINATION MODE` we also support connecting in `SOURCE MODE`. The token file should be the Source Token in this instance and you must add the `--local_proxy_mode_source` flag:
 
 ```sh
+# From samples/others/secure_tunneling/secure_tunnel/, go to the build directory
 cd build
 ./secure-tunnel --signing_region <signing_region> --access_token_file <path to source access token> --local_proxy_mode_source
 ```
diff --git a/samples/others/secure_tunneling/tunnel_notification/README.md b/samples/others/secure_tunneling/tunnel_notification/README.md
@@ -59,7 +59,7 @@ Note that in a real application, you may want to avoid the use of wildcards in y
 
 ## How to build
 
-To build the sample, change directory into the samples folder and run the cmake commands. The sample executable will be built under `samples/others/secure_tunneling/tunnel_notification/build` folder.
+To build the sample, change directory into the sample's folder and run the cmake commands. The sample executable will be built into the `samples/others/secure_tunneling/tunnel_notification/build` folder.
 ```sh
 cd samples/others/secure_tunneling/tunnel_notification/
 # If you followed the SDK build instruction, you would use the path to `sdk-workspace` folder for `CMAKE_PREFIX_PATH` here
@@ -69,9 +69,10 @@ cmake --build build --config "Debug"
 
 ## How to run
 
-To run this sample from the `samples/others/secure_tunneling/tunnel_notification` folder, use the following command:
+To run this sample, navigate to the build directory where the executable was created:
 
 ```sh
+# From samples/others/secure_tunneling/tunnel_notification/, go to the build directory
 cd build
 ./tunnel-notification --endpoint <endpoint> --cert <path to the certificate> --key <path to the private key> --thing_name <thing name>
 ```
diff --git a/samples/service_clients/commands/commands-sandbox/README.md b/samples/service_clients/commands/commands-sandbox/README.md
@@ -2,6 +2,7 @@
 
 [**Return to main sample list**](../../README.md)
 
+## Introduction
 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)
 service to receive and process remote instructions.
 
@@ -57,7 +58,7 @@ Miscellaneous
 * close-stream <stream-id> - close a specified stream; <stream-id> is internal ID that can be found with 'list-streams'
 * quit - quit the sample application
 
-### Prerequisites
+## Prerequisites
 Your IoT Core 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
 in order to perform its data plane operations. Below is a sample policy that can be used on your IoT Core Thing that will
 allow this sample to run as intended.
@@ -141,9 +142,10 @@ Replace with the following with the data from your AWS account:
 
 </details>
 
-## Building and Running the Sample
+## Walkthrough
 
-### Install the SDK
+### Run the sample
+#### Install the SDK
 Before building and running the sample, you must first build and install the SDK:
 
 ```shell
@@ -152,20 +154,21 @@ cmake -S . -B build/ -DCMAKE_INSTALL_PREFIX=<sdk_install_path>
 cmake --build build/ --target install
 ```
 
-### How to build
+#### How to build
 
-To build the sample, change directory into the samples folder and run the cmake commands. The sample executable will be built under `samples/service_clients/commands/commands-sandbox/build` folder.
+To build the sample, change directory into the sample's folder and run the cmake commands. The sample executable will be built into the `samples/service_clients/commands/commands-sandbox/build` folder.
 ```sh
 cd samples/service_clients/commands/commands-sandbox/
 cmake -S . -B build/ -DCMAKE_PREFIX_PATH=<sdk_install_path>
 cmake --build build/
 ```
 
-### How to run
+#### How to run
 
-To run this sample from the `samples/service_clients/commands/commands-sandbox` folder, use the following command:
+To run this sample, navigate to the build directory where the executable was created:
 
 ```sh
+# From samples/service_clients/commands/commands-sandbox/, go to the build directory
 cd build
 ./commands-sandbox \
     --endpoint <endpoint> \
@@ -527,3 +530,13 @@ distinguishes only JSON and CBOR, all other payload format will be  routed to th
    separate thread(s).
 3. If your application is expected to receive a lot of AWS IoT commands, monitor the number of them enqueued for processing.
    Consider introducing priorities based on AWS IoT command timeouts or some internal value.
+
+## ⚠️ Usage disclaimer
+
+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/).
+
+Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:
+
+- Be aware of the resources that these examples create or delete.
+- Be aware of the costs that might be charged to your account as a result.
+- Back up your important data.
diff --git a/samples/service_clients/fleet_provisioning/provision-basic/README.md b/samples/service_clients/fleet_provisioning/provision-basic/README.md
diff --git a/samples/service_clients/fleet_provisioning/provision-csr/README.md b/samples/service_clients/fleet_provisioning/provision-csr/README.md
diff --git a/samples/service_clients/jobs/jobs-sandbox/README.md b/samples/service_clients/jobs/jobs-sandbox/README.md
diff --git a/samples/service_clients/shadow/shadow-sandbox/README.md b/samples/service_clients/shadow/shadow-sandbox/README.md
