IoTDataPlane / Client / delete_connection

delete_connection

IoTDataPlane.Client.delete_connection(**kwargs)

Disconnects a connected MQTT client from Amazon Web Services IoT Core. When you disconnect a client, Amazon Web Services IoT Core closes the client’s network connection and optionally cleans the session state.

See also: AWS API Documentation

Request Syntax

response = client.delete_connection(
    clientId='string',
    cleanSession=True|False,
    preventWillMessage=True|False
)
Parameters:

  • clientId (string) –

    [REQUIRED]

    The unique identifier of the MQTT client to disconnect. The client ID can’t start with a dollar sign ($).

  • cleanSession (boolean) – Specifies whether to remove the client’s session state when disconnecting. Set to TRUE to delete all session information, including subscriptions and queued messages. Set to FALSE to preserve the session state. By default, this is set to FALSE (preserves the session state).

  • preventWillMessage (boolean) – Controls if Amazon Web Services IoT Core publishes the client’s Last Will and Testament (LWT) message upon disconnection. Set to TRUE to prevent publishing the LWT message. Set to FALSE to allow publishing. By default, this is set to FALSE (allows publishing the LWT message).

Returns:

None

Exceptions