List Contacts

sesv2_list_contacts

R Documentation

Lists the contacts present in a specific contact list

Description

Lists the contacts present in a specific contact list.

Usage

sesv2_list_contacts(ContactListName, Filter, PageSize, NextToken)

Arguments

ContactListName

[required] The name of the contact list.

Filter

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

PageSize

The number of contacts that may be returned at once, which is dependent on if there are more or less contacts than the value of the PageSize. Use this parameter to paginate results. If additional contacts exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional contacts.

NextToken

A string token indicating that there might be additional contacts available to be listed. Use the token provided in the Response to use in the subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.

Value

A list with the following syntax:

list(
  Contacts = list(
    list(
      EmailAddress = "string",
      TopicPreferences = list(
        list(
          TopicName = "string",
          SubscriptionStatus = "OPT_IN"|"OPT_OUT"
        )
      ),
      TopicDefaultPreferences = list(
        list(
          TopicName = "string",
          SubscriptionStatus = "OPT_IN"|"OPT_OUT"
        )
      ),
      UnsubscribeAll = TRUE|FALSE,
      LastUpdatedTimestamp = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_contacts(
  ContactListName = "string",
  Filter = list(
    FilteredStatus = "OPT_IN"|"OPT_OUT",
    TopicFilter = list(
      TopicName = "string",
      UseDefaultIfPreferenceUnavailable = TRUE|FALSE
    )
  ),
  PageSize = 123,
  NextToken = "string"
)