ConnectCases / Client / list_case_rules

list_case_rules¶

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.

Request Syntax

response = client.list_case_rules(
    domainId='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

domainId (string) –
[REQUIRED]

Unique identifier of a Cases domain.
maxResults (integer) – The maximum number of results to return per page.
nextToken (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'caseRules': [
        {
            'caseRuleId': 'string',
            'name': 'string',
            'caseRuleArn': 'string',
            'ruleType': 'Required',
            '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.
    - 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

ConnectCases.Client.exceptions.InternalServerException
ConnectCases.Client.exceptions.ResourceNotFoundException
ConnectCases.Client.exceptions.ValidationException
ConnectCases.Client.exceptions.ThrottlingException
ConnectCases.Client.exceptions.AccessDeniedException