From 4b6909053b8395b1b14007ff36f7454d6bc6fc53 Mon Sep 17 00:00:00 2001
From: Steve Kim <86316075+sbSteveK@users.noreply.github.com>
Date: Wed, 24 Jan 2024 09:34:40 -0800
Subject: [PATCH] add note about keep alive and relation to ping timeout (#549)

---
 awsiot/mqtt5_client_builder.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/awsiot/mqtt5_client_builder.py b/awsiot/mqtt5_client_builder.py
index 6f8adda4..9f2ab0e4 100644
--- a/awsiot/mqtt5_client_builder.py
+++ b/awsiot/mqtt5_client_builder.py
@@ -36,7 +36,8 @@
         between the point at which the client finishes transmitting one MQTT packet and the point it starts
         sending the next.  The client will use PINGREQ packets to maintain this property. If the responding
         CONNACK contains a keep alive property value, then that is the negotiated keep alive value. Otherwise,
-        the keep alive sent by the client is the negotiated value.
+        the keep alive sent by the client is the negotiated value. keep_alive_interval_sec must be set to at
+        least 1 second greater than ping_timeout_ms (default 30,000 ms) or it will fail validation.
 
     **username** (`str`): Username to connect with.