Merge branch 'cipher_suite' of https://github.com/aws/aws-iot-device-sdk-python-v2 into cipher_suite

xiazhvera · xiazhvera · commit 552bcc70f43c · 2025-09-29T15:24:05.000-07:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -93,7 +93,7 @@ jobs:
         chmod a+x builder
         ./builder build -p ${{ env.PACKAGE_NAME }}
     - name: configure AWS credentials (MQTT5)
-      uses: aws-actions/configure-aws-credentials@v2
+      uses: aws-actions/configure-aws-credentials@v4
       with:
         role-to-assume: ${{ env.CI_MQTT5_ROLE }}
         aws-region: ${{ env.AWS_DEFAULT_REGION }}
@@ -129,7 +129,7 @@ jobs:
         chmod a+x builder
         ./builder build -p ${{ env.PACKAGE_NAME }}
     - name: configure AWS credentials (MQTT5)
-      uses: aws-actions/configure-aws-credentials@v2
+      uses: aws-actions/configure-aws-credentials@v4
       with:
         role-to-assume: ${{ env.CI_MQTT5_ROLE }}
         aws-region: ${{ env.AWS_DEFAULT_REGION }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -68,7 +68,7 @@ jobs:
         force: true
 
     - name: configure AWS credentials (Release)
-      uses: aws-actions/configure-aws-credentials@v2
+      uses: aws-actions/configure-aws-credentials@v4
       with:
         role-to-assume: arn:aws:iam::180635532705:role/CI_V2_RELEASE_S3_ROLE
         aws-region: us-east-1
diff --git a/README.md b/README.md
@@ -90,4 +90,4 @@ is provided by code that been generated from a model of the service.
 
 This library is licensed under the [Apache 2.0 License](./documents/LICENSE).
 
-Latest released version: v1.25.0
+Latest released version: v1.26.0
diff --git a/awsiot/__init__.py b/awsiot/__init__.py
@@ -19,7 +19,7 @@
 from concurrent.futures import Future
 from dataclasses import dataclass
 import json
-from typing import Any, Callable, Dict, Generic, Optional, Tuple, TypeVar
+from typing import Any, Callable, Dict, Generic, Optional, Tuple, TypeVar, Union
 
 __version__ = '1.0.0-dev'
 
@@ -37,7 +37,7 @@ class MqttServiceClient:
         mqtt_connection: MQTT connection to use
     """
 
-    def __init__(self, mqtt_connection: mqtt.Connection or mqtt5.Client):
+    def __init__(self, mqtt_connection: Union[mqtt.Connection, mqtt5.Client]):
         if isinstance(mqtt_connection, mqtt.Connection):
             self._mqtt_connection = mqtt_connection  # type: mqtt.Connection
         elif isinstance(mqtt_connection, mqtt5.Client):
diff --git a/codebuild/cd/publish-to-prod-pypi.yml b/codebuild/cd/publish-to-prod-pypi.yml
@@ -11,7 +11,7 @@ phases:
       - sudo apt-get install python3 python3-pip -y
       - export PATH=$PATH:$HOME/.local/bin
       - python3 -m pip install --user --upgrade pip
-      - python3 -m pip install --user --upgrade twine setuptools wheel awscli PyOpenSSL six
+      - python3 -m pip install --user --upgrade twine awscli build setuptools
       - echo "\nBuild version data:"
       - echo "\nPython Version:"; python3 --version
   pre_build:
@@ -24,7 +24,7 @@ phases:
   build:
     commands:
       - echo Build started on `date`
-      - python3 setup.py sdist bdist_wheel
+      - python3 -m build
       - python3 -m twine upload -r pypi dist/*
   post_build:
     commands:
diff --git a/codebuild/cd/publish-to-test-pypi.yml b/codebuild/cd/publish-to-test-pypi.yml
@@ -11,7 +11,7 @@ phases:
       - sudo apt-get install python3 python3-pip -y
       - export PATH=$PATH:$HOME/.local/bin
       - python3 -m pip install --user --upgrade pip
-      - python3 -m pip install --user --upgrade twine setuptools wheel awscli PyOpenSSL six
+      - python3 -m pip install --user --upgrade twine awscli build setuptools
       - echo "\nBuild version data:"
       - echo "\nPython Version:"; python3 --version
   pre_build:
@@ -24,7 +24,7 @@ phases:
   build:
     commands:
       - echo Build started on `date`
-      - python3 setup.py sdist bdist_wheel
+      - python3 -m build
       - python3 -m twine upload -r testpypi dist/*
   post_build:
     commands:
diff --git a/samples/README.md b/samples/README.md
@@ -82,3 +82,13 @@ The sample will not run without the required arguments and will notify you of mi
 ### Enable Logging
 
 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).
+
+## ⚠️ 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/greengrass/basic_discovery.md b/samples/greengrass/basic_discovery.md
@@ -7,4 +7,14 @@ This sample is intended for use with the following tutorials in the AWS IoT Gree
 
 * [Connect and test client devices](https://docs.aws.amazon.com/greengrass/v2/developerguide/client-devices-tutorial.html)
 * [Test client device communications](https://docs.aws.amazon.com/greengrass/v2/developerguide/test-client-device-communications.html)
-* [Getting Started with AWS IoT Greengrass](https://docs.aws.amazon.com/greengrass/latest/developerguide/gg-gs.html)
+* [Getting Started with AWS IoT Greengrass](https://docs.aws.amazon.com/greengrass/latest/developerguide/gg-gs.html)
+
+## ⚠️ 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/greengrass/ipc_greengrass.md b/samples/greengrass/ipc_greengrass.md
@@ -97,3 +97,13 @@ Replace the following with your information:
 <br />
 
 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.
+
+## ⚠️ 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/mqtt/mqtt5_aws_websocket.md b/samples/mqtt/mqtt5_aws_websocket.md
@@ -102,3 +102,13 @@ The sample will not run without the required arguments and will notify you of mi
 
 ## 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#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.
+
+## ⚠️ 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/mqtt/mqtt5_custom_auth.md b/samples/mqtt/mqtt5_custom_auth.md
@@ -131,3 +131,13 @@ The sample will not run without the required arguments and will notify you of mi
 
 ## 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#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.
+
+## ⚠️ 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/mqtt/mqtt5_pkcs11_connect.md b/samples/mqtt/mqtt5_pkcs11_connect.md
@@ -169,3 +169,13 @@ 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#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.
+
+## ⚠️ 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/mqtt/mqtt5_x509.md b/samples/mqtt/mqtt5_x509.md
@@ -106,3 +106,13 @@ The sample will not run without the required arguments and will notify you of mi
 
 ## 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#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.
+
+## ⚠️ 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/pubsub.md b/samples/pubsub.md
@@ -0,0 +1,83 @@
+# PubSub
+
+[**Return to main sample list**](./README.md)
+
+This sample uses the
+[Message Broker](https://docs.aws.amazon.com/iot/latest/developerguide/iot-message-broker.html)
+for AWS IoT to send and receive messages through an MQTT connection.
+
+On startup, the device connects to the server, subscribes to a topic, and begins publishing messages to that topic. The device should receive those same messages back from the message broker, since it is subscribed to that same topic. Status updates are continually printed to the console. This sample demonstrates how to send and receive messages on designated IoT Core topics, an essential task that is the backbone of many IoT applications that need to send data over the internet. This sample simply subscribes and publishes to a topic, printing the messages it just sent as it is received from AWS IoT Core, but this can be used as a reference point for more complex Pub-Sub applications.
+
+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. Below is a sample policy that can be used on your IoT Core Thing that will allow this sample to run as intended.
+
+<details>
+<summary>(see sample policy)</summary>
+<pre>
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Effect": "Allow",
+      "Action": [
+        "iot:Publish",
+        "iot:Receive"
+      ],
+      "Resource": [
+        "arn:aws:iot:<b>region</b>:<b>account</b>:topic/test/topic"
+      ]
+    },
+    {
+      "Effect": "Allow",
+      "Action": [
+        "iot:Subscribe"
+      ],
+      "Resource": [
+        "arn:aws:iot:<b>region</b>:<b>account</b>:topicfilter/test/topic"
+      ]
+    },
+    {
+      "Effect": "Allow",
+      "Action": [
+        "iot:Connect"
+      ],
+      "Resource": [
+        "arn:aws:iot:<b>region</b>:<b>account</b>:client/test-*"
+      ]
+    }
+  ]
+}
+</pre>
+
+Replace with the following with the data from your AWS account:
+* `<region>`: The AWS IoT Core region where you created your AWS IoT Core thing you wish to use with this sample. For example `us-east-1`.
+* `<account>`: Your AWS IoT Core account ID. This is the set of numbers in the top right next to your AWS account name when using the AWS IoT Core website.
+
+Note that in a real application, you may want to avoid the use of wildcards in your ClientID or use them selectively. Please follow best practices when working with AWS on production applications using the SDK. Also, for the purposes of this sample, please 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.
+
+</details>
+
+## How to run
+
+To Run this sample from the `samples` folder, use the following command:
+
+```sh
+# For Windows: replace 'python3' with 'python' and '/' with '\'
+python3 pubsub.py --endpoint <endpoint> --cert <file> --key <file>
+```
+
+You can also pass a Certificate Authority file (CA) if your certificate and key combination requires it:
+
+```sh
+# For Windows: replace 'python3' with 'python' and '/' with '\'
+python3 pubsub.py --endpoint <endpoint> --cert <file> --key <file> --ca_file <file>
+```
+
+## ⚠️ 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/pubsub.py b/samples/pubsub.py
diff --git a/samples/service_clients/fleet_provisioning_basic.md b/samples/service_clients/fleet_provisioning_basic.md
diff --git a/samples/service_clients/fleet_provisioning_csr.md b/samples/service_clients/fleet_provisioning_csr.md
diff --git a/samples/service_clients/jobs.md b/samples/service_clients/jobs.md
diff --git a/samples/service_clients/shadow.md b/samples/service_clients/shadow.md

Original file line number	Diff line number	Diff line change
`@@ -90,4 +90,4 @@ is provided by code that been generated from a model of the service.`
`90`	`90`
`91`	`91`	`This library is licensed under the [Apache 2.0 License](./documents/LICENSE).`
`92`	`92`
`93`		`-Latest released version: v1.25.0`
	`93`	`+Latest released version: v1.26.0`