boto3-refresh-session 5.1.0__py3-none-any.whl → 5.1.2__py3-none-any.whl

boto3_refresh_session/__init__.py

@@ -9,7 +9,7 @@ from .session import *
 
 __all__.extend(session.__all__)
 __all__.extend(exceptions.__all__)
-__version__ = "5.1.0"
+__version__ = "5.1.2"
 __title__ = "boto3-refresh-session"
 __author__ = "Mike Letts"
 __maintainer__ = "Mike Letts"

boto3_refresh_session/methods/iot/x509.py

@@ -382,6 +382,8 @@ class IOTX509RefreshableSession(
     ) -> Connection:
         """Establishes an MQTT connection using the specified parameters.
 
+        .. versionadded:: 5.1.0
+
         Parameters
         ----------
         endpoint: str
@@ -390,30 +392,30 @@ class IOTX509RefreshableSession(
             The client ID to use for the MQTT connection.
         transport: Transport
             The transport protocol to use (e.g., "x509" or "ws").
-        certificate: str | bytes | None
+        certificate: str | bytes | None, optional
             The client certificate to use for the connection. Defaults to the
             session certificate.
-        private_key: str | bytes | None
+        private_key: str | bytes | None, optional
             The private key to use for the connection. Defaults to the
             session private key.
-        ca: str | bytes | None
+        ca: str | bytes | None, optional
             The CA certificate to use for the connection. Defaults to the
             session CA certificate.
-        pkcs11: PKCS11 | None
+        pkcs11: PKCS11 | None, optional
             PKCS#11 configuration for hardware-backed keys. Defaults to the
             session PKCS#11 configuration.
-        region: str | None
+        region: str | None, optional
             The AWS region to use for the connection. Defaults to the
             session region.
-        keep_alive_secs: int
+        keep_alive_secs: int, optional
             The keep-alive interval for the MQTT connection. Default is 60
             seconds.
-        clean_start: bool
+        clean_start: bool, optional
             Whether to start a clean session. Default is True.
-        port: int | None
+        port: int | None, optional
             The port to use for the MQTT connection. Default is 8883 if not
             using ALPN, otherwise 443.
-        use_alpn: bool
+        use_alpn: bool, optional
             Whether to use ALPN for the connection. Default is False.
 
         Returns

{boto3_refresh_session-5.1.0.dist-info → boto3_refresh_session-5.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: boto3-refresh-session
-Version: 5.1.0
+Version: 5.1.2
 Summary: A simple Python package for refreshing the temporary security credentials in a boto3.session.Session object automatically.
 License: MIT
 Keywords: boto3,botocore,aws,sts,credentials,token,refresh,iot,x509,mqtt
@@ -341,6 +341,22 @@ pip install boto3-refresh-session
   )
   ```
 
+  ### MQTT
+
+  After initializing a session object, you can can begin making actions with MQTT using the [mqtt method](https://github.com/michaelthomasletts/boto3-refresh-session/blob/deb68222925bf648f26e878ed4bc24b45317c7db/boto3_refresh_session/methods/iot/x509.py#L367)! You can reuse the same certificate, private key, et al as that used to initialize `RefreshableSession`. Or, alternatively, you can provide separate PKCS#11 or certificate information, whether those be file paths or bytes values. Either way, at a minimum, you will need to provide the endpoint and client identifier (i.e. thing name).
+
+  ```python
+  from awscrt.mqtt.QoS import AT_LEAST_ONCE
+  conn = session.mqtt(
+    endpoint="<your endpoint>-ats.iot.<region>.amazonaws.com",
+    client_id="<your thing name or client ID>",
+  )
+  conn.connect()
+  conn.connect().result()
+  conn.publish(topic="foo/bar", payload=b"hi", qos=AT_LEAST_ONCE)
+  conn.disconnect().result()
+  ```
+
 </details>
 
 ## ⚠️ Changes

{boto3_refresh_session-5.1.0.dist-info → boto3_refresh_session-5.1.2.dist-info}/RECORD

@@ -1,17 +1,17 @@
-boto3_refresh_session/__init__.py,sha256=BOqwA_sI0eFBBREAPZzmTkWl9GT-7MfaRs3vvNmu8B8,415
+boto3_refresh_session/__init__.py,sha256=ChSYpFrZdY-6bITfZK9jwA8zYhlabF_oy7DTN6b5Kw0,415
 boto3_refresh_session/exceptions.py,sha256=QS5_xy3hNrfkdT_wKPZWH8WqSbFYCKPcK8DomGYIvcU,1218
 boto3_refresh_session/methods/__init__.py,sha256=FpwWixSVpy_6pUe1u4fXmjO-_fDH--qTk_xrMnBCHxU,193
 boto3_refresh_session/methods/custom.py,sha256=MLdUMU9s6NQoJWBKQ5Fsxeyxb_Xrm9V59pVX22M8fyI,4178
 boto3_refresh_session/methods/iot/__init__.py,sha256=wIYp7HFZ_Q8XEHwWmpKjDNXxBm29C0RisP_9GSVwzZI,147
 boto3_refresh_session/methods/iot/core.py,sha256=xtvbC23h6fw06lRZWN4r7TlnUEf3t9T7-zSPGCSlSLI,1151
-boto3_refresh_session/methods/iot/x509.py,sha256=RipL5xlKAFh__CUodM5hdNAziQ9JiXbG6SFZh5KYDvU,19789
+boto3_refresh_session/methods/iot/x509.py,sha256=3j6gbZQAZnznZuNEipMyvOqux2RRDgQ65rxlF6LKVZE,19912
 boto3_refresh_session/methods/sts.py,sha256=NGqJFJNLjG9Mve7o19tb_i6lvgQW1HoALIqF6lJNV9A,3336
 boto3_refresh_session/session.py,sha256=UM_dWHSo0Wn8gLN99zg36SRVb-Yy_to1wk8UgZEuQZA,2086
 boto3_refresh_session/utils/__init__.py,sha256=6F2ErbgBT2ZmZwFF3OzvQEd1Vh4XM3kaL6YGMTrcrkQ,156
 boto3_refresh_session/utils/internal.py,sha256=HbuIzT0pC8QS4pgNj3M7POGaW-OEz2l3ESfYI1Qouuo,7072
 boto3_refresh_session/utils/typing.py,sha256=YbnVYPe-ZEr79THp78u74PzF6LOIxpf91yGsvBmhEBM,3532
-boto3_refresh_session-5.1.0.dist-info/LICENSE,sha256=I3ZYTXAjbIly6bm6J-TvFTuuHwTKws4h89QaY5c5HiY,1067
-boto3_refresh_session-5.1.0.dist-info/METADATA,sha256=H_O81yjNw4JvCvRKzc5au7mVibqcLEY2WktLercl-ow,14188
-boto3_refresh_session-5.1.0.dist-info/NOTICE,sha256=1s8r33qbl1z0YvPB942iWgvbkP94P_e8AnROr1qXXuw,939
-boto3_refresh_session-5.1.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-boto3_refresh_session-5.1.0.dist-info/RECORD,,
+boto3_refresh_session-5.1.2.dist-info/LICENSE,sha256=I3ZYTXAjbIly6bm6J-TvFTuuHwTKws4h89QaY5c5HiY,1067
+boto3_refresh_session-5.1.2.dist-info/METADATA,sha256=J6ydZAYJeMMUmzaHHPNsqueNepZDLTddo2wnFEI_mbg,15135
+boto3_refresh_session-5.1.2.dist-info/NOTICE,sha256=1s8r33qbl1z0YvPB942iWgvbkP94P_e8AnROr1qXXuw,939
+boto3_refresh_session-5.1.2.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+boto3_refresh_session-5.1.2.dist-info/RECORD,,