ConnectCases / Paginator / ListCaseRules

ListCaseRules

class ConnectCases.Paginator.ListCaseRules

paginator = client.get_paginator('list_case_rules')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ConnectCases.Client.list_case_rules().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    domainId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• domainId (string) –

  [REQUIRED]

  Unique identifier of a Cases domain.

• PaginationConfig (dict) –

  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.

Return type:

dict

Returns:

Response Syntax

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

      • caseRuleArn (string) –

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

      • caseRuleId (string) –

        Unique identifier of a case rule.

      • description (string) –

        Description of a case rule.

      • name (string) –

        Name of the case rule.

      • ruleType (string) –

        Possible types for a rule.

  • NextToken (string) –

    A token to resume pagination.