Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Searches contacts and lists the ones that meet a set of filter and sort criteria.
Synopsis
- searchContacts :: SearchContacts
- data SearchContacts
- scFilters :: Lens' SearchContacts [Filter]
- scSortCriteria :: Lens' SearchContacts [Sort]
- scNextToken :: Lens' SearchContacts (Maybe Text)
- scMaxResults :: Lens' SearchContacts (Maybe Natural)
- searchContactsResponse :: Int -> SearchContactsResponse
- data SearchContactsResponse
- scrsNextToken :: Lens' SearchContactsResponse (Maybe Text)
- scrsContacts :: Lens' SearchContactsResponse [ContactData]
- scrsTotalCount :: Lens' SearchContactsResponse (Maybe Int)
- scrsResponseStatus :: Lens' SearchContactsResponse Int
Creating a Request
searchContacts :: SearchContacts Source #
Creates a value of SearchContacts
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
scFilters
- The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.scSortCriteria
- The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.scNextToken
- An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.scMaxResults
- The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
data SearchContacts Source #
See: searchContacts
smart constructor.
Instances
Request Lenses
scFilters :: Lens' SearchContacts [Filter] Source #
The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.
scSortCriteria :: Lens' SearchContacts [Sort] Source #
The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.
scNextToken :: Lens' SearchContacts (Maybe Text) Source #
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.
scMaxResults :: Lens' SearchContacts (Maybe Natural) Source #
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Destructuring the Response
searchContactsResponse Source #
Creates a value of SearchContactsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
scrsNextToken
- The token returned to indicate that there is more data available.scrsContacts
- The contacts that meet the specified set of filter criteria, in sort order.scrsTotalCount
- The total number of contacts returned.scrsResponseStatus
- -- | The response status code.
data SearchContactsResponse Source #
See: searchContactsResponse
smart constructor.
Instances
Response Lenses
scrsNextToken :: Lens' SearchContactsResponse (Maybe Text) Source #
The token returned to indicate that there is more data available.
scrsContacts :: Lens' SearchContactsResponse [ContactData] Source #
The contacts that meet the specified set of filter criteria, in sort order.
scrsTotalCount :: Lens' SearchContactsResponse (Maybe Int) Source #
The total number of contacts returned.
scrsResponseStatus :: Lens' SearchContactsResponse Int Source #
- - | The response status code.