amazonka-alexa-business-1.6.1: Amazon Alexa For Business SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.AlexaBusiness.SearchUsers

Contents

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

searchUsers :: SearchUsers Source #

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

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

  • suFilters - The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
  • suSortCriteria - The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
  • suNextToken - 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 includes only results beyond the token, up to the value specified by MaxResults . Required.
  • suMaxResults - 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. Required.

data SearchUsers Source #

See: searchUsers smart constructor.

Instances
Eq SearchUsers Source # 
Instance details

Defined in Network.AWS.AlexaBusiness.SearchUsers

Data SearchUsers Source # 
Instance details

Defined in Network.AWS.AlexaBusiness.SearchUsers

Methods

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

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

toConstr :: SearchUsers -> Constr #

dataTypeOf :: SearchUsers -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SearchUsers) #

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

gmapT :: (forall b. Data b => b -> b) -> SearchUsers -> SearchUsers #

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

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

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

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

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

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

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

Read SearchUsers Source # 
Instance details

Defined in Network.AWS.AlexaBusiness.SearchUsers

Show SearchUsers Source # 
Instance details

Defined in Network.AWS.AlexaBusiness.SearchUsers

Generic SearchUsers Source # 
Instance details

Defined in Network.AWS.AlexaBusiness.SearchUsers

Associated Types

type Rep SearchUsers :: Type -> Type #

Hashable SearchUsers Source # 
Instance details

Defined in Network.AWS.AlexaBusiness.SearchUsers

ToJSON SearchUsers Source # 
Instance details

Defined in Network.AWS.AlexaBusiness.SearchUsers

AWSPager SearchUsers Source # 
Instance details

Defined in Network.AWS.AlexaBusiness.SearchUsers

AWSRequest SearchUsers Source # 
Instance details

Defined in Network.AWS.AlexaBusiness.SearchUsers

Associated Types

type Rs SearchUsers :: Type #

ToHeaders SearchUsers Source # 
Instance details

Defined in Network.AWS.AlexaBusiness.SearchUsers

Methods

toHeaders :: SearchUsers -> [Header] #

ToPath SearchUsers Source # 
Instance details

Defined in Network.AWS.AlexaBusiness.SearchUsers

ToQuery SearchUsers Source # 
Instance details

Defined in Network.AWS.AlexaBusiness.SearchUsers

NFData SearchUsers Source # 
Instance details

Defined in Network.AWS.AlexaBusiness.SearchUsers

Methods

rnf :: SearchUsers -> () #

type Rep SearchUsers Source # 
Instance details

Defined in Network.AWS.AlexaBusiness.SearchUsers

type Rep SearchUsers = D1 (MetaData "SearchUsers" "Network.AWS.AlexaBusiness.SearchUsers" "amazonka-alexa-business-1.6.1-FQuG4RoJ6vRJhvV2Vb1OnQ" False) (C1 (MetaCons "SearchUsers'" PrefixI True) ((S1 (MetaSel (Just "_suFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 (MetaSel (Just "_suSortCriteria") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Sort]))) :*: (S1 (MetaSel (Just "_suNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_suMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))))
type Rs SearchUsers Source # 
Instance details

Defined in Network.AWS.AlexaBusiness.SearchUsers

Request Lenses

suFilters :: Lens' SearchUsers [Filter] Source #

The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

suSortCriteria :: Lens' SearchUsers [Sort] Source #

The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

suNextToken :: Lens' SearchUsers (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 includes only results beyond the token, up to the value specified by MaxResults . Required.

suMaxResults :: Lens' SearchUsers (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. Required.

Destructuring the Response

searchUsersResponse Source #

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

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

data SearchUsersResponse Source #

See: searchUsersResponse smart constructor.

Instances
Eq SearchUsersResponse Source # 
Instance details

Defined in Network.AWS.AlexaBusiness.SearchUsers

Data SearchUsersResponse Source # 
Instance details

Defined in Network.AWS.AlexaBusiness.SearchUsers

Methods

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

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

toConstr :: SearchUsersResponse -> Constr #

dataTypeOf :: SearchUsersResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SearchUsersResponse) #

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

gmapT :: (forall b. Data b => b -> b) -> SearchUsersResponse -> SearchUsersResponse #

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

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

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

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

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

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

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

Read SearchUsersResponse Source # 
Instance details

Defined in Network.AWS.AlexaBusiness.SearchUsers

Show SearchUsersResponse Source # 
Instance details

Defined in Network.AWS.AlexaBusiness.SearchUsers

Generic SearchUsersResponse Source # 
Instance details

Defined in Network.AWS.AlexaBusiness.SearchUsers

Associated Types

type Rep SearchUsersResponse :: Type -> Type #

NFData SearchUsersResponse Source # 
Instance details

Defined in Network.AWS.AlexaBusiness.SearchUsers

Methods

rnf :: SearchUsersResponse -> () #

type Rep SearchUsersResponse Source # 
Instance details

Defined in Network.AWS.AlexaBusiness.SearchUsers

type Rep SearchUsersResponse = D1 (MetaData "SearchUsersResponse" "Network.AWS.AlexaBusiness.SearchUsers" "amazonka-alexa-business-1.6.1-FQuG4RoJ6vRJhvV2Vb1OnQ" False) (C1 (MetaCons "SearchUsersResponse'" PrefixI True) ((S1 (MetaSel (Just "_sursUsers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [UserData])) :*: S1 (MetaSel (Just "_sursNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_sursTotalCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)) :*: S1 (MetaSel (Just "_sursResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

sursUsers :: Lens' SearchUsersResponse [UserData] Source #

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

sursNextToken :: Lens' SearchUsersResponse (Maybe Text) Source #

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

sursTotalCount :: Lens' SearchUsersResponse (Maybe Int) Source #

The total number of users returned.

sursResponseStatus :: Lens' SearchUsersResponse Int Source #

  • - | The response status code.