:doc:`IoT <../../iot>` / Paginator / ListTopicRules

**************
ListTopicRules
**************



.. py:class:: IoT.Paginator.ListTopicRules

  ::

    
    paginator = client.get_paginator('list_topic_rules')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`IoT.Client.list_topic_rules`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iot-2015-05-28/ListTopicRules>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          topic='string',
          ruleDisabled=True|False,
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type topic: string
    :param topic: 

      The topic.

      

    
    :type ruleDisabled: boolean
    :param ruleDisabled: 

      Specifies whether the rule is disabled.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'rules': [
                {
                    'ruleArn': 'string',
                    'ruleName': 'string',
                    'topicPattern': 'string',
                    'createdAt': datetime(2015, 1, 1),
                    'ruleDisabled': True|False
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

        The output from the ListTopicRules operation.

        
        

        - **rules** *(list) --* 

          The rules.

          
          

          - *(dict) --* 

            Describes a rule.

            
            

            - **ruleArn** *(string) --* 

              The rule ARN.

              
            

            - **ruleName** *(string) --* 

              The name of the rule.

              
            

            - **topicPattern** *(string) --* 

              The pattern for the topic names that apply.

              
            

            - **createdAt** *(datetime) --* 

              The date and time the rule was created.

              
            

            - **ruleDisabled** *(boolean) --* 

              Specifies whether the rule is disabled.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    