:doc:`Connect <../../connect>` / Paginator / ListRules

*********
ListRules
*********



.. py:class:: Connect.Paginator.ListRules

  ::

    
    paginator = client.get_paginator('list_rules')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Connect.Client.list_rules`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRules>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          InstanceId='string',
          PublishStatus='DRAFT'|'PUBLISHED',
          EventSourceName='OnPostCallAnalysisAvailable'|'OnRealTimeCallAnalysisAvailable'|'OnRealTimeChatAnalysisAvailable'|'OnPostChatAnalysisAvailable'|'OnZendeskTicketCreate'|'OnZendeskTicketStatusUpdate'|'OnSalesforceCaseCreate'|'OnContactEvaluationSubmit'|'OnMetricDataUpdate'|'OnCaseCreate'|'OnCaseUpdate'|'OnSlaBreach',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type InstanceId: string
    :param InstanceId: **[REQUIRED]** 

      The identifier of the Amazon Connect instance. You can `find the instance ID <https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html>`__ in the Amazon Resource Name (ARN) of the instance.

      

    
    :type PublishStatus: string
    :param PublishStatus: 

      The publish status of the rule.

      

    
    :type EventSourceName: string
    :param EventSourceName: 

      The name of the event source.

      

    
    :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**

      
      ::

        {
            'RuleSummaryList': [
                {
                    'Name': 'string',
                    'RuleId': 'string',
                    'RuleArn': 'string',
                    'EventSourceName': 'OnPostCallAnalysisAvailable'|'OnRealTimeCallAnalysisAvailable'|'OnRealTimeChatAnalysisAvailable'|'OnPostChatAnalysisAvailable'|'OnZendeskTicketCreate'|'OnZendeskTicketStatusUpdate'|'OnSalesforceCaseCreate'|'OnContactEvaluationSubmit'|'OnMetricDataUpdate'|'OnCaseCreate'|'OnCaseUpdate'|'OnSlaBreach',
                    'PublishStatus': 'DRAFT'|'PUBLISHED',
                    'ActionSummaries': [
                        {
                            'ActionType': 'CREATE_TASK'|'ASSIGN_CONTACT_CATEGORY'|'GENERATE_EVENTBRIDGE_EVENT'|'SEND_NOTIFICATION'|'CREATE_CASE'|'UPDATE_CASE'|'ASSIGN_SLA'|'END_ASSOCIATED_TASKS'|'SUBMIT_AUTO_EVALUATION'
                        },
                    ],
                    'CreatedTime': datetime(2015, 1, 1),
                    'LastUpdatedTime': datetime(2015, 1, 1)
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **RuleSummaryList** *(list) --* 

          Summary information about a rule.

          
          

          - *(dict) --* 

            A list of ``ActionTypes`` associated with a rule.

            
            

            - **Name** *(string) --* 

              The name of the rule.

              
            

            - **RuleId** *(string) --* 

              A unique identifier for the rule.

              
            

            - **RuleArn** *(string) --* 

              The Amazon Resource Name (ARN) of the rule.

              
            

            - **EventSourceName** *(string) --* 

              The name of the event source.

              
            

            - **PublishStatus** *(string) --* 

              The publish status of the rule.

              
            

            - **ActionSummaries** *(list) --* 

              A list of ActionTypes associated with a rule.

              
              

              - *(dict) --* 

                Information about an action.

                
                

                - **ActionType** *(string) --* 

                  The action type.

                  
            
          
            

            - **CreatedTime** *(datetime) --* 

              The timestamp for when the rule was created.

              
            

            - **LastUpdatedTime** *(datetime) --* 

              The timestamp for when the rule was last updated.

              
        
      
    