Network.AWS.AlexaBusiness.SearchContacts

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

Creating a Request

searchContacts :: SearchContacts

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.

data SearchContacts

See: searchContacts smart constructor.

Instances

Eq SearchContacts

Methods

(==) :: SearchContacts -> SearchContacts -> Bool

(/=) :: SearchContacts -> SearchContacts -> Bool

Data SearchContacts

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SearchContacts -> c SearchContacts

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SearchContacts

toConstr :: SearchContacts -> Constr

dataTypeOf :: SearchContacts -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SearchContacts)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SearchContacts)

gmapT :: (forall b. Data b => b -> b) -> SearchContacts -> SearchContacts

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SearchContacts -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SearchContacts -> r

gmapQ :: (forall d. Data d => d -> u) -> SearchContacts -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SearchContacts -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SearchContacts -> m SearchContacts

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchContacts -> m SearchContacts

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchContacts -> m SearchContacts

Read SearchContacts

Methods

readsPrec :: Int -> ReadS SearchContacts

readList :: ReadS [SearchContacts]

readPrec :: ReadPrec SearchContacts

readListPrec :: ReadPrec [SearchContacts]

Show SearchContacts

Methods

showsPrec :: Int -> SearchContacts -> ShowS

show :: SearchContacts -> String

showList :: [SearchContacts] -> ShowS

Generic SearchContacts

Associated Types

type Rep SearchContacts :: * -> *

Methods

from :: SearchContacts -> Rep SearchContacts x

to :: Rep SearchContacts x -> SearchContacts

Hashable SearchContacts

Methods

hashWithSalt :: Int -> SearchContacts -> Int

hash :: SearchContacts -> Int

ToJSON SearchContacts

Methods

toJSON :: SearchContacts -> Value

toEncoding :: SearchContacts -> Encoding

toJSONList :: [SearchContacts] -> Value

toEncodingList :: [SearchContacts] -> Encoding

NFData SearchContacts

Methods

rnf :: SearchContacts -> ()

AWSRequest SearchContacts

Associated Types

type Rs SearchContacts :: *

Methods

request :: SearchContacts -> Request SearchContacts

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * SearchContacts -> ClientResponse -> m (Response SearchContacts)

ToHeaders SearchContacts

Methods

toHeaders :: SearchContacts -> [Header]

ToPath SearchContacts

Methods

toPath :: SearchContacts -> ByteString

ToQuery SearchContacts

Methods

toQuery :: SearchContacts -> QueryString

type Rep SearchContacts

type Rep SearchContacts = D1 * (MetaData "SearchContacts" "Network.AWS.AlexaBusiness.SearchContacts" "amazonka-alexa-business-1.6.0-DI5T43QkJWfD1hlGpmjsnd" False) (C1 * (MetaCons "SearchContacts'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_scFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Filter]))) (S1 * (MetaSel (Just Symbol "_scSortCriteria") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Sort])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_scNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_scMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))))))

type Rs SearchContacts

type Rs SearchContacts = SearchContactsResponse

Request Lenses

scFilters :: Lens' SearchContacts [Filter]

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

scSortCriteria :: Lens' SearchContacts [Sort]

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

scNextToken :: Lens' SearchContacts (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.

scMaxResults :: Lens' SearchContacts (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.

Destructuring the Response

searchContactsResponse

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.

data SearchContactsResponse

See: searchContactsResponse smart constructor.

Instances

Eq SearchContactsResponse

Methods

(==) :: SearchContactsResponse -> SearchContactsResponse -> Bool

(/=) :: SearchContactsResponse -> SearchContactsResponse -> Bool

Data SearchContactsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SearchContactsResponse -> c SearchContactsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SearchContactsResponse

toConstr :: SearchContactsResponse -> Constr

dataTypeOf :: SearchContactsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SearchContactsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SearchContactsResponse)

gmapT :: (forall b. Data b => b -> b) -> SearchContactsResponse -> SearchContactsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SearchContactsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SearchContactsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> SearchContactsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SearchContactsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SearchContactsResponse -> m SearchContactsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchContactsResponse -> m SearchContactsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchContactsResponse -> m SearchContactsResponse

Read SearchContactsResponse

Methods

readsPrec :: Int -> ReadS SearchContactsResponse

readList :: ReadS [SearchContactsResponse]

readPrec :: ReadPrec SearchContactsResponse

readListPrec :: ReadPrec [SearchContactsResponse]

Show SearchContactsResponse

Methods

showsPrec :: Int -> SearchContactsResponse -> ShowS

show :: SearchContactsResponse -> String

showList :: [SearchContactsResponse] -> ShowS

Generic SearchContactsResponse

Associated Types

type Rep SearchContactsResponse :: * -> *

Methods

from :: SearchContactsResponse -> Rep SearchContactsResponse x

to :: Rep SearchContactsResponse x -> SearchContactsResponse

NFData SearchContactsResponse

Methods

rnf :: SearchContactsResponse -> ()

type Rep SearchContactsResponse

type Rep SearchContactsResponse = D1 * (MetaData "SearchContactsResponse" "Network.AWS.AlexaBusiness.SearchContacts" "amazonka-alexa-business-1.6.0-DI5T43QkJWfD1hlGpmjsnd" False) (C1 * (MetaCons "SearchContactsResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_scrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_scrsContacts") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [ContactData])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_scrsTotalCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_scrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

scrsNextToken :: Lens' SearchContactsResponse (Maybe Text)

The token returned to indicate that there is more data available.

scrsContacts :: Lens' SearchContactsResponse [ContactData]

The contacts that meet the specified set of filter criteria, in sort order.

scrsTotalCount :: Lens' SearchContactsResponse (Maybe Int)

The total number of contacts returned.

scrsResponseStatus :: Lens' SearchContactsResponse Int

• - | The response status code.