| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.AlexaBusiness.SearchAddressBooks
Description
Searches address books and lists the ones that meet a set of filter and sort criteria.
Synopsis
- data SearchAddressBooks = SearchAddressBooks' {}
- newSearchAddressBooks :: SearchAddressBooks
- searchAddressBooks_filters :: Lens' SearchAddressBooks (Maybe [Filter])
- searchAddressBooks_maxResults :: Lens' SearchAddressBooks (Maybe Natural)
- searchAddressBooks_nextToken :: Lens' SearchAddressBooks (Maybe Text)
- searchAddressBooks_sortCriteria :: Lens' SearchAddressBooks (Maybe [Sort])
- data SearchAddressBooksResponse = SearchAddressBooksResponse' {
- addressBooks :: Maybe [AddressBookData]
- nextToken :: Maybe Text
- totalCount :: Maybe Int
- httpStatus :: Int
- newSearchAddressBooksResponse :: Int -> SearchAddressBooksResponse
- searchAddressBooksResponse_addressBooks :: Lens' SearchAddressBooksResponse (Maybe [AddressBookData])
- searchAddressBooksResponse_nextToken :: Lens' SearchAddressBooksResponse (Maybe Text)
- searchAddressBooksResponse_totalCount :: Lens' SearchAddressBooksResponse (Maybe Int)
- searchAddressBooksResponse_httpStatus :: Lens' SearchAddressBooksResponse Int
Creating a Request
data SearchAddressBooks Source #
See: newSearchAddressBooks smart constructor.
Constructors
| SearchAddressBooks' | |
Fields
| |
Instances
newSearchAddressBooks :: SearchAddressBooks Source #
Create a value of SearchAddressBooks 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:SearchAddressBooks', searchAddressBooks_filters - The filters to use to list a specified set of address books. The
supported filter key is AddressBookName.
$sel:maxResults:SearchAddressBooks', searchAddressBooks_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.
SearchAddressBooks, searchAddressBooks_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:sortCriteria:SearchAddressBooks', searchAddressBooks_sortCriteria - The sort order to use in listing the specified set of address books. The
supported sort key is AddressBookName.
Request Lenses
searchAddressBooks_filters :: Lens' SearchAddressBooks (Maybe [Filter]) Source #
The filters to use to list a specified set of address books. The supported filter key is AddressBookName.
searchAddressBooks_maxResults :: Lens' SearchAddressBooks (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.
searchAddressBooks_nextToken :: Lens' SearchAddressBooks (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.
searchAddressBooks_sortCriteria :: Lens' SearchAddressBooks (Maybe [Sort]) Source #
The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.
Destructuring the Response
data SearchAddressBooksResponse Source #
See: newSearchAddressBooksResponse smart constructor.
Constructors
| SearchAddressBooksResponse' | |
Fields
| |
Instances
newSearchAddressBooksResponse Source #
Create a value of SearchAddressBooksResponse 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:addressBooks:SearchAddressBooksResponse', searchAddressBooksResponse_addressBooks - The address books that meet the specified set of filter criteria, in
sort order.
SearchAddressBooks, searchAddressBooksResponse_nextToken - The token returned to indicate that there is more data available.
$sel:totalCount:SearchAddressBooksResponse', searchAddressBooksResponse_totalCount - The total number of address books returned.
$sel:httpStatus:SearchAddressBooksResponse', searchAddressBooksResponse_httpStatus - The response's http status code.
Response Lenses
searchAddressBooksResponse_addressBooks :: Lens' SearchAddressBooksResponse (Maybe [AddressBookData]) Source #
The address books that meet the specified set of filter criteria, in sort order.
searchAddressBooksResponse_nextToken :: Lens' SearchAddressBooksResponse (Maybe Text) Source #
The token returned to indicate that there is more data available.
searchAddressBooksResponse_totalCount :: Lens' SearchAddressBooksResponse (Maybe Int) Source #
The total number of address books returned.
searchAddressBooksResponse_httpStatus :: Lens' SearchAddressBooksResponse Int Source #
The response's http status code.