IoTDataPlane / Paginator / ListSubscriptions

ListSubscriptions

class IoTDataPlane.Paginator.ListSubscriptions

paginator = client.get_paginator('list_subscriptions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTDataPlane.Client.list_subscriptions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    clientId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • subscriptions (list) –

    A list of topic filters and their associated Quality of Service (QoS) levels that the client is subscribed to.

    • (dict) –

      Contains information about a subscription for an MQTT client, including the topic filter and Quality of Service (QoS) level.

      • topicFilter (string) –

        The topic filter pattern that the client is subscribed to. May include MQTT wildcards such as + (single-level) and # (multi-level).

      • qos (integer) –

        The Quality of Service (QoS) level for the subscription. Valid values are 0 (at most once) and 1 (at least once).

  • NextToken (string) –

    A token to resume pagination.