diff --git a/awsiot/greengrasscoreipc/__init__.py b/awsiot/greengrasscoreipc/__init__.py index c60e68f8..02a9203b 100644 --- a/awsiot/greengrasscoreipc/__init__.py +++ b/awsiot/greengrasscoreipc/__init__.py @@ -25,7 +25,8 @@ def connect(*, lifecycle_handler: Optional[LifecycleHandler]=None, timeout: float=10.0) -> GreengrassCoreIPCClient: """ - Creates an IPC client and connects to the GreengrassCoreIPC service. + Creates an IPC client and connects to the GreengrassCoreIPC service. When finished with the client, + you must call close() to free the client's native resources. Args: ipc_socket: Path to the Unix domain socket of Greengrass Nucleus, defaults to diff --git a/awsiot/greengrasscoreipc/client.py b/awsiot/greengrasscoreipc/client.py index 7367b6eb..a1cf371e 100644 --- a/awsiot/greengrasscoreipc/client.py +++ b/awsiot/greengrasscoreipc/client.py @@ -1340,7 +1340,10 @@ def close(self): # type: (...) -> concurrent.futures.Future[None] class GreengrassCoreIPCClient(rpc.Client): """ - Client for the GreengrassCoreIPC service. + Client for the GreengrassCoreIPC service. When finished with the client, + you must call close() to free the client's native resources. + + There is a new V2 client which should be preferred. See the GreengrassCoreIPCClientV2 class in the clientv2 subpackage. diff --git a/awsiot/greengrasscoreipc/clientv2.py b/awsiot/greengrasscoreipc/clientv2.py index b8f85220..256a2c94 100644 --- a/awsiot/greengrasscoreipc/clientv2.py +++ b/awsiot/greengrasscoreipc/clientv2.py @@ -14,7 +14,8 @@ class GreengrassCoreIPCClientV2: """ - V2 client for the GreengrassCoreIPC service. + V2 client for the GreengrassCoreIPC service. When finished with the client, + you must call close() to free the client's native resources. Args: client: Connection that this client will use. If you do not provide one, it will be made automatically.