IoTDataPlane / Paginator / ListRetainedMessages


class IoTDataPlane.Paginator.ListRetainedMessages#
paginator = client.get_paginator('list_retained_messages')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'

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:



Response Syntax

    'retainedTopics': [
            'topic': 'string',
            'payloadSize': 123,
            'qos': 123,
            'lastModifiedTime': 123
    'NextToken': 'string'

Response Structure

  • (dict) –

    • retainedTopics (list) –

      A summary list the account’s retained messages. The information returned doesn’t include the message payloads of the retained messages.

      • (dict) –

        Information about a single retained message.

        • topic (string) –

          The topic name to which the retained message was published.

        • payloadSize (integer) –

          The size of the retained message’s payload in bytes.

        • qos (integer) –

          The quality of service (QoS) level used to publish the retained message.

        • lastModifiedTime (integer) –

          The Epoch date and time, in milliseconds, when the retained message was stored by IoT.

    • NextToken (string) –

      A token to resume pagination.