Copyright (c) 2013-2018 Brendan Hay Mozilla Public License, v. 2.0. Brendan Hay auto-generated non-portable (GHC extensions) None Haskell2010

Description

Searches contacts and lists the ones that meet a set of filter and sort criteria.

Synopsis

# Creating a Request

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.

See: searchContacts smart constructor.

Instances

# Request Lenses

The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.

The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.

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.

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

Arguments

 :: Int scrsResponseStatus -> SearchContactsResponse

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.

See: searchContactsResponse smart constructor.

Instances