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

Description

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

Synopsis

# Creating a Request

Creates a value of SearchAddressBooks with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sabFilters - The filters to use to list a specified set of address books. The supported filter key is AddressBookName.
• sabSortCriteria - The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.
• sabNextToken - 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.
• sabMaxResults - 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: searchAddressBooks smart constructor.

Instances

# Request Lenses

The filters to use to list a specified set of address books. The supported filter key is AddressBookName.

The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.

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 sabrsResponseStatus -> SearchAddressBooksResponse

Creates a value of SearchAddressBooksResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sabrsNextToken - The token returned to indicate that there is more data available.
• sabrsAddressBooks - The address books that meet the specified set of filter criteria, in sort order.
• sabrsTotalCount - The total number of address books returned.
• sabrsResponseStatus - -- | The response status code.

See: searchAddressBooksResponse smart constructor.

Instances