CustomerProfiles / Paginator / ListSegmentSubscriptionEvents

ListSegmentSubscriptionEvents

class CustomerProfiles.Paginator.ListSegmentSubscriptionEvents

paginator = client.get_paginator('list_segment_subscription_events')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CustomerProfiles.Client.list_segment_subscription_events().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• DomainName (string) –

  [REQUIRED]

  The unique name of the domain.

• SegmentDefinitionName (string) –

  [REQUIRED]

  The unique name of the segment definition.

• 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

{
    'Events': [
        {
            'ProfileId': 'string',
            'UpdatedAt': datetime(2015, 1, 1),
            'EventType': 'LIVE'|'SCHEDULE',
            'Event': 'JOINED'|'LEFT'
        },
    ],

}

Response Structure

• (dict) –

  • Events (list) –

    A list of segment membership events.

    • (dict) –

      Represents a single segment membership event.

      • ProfileId (string) –

        The unique identifier of a customer profile.

      • UpdatedAt (datetime) –

        The timestamp of when the membership change was detected.

      • EventType (string) –

        The type of event that triggered the membership change. The following are valid values:

        • LIVE: Real-time event triggered by a profile or calculated attribute change (Classic segments only).

        • SCHEDULE: Event generated during a scheduled execution.

      • Event (string) –

        Whether the profile joined or left the segment. The following are valid values:

        • JOINED: The profile joined the segment.

        • LEFT: The profile left the segment.