:doc:`ConnectCases <../../connectcases>` / Client / list_case_rules

***************
list_case_rules
***************



.. py:method:: ConnectCases.Client.list_case_rules(**kwargs)

  

  Lists all case rules in a Cases domain. 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>`__.

  

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


  **Request Syntax**
  ::

    response = client.list_case_rules(
        domainId='string',
        maxResults=123,
        nextToken='string'
    )
    
  :type domainId: string
  :param domainId: **[REQUIRED]** 

    Unique identifier of a Cases domain.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return per page.

    

  
  :type nextToken: string
  :param nextToken: 

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    

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

        The token for the next set of results. This is null if there are no more results to return.

        
  
  **Exceptions**
  
  *   :py:class:`ConnectCases.Client.exceptions.InternalServerException`

  
  *   :py:class:`ConnectCases.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`ConnectCases.Client.exceptions.ValidationException`

  
  *   :py:class:`ConnectCases.Client.exceptions.ThrottlingException`

  
  *   :py:class:`ConnectCases.Client.exceptions.AccessDeniedException`

  