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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data SearchContacts = SearchContacts' {
- filters :: Maybe [Filter]
- sortCriteria :: Maybe [Sort]
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
}
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

filters :: Maybe [Filter]
The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.
sortCriteria :: Maybe [Sort]
The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.
nextToken :: Maybe Text
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.
maxResults :: Maybe Natural
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.

Instances

Instances details

Eq SearchContacts Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchContacts Methods (==) :: SearchContacts -> SearchContacts -> Bool # (/=) :: SearchContacts -> SearchContacts -> Bool #
Read SearchContacts Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchContacts Methods readsPrec :: Int -> ReadS SearchContacts # readList :: ReadS [SearchContacts] # readPrec :: ReadPrec SearchContacts # readListPrec :: ReadPrec [SearchContacts] #
Show SearchContacts Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchContacts Methods showsPrec :: Int -> SearchContacts -> ShowS # show :: SearchContacts -> String # showList :: [SearchContacts] -> ShowS #
Generic SearchContacts Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchContacts Associated Types type Rep SearchContacts :: Type -> Type # Methods from :: SearchContacts -> Rep SearchContacts x # to :: Rep SearchContacts x -> SearchContacts #
NFData SearchContacts Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchContacts Methods rnf :: SearchContacts -> () #
Hashable SearchContacts Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchContacts Methods hashWithSalt :: Int -> SearchContacts -> Int # hash :: SearchContacts -> Int #
ToJSON SearchContacts Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchContacts Methods toJSON :: SearchContacts -> Value # toEncoding :: SearchContacts -> Encoding # toJSONList :: [SearchContacts] -> Value # toEncodingList :: [SearchContacts] -> Encoding #
AWSRequest SearchContacts Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchContacts Associated Types type AWSResponse SearchContacts # Methods request :: SearchContacts -> Request SearchContacts # response :: MonadResource m => Logger -> Service -> Proxy SearchContacts -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchContacts))) #
ToHeaders SearchContacts Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchContacts Methods toHeaders :: SearchContacts -> [Header] #
ToPath SearchContacts Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchContacts Methods toPath :: SearchContacts -> ByteString #
ToQuery SearchContacts Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchContacts Methods toQuery :: SearchContacts -> QueryString #
type Rep SearchContacts Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchContacts type Rep SearchContacts = D1 ('MetaData "SearchContacts" "Amazonka.AlexaBusiness.SearchContacts" "libZSservicesZSamazonka-alexa-businessZSamazonka-alexa-business" 'False) (C1 ('MetaCons "SearchContacts'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :: S1 ('MetaSel ('Just "sortCriteria") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Sort]))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse SearchContacts Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchContacts type AWSResponse SearchContacts = SearchContactsResponse

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 nextToken :: Maybe Text The token returned to indicate that there is more data available. contacts :: Maybe [ContactData] The contacts that meet the specified set of filter criteria, in sort order. totalCount :: Maybe Int The total number of contacts returned. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq SearchContactsResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchContacts Methods (==) :: SearchContactsResponse -> SearchContactsResponse -> Bool # (/=) :: SearchContactsResponse -> SearchContactsResponse -> Bool #
Show SearchContactsResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchContacts Methods showsPrec :: Int -> SearchContactsResponse -> ShowS # show :: SearchContactsResponse -> String # showList :: [SearchContactsResponse] -> ShowS #
Generic SearchContactsResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchContacts Associated Types type Rep SearchContactsResponse :: Type -> Type # Methods from :: SearchContactsResponse -> Rep SearchContactsResponse x # to :: Rep SearchContactsResponse x -> SearchContactsResponse #
NFData SearchContactsResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchContacts Methods rnf :: SearchContactsResponse -> () #
type Rep SearchContactsResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchContacts type Rep SearchContactsResponse = D1 ('MetaData "SearchContactsResponse" "Amazonka.AlexaBusiness.SearchContacts" "libZSservicesZSamazonka-alexa-businessZSamazonka-alexa-business" 'False) (C1 ('MetaCons "SearchContactsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "contacts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ContactData]))) :: (S1 ('MetaSel ('Just "totalCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchContactsResponse Source #

Arguments

:: Int	`$sel:httpStatus:SearchContactsResponse'`
-> SearchContactsResponse

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.