Skip to main content

ISESV2ListContactsRequest

Interface in AWS.SESV2

Interface for ListContacts requests.

Ancestors

Properties

ContactListName

property ContactListName: string

The name of the contact list containing the contacts to retrieve.

This specifies the contact list from which to retrieve contacts. The contact list must exist in your SES account and contain the contacts you want to list. Use this parameter to target a specific subscriber group or topic-based contact collection for contact management operations.

Filter

property Filter: ISESV2ListContactsFilter

Type: ISESV2ListContactsFilter

A filter that can be applied to the list of contacts.

This optional filter allows you to narrow the results based on subscription status or specific topic preferences. Use filters to retrieve only contacts that match specific criteria. The filter can specify opt-in status (OPT_IN or OPT_OUT) or topic-specific subscription preferences to target particular subscriber segments. If no filter is specified, all contacts in the contact list will be returned (subject to pagination limits).