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.AlexaBusiness.SearchContacts
Description
Searches contacts and lists the ones that meet a set of filter and sort criteria.
Synopsis
- data SearchContacts = SearchContacts' {}
- newSearchContacts :: SearchContacts
- searchContacts_filters :: Lens' SearchContacts (Maybe [Filter])
- searchContacts_sortCriteria :: Lens' SearchContacts (Maybe [Sort])
- searchContacts_nextToken :: Lens' SearchContacts (Maybe Text)
- searchContacts_maxResults :: Lens' SearchContacts (Maybe Natural)
- data SearchContactsResponse = SearchContactsResponse' {
- nextToken :: Maybe Text
- contacts :: Maybe [ContactData]
- totalCount :: Maybe Int
- httpStatus :: Int
- newSearchContactsResponse :: Int -> SearchContactsResponse
- searchContactsResponse_nextToken :: Lens' SearchContactsResponse (Maybe Text)
- searchContactsResponse_contacts :: Lens' SearchContactsResponse (Maybe [ContactData])
- searchContactsResponse_totalCount :: Lens' SearchContactsResponse (Maybe Int)
- searchContactsResponse_httpStatus :: Lens' SearchContactsResponse Int
Creating a Request
data SearchContacts Source #
See: newSearchContacts
smart constructor.
Constructors
SearchContacts' | |
Fields
|
Instances
newSearchContacts :: SearchContacts Source #
Create a value of SearchContacts
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:filters:SearchContacts'
, searchContacts_filters
- The filters to use to list a specified set of address books. The
supported filter keys are DisplayName, FirstName, LastName, and
AddressBookArns.
$sel:sortCriteria:SearchContacts'
, searchContacts_sortCriteria
- The sort order to use in listing the specified set of contacts. The
supported sort keys are DisplayName, FirstName, and LastName.
$sel:nextToken:SearchContacts'
, searchContacts_nextToken
- 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.
$sel:maxResults:SearchContacts'
, searchContacts_maxResults
- 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.
Request Lenses
searchContacts_filters :: Lens' SearchContacts (Maybe [Filter]) Source #
The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.
searchContacts_sortCriteria :: Lens' SearchContacts (Maybe [Sort]) Source #
The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.
searchContacts_nextToken :: 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.
searchContacts_maxResults :: 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
data SearchContactsResponse Source #
See: newSearchContactsResponse
smart constructor.
Constructors
SearchContactsResponse' | |
Fields
|
Instances
newSearchContactsResponse Source #
Create a value of SearchContactsResponse
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:SearchContacts'
, searchContactsResponse_nextToken
- The token returned to indicate that there is more data available.
$sel:contacts:SearchContactsResponse'
, searchContactsResponse_contacts
- The contacts that meet the specified set of filter criteria, in sort
order.
$sel:totalCount:SearchContactsResponse'
, searchContactsResponse_totalCount
- The total number of contacts returned.
$sel:httpStatus:SearchContactsResponse'
, searchContactsResponse_httpStatus
- The response's http status code.
Response Lenses
searchContactsResponse_nextToken :: Lens' SearchContactsResponse (Maybe Text) Source #
The token returned to indicate that there is more data available.
searchContactsResponse_contacts :: Lens' SearchContactsResponse (Maybe [ContactData]) Source #
The contacts that meet the specified set of filter criteria, in sort order.
searchContactsResponse_totalCount :: Lens' SearchContactsResponse (Maybe Int) Source #
The total number of contacts returned.
searchContactsResponse_httpStatus :: Lens' SearchContactsResponse Int Source #
The response's http status code.