Skip to content

ListContactsRequest

Source code in docs_src/capo_sesv2/types/list_contacts_request.py 
14
15
16
17
18
19
20
21
22
class ListContactsRequest(TypedDict, closed=True):
    contact_list_name: "capo_sesv2.types.contact_list_name.ContactListName"
    """<p>The name of the contact list.</p>"""
    filter: NotRequired["capo_sesv2.types.list_contacts_filter.ListContactsFilter"]
    """<p>A filter that can be applied to a list of contacts.</p>"""
    page_size: NotRequired["capo_sesv2.types.max_items.MaxItems"]
    """<p>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 <code>NextToken</code> element is sent in the response. Use the <code>NextToken</code> value in subsequent requests to retrieve additional contacts.</p>"""
    next_token: NotRequired["capo_sesv2.types.next_token.NextToken"]
    """<p>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.</p>"""

contact_list_name instance-attribute 

contact_list_name: ContactListName

The name of the contact list.

filter instance-attribute 

filter: NotRequired[ListContactsFilter]

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

next_token instance-attribute 

next_token: NotRequired[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.

page_size instance-attribute 

page_size: NotRequired[MaxItems]

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.