| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.SESV2.ListContacts
Description
Lists the contacts present in a specific contact list.
Synopsis
- data ListContacts = ListContacts' {}
- newListContacts :: Text -> ListContacts
- listContacts_nextToken :: Lens' ListContacts (Maybe Text)
- listContacts_filter :: Lens' ListContacts (Maybe ListContactsFilter)
- listContacts_pageSize :: Lens' ListContacts (Maybe Int)
- listContacts_contactListName :: Lens' ListContacts Text
- data ListContactsResponse = ListContactsResponse' {}
- newListContactsResponse :: Int -> ListContactsResponse
- listContactsResponse_nextToken :: Lens' ListContactsResponse (Maybe Text)
- listContactsResponse_contacts :: Lens' ListContactsResponse (Maybe [Contact])
- listContactsResponse_httpStatus :: Lens' ListContactsResponse Int
Creating a Request
data ListContacts Source #
See: newListContacts smart constructor.
Constructors
| ListContacts' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ListContacts |
Create a value of ListContacts with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListContacts', listContacts_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.
$sel:filter':ListContacts', listContacts_filter - A filter that can be applied to a list of contacts.
$sel:pageSize:ListContacts', listContacts_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.
$sel:contactListName:ListContacts', listContacts_contactListName - The name of the contact list.
Request Lenses
listContacts_nextToken :: Lens' ListContacts (Maybe Text) Source #
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.
listContacts_filter :: Lens' ListContacts (Maybe ListContactsFilter) Source #
A filter that can be applied to a list of contacts.
listContacts_pageSize :: Lens' ListContacts (Maybe Int) Source #
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.
listContacts_contactListName :: Lens' ListContacts Text Source #
The name of the contact list.
Destructuring the Response
data ListContactsResponse Source #
See: newListContactsResponse smart constructor.
Constructors
| ListContactsResponse' | |
Fields
| |
Instances
newListContactsResponse Source #
Arguments
| :: Int | |
| -> ListContactsResponse |
Create a value of ListContactsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListContacts', listContactsResponse_nextToken - A string token indicating that there might be additional contacts
available to be listed. Copy this token to a subsequent call to
ListContacts with the same parameters to retrieve the next page of
contacts.
$sel:contacts:ListContactsResponse', listContactsResponse_contacts - The contacts present in a specific contact list.
$sel:httpStatus:ListContactsResponse', listContactsResponse_httpStatus - The response's http status code.
Response Lenses
listContactsResponse_nextToken :: Lens' ListContactsResponse (Maybe Text) Source #
A string token indicating that there might be additional contacts
available to be listed. Copy this token to a subsequent call to
ListContacts with the same parameters to retrieve the next page of
contacts.
listContactsResponse_contacts :: Lens' ListContactsResponse (Maybe [Contact]) Source #
The contacts present in a specific contact list.
listContactsResponse_httpStatus :: Lens' ListContactsResponse Int Source #
The response's http status code.