IoTDataPlane / Client / list_subscriptions

list_subscriptions¶

IoTDataPlane.Client.list_subscriptions(**kwargs)¶

Returns a list of all subscriptions for MQTT clients with active sessions, including offline clients with persistent sessions.

Requires permission to access the ListSubscriptions action.

response = client.list_subscriptions(
    clientId='string',
    nextToken='string',
    maxResults=123
)

Parameters:

clientId (string) –
[REQUIRED]

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

MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters.
nextToken (string) – To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
maxResults (integer) – The maximum number of subscriptions to return in a single request. By default, this is set to 20.

Return type:

dict

Returns:

{
    'subscriptions': [
        {
            'topicFilter': 'string',
            'qos': 123
        },
    ],
    'nextToken': 'string'
}