Connect / Paginator / ListRules

ListRules

class Connect.Paginator.ListRules

paginator = client.get_paginator('list_rules')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Connect.Client.list_rules().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    PublishStatus='DRAFT'|'PUBLISHED',
    EventSourceName='OnPostCallAnalysisAvailable'|'OnRealTimeCallAnalysisAvailable'|'OnPostChatAnalysisAvailable'|'OnZendeskTicketCreate'|'OnZendeskTicketStatusUpdate'|'OnSalesforceCaseCreate',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• InstanceId (string) –

  [REQUIRED]

  The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

• PublishStatus (string) – The publish status of the rule.

• EventSourceName (string) – The name of the event source.

• 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

{
    'RuleSummaryList': [
        {
            'Name': 'string',
            'RuleId': 'string',
            'RuleArn': 'string',
            'EventSourceName': 'OnPostCallAnalysisAvailable'|'OnRealTimeCallAnalysisAvailable'|'OnPostChatAnalysisAvailable'|'OnZendeskTicketCreate'|'OnZendeskTicketStatusUpdate'|'OnSalesforceCaseCreate',
            'PublishStatus': 'DRAFT'|'PUBLISHED',
            'ActionSummaries': [
                {
                    'ActionType': 'CREATE_TASK'|'ASSIGN_CONTACT_CATEGORY'|'GENERATE_EVENTBRIDGE_EVENT'|'SEND_NOTIFICATION'
                },
            ],
            '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.