Network.AWS.AlexaBusiness.SearchUsers

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

This operation returns paginated results.

Creating a Request

searchUsers :: SearchUsers

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

See: searchUsers smart constructor.

Instances

Eq SearchUsers

Methods

(==) :: SearchUsers -> SearchUsers -> Bool

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

Data 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

Methods

readsPrec :: Int -> ReadS SearchUsers

readList :: ReadS [SearchUsers]

readPrec :: ReadPrec SearchUsers

readListPrec :: ReadPrec [SearchUsers]

Show SearchUsers

Methods

showsPrec :: Int -> SearchUsers -> ShowS

show :: SearchUsers -> String

showList :: [SearchUsers] -> ShowS

Generic SearchUsers

Associated Types

type Rep SearchUsers :: * -> *

Methods

from :: SearchUsers -> Rep SearchUsers x

to :: Rep SearchUsers x -> SearchUsers

Hashable SearchUsers

Methods

hashWithSalt :: Int -> SearchUsers -> Int

hash :: SearchUsers -> Int

ToJSON SearchUsers

Methods

toJSON :: SearchUsers -> Value

toEncoding :: SearchUsers -> Encoding

toJSONList :: [SearchUsers] -> Value

toEncodingList :: [SearchUsers] -> Encoding

NFData SearchUsers

Methods

rnf :: SearchUsers -> ()

AWSPager SearchUsers

Methods

page :: SearchUsers -> Rs SearchUsers -> Maybe SearchUsers

AWSRequest SearchUsers

Associated Types

type Rs SearchUsers :: *

Methods

request :: SearchUsers -> Request SearchUsers

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

ToHeaders SearchUsers

Methods

toHeaders :: SearchUsers -> [Header]

ToPath SearchUsers

Methods

toPath :: SearchUsers -> ByteString

ToQuery SearchUsers

Methods

toQuery :: SearchUsers -> QueryString

type Rep SearchUsers

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

type Rs SearchUsers

type Rs SearchUsers = SearchUsersResponse

Request Lenses

suFilters :: Lens' SearchUsers [Filter]

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]

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)

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)

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

Arguments

:: Int

sursResponseStatus

-> SearchUsersResponse

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:

• sursUsers - The users that meet the specified set of filter criteria, in sort order.
• sursNextToken - The token returned to indicate that there is more data available.
• sursTotalCount - The total number of users returned.
• sursResponseStatus - -- | The response status code.

data SearchUsersResponse

See: searchUsersResponse smart constructor.

Instances

Eq SearchUsersResponse

Methods

(==) :: SearchUsersResponse -> SearchUsersResponse -> Bool

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

Data SearchUsersResponse

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

Methods

readsPrec :: Int -> ReadS SearchUsersResponse

readList :: ReadS [SearchUsersResponse]

readPrec :: ReadPrec SearchUsersResponse

readListPrec :: ReadPrec [SearchUsersResponse]

Show SearchUsersResponse

Methods

showsPrec :: Int -> SearchUsersResponse -> ShowS

show :: SearchUsersResponse -> String

showList :: [SearchUsersResponse] -> ShowS

Generic SearchUsersResponse

Associated Types

type Rep SearchUsersResponse :: * -> *

Methods

from :: SearchUsersResponse -> Rep SearchUsersResponse x

to :: Rep SearchUsersResponse x -> SearchUsersResponse

NFData SearchUsersResponse

Methods

rnf :: SearchUsersResponse -> ()

type Rep SearchUsersResponse

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

Response Lenses

sursUsers :: Lens' SearchUsersResponse [UserData]

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

sursNextToken :: Lens' SearchUsersResponse (Maybe Text)

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

sursTotalCount :: Lens' SearchUsersResponse (Maybe Int)

The total number of users returned.

sursResponseStatus :: Lens' SearchUsersResponse Int

• - | The response status code.