:doc:`ConnectCases <../../connectcases>` / Paginator / ListCaseRules

*************
ListCaseRules
*************



.. py:class:: ConnectCases.Paginator.ListCaseRules

  ::

    
    paginator = client.get_paginator('list_case_rules')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`ConnectCases.Client.list_case_rules`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ListCaseRules>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          domainId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type domainId: string
    :param domainId: **[REQUIRED]** 

      Unique identifier of a Cases domain.

      

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

      
      ::

        {
            'caseRules': [
                {
                    'caseRuleId': 'string',
                    'name': 'string',
                    'caseRuleArn': 'string',
                    'ruleType': 'Required'|'Hidden'|'FieldOptions',
                    'description': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **caseRules** *(list) --* 

          A list of field summary objects.

          
          

          - *(dict) --* 

            Summary information of this case rule. In the Amazon Connect admin website, case rules are known as *case field conditions*. For more information about case field conditions, see `Add case field conditions to a case template <https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html>`__.

            
            

            - **caseRuleId** *(string) --* 

              Unique identifier of a case rule.

              
            

            - **name** *(string) --* 

              Name of the case rule.

              
            

            - **caseRuleArn** *(string) --* 

              The Amazon Resource Name (ARN) of the case rule.

              
            

            - **ruleType** *(string) --* 

              Possible types for a rule.

              
            

            - **description** *(string) --* 

              Description of a case rule.

              
        
      
        

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

          A token to resume pagination.

          
    