class Aws::SESV2::Types::ListContactsRequest
@note When making an API call, you may pass ListContactsRequest
data as a hash: { contact_list_name: "ContactListName", # required filter: { filtered_status: "OPT_IN", # accepts OPT_IN, OPT_OUT topic_filter: { topic_name: "TopicName", use_default_if_preference_unavailable: false, }, }, page_size: 1, next_token: "NextToken", }
@!attribute [rw] contact_list_name
The name of the contact list. @return [String]
@!attribute [rw] filter
A filter that can be applied to a list of contacts. @return [Types::ListContactsFilter]
@!attribute [rw] page_size
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. @return [Integer]
@!attribute [rw] next_token
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. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListContactsRequest AWS API Documentation
Constants
- SENSITIVE