You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::SESV2::Types::ListContactsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::SESV2::Types::ListContactsRequest
- Defined in:
- (unknown)
Overview
When passing ListContactsRequest as input to an Aws::Client method, you can use a vanilla 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",
}
Instance Attribute Summary collapse
-
#contact_list_name ⇒ String
The name of the contact list.
-
#filter ⇒ Types::ListContactsFilter
A filter that can be applied to a list of contacts.
-
#next_token ⇒ String
A string token indicating that there might be additional contacts available to be listed.
-
#page_size ⇒ Integer
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.
Instance Attribute Details
#contact_list_name ⇒ String
The name of the contact list.
#filter ⇒ Types::ListContactsFilter
A filter that can be applied to a list of contacts.
#next_token ⇒ String
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.
#page_size ⇒ Integer
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.