Network.AWS.WorkMail.ListUsers

Returns summaries of the organization's users.

This operation returns paginated results.

Creating a Request

listUsers

Arguments

:: Text

luOrganizationId

-> ListUsers

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

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

• luNextToken - TBD
• luMaxResults - The maximum number of results to return in a single call.
• luOrganizationId - The identifier for the organization under which the users exist.

data ListUsers

See: listUsers smart constructor.

Instances

Eq ListUsers

Methods

(==) :: ListUsers -> ListUsers -> Bool

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

Data ListUsers

Methods

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

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

toConstr :: ListUsers -> Constr

dataTypeOf :: ListUsers -> DataType

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

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

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

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

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

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

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

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

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

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

Read ListUsers

Methods

readsPrec :: Int -> ReadS ListUsers

readList :: ReadS [ListUsers]

readPrec :: ReadPrec ListUsers

readListPrec :: ReadPrec [ListUsers]

Show ListUsers

Methods

showsPrec :: Int -> ListUsers -> ShowS

show :: ListUsers -> String

showList :: [ListUsers] -> ShowS

Generic ListUsers

Associated Types

type Rep ListUsers :: * -> *

Methods

from :: ListUsers -> Rep ListUsers x

to :: Rep ListUsers x -> ListUsers

Hashable ListUsers

Methods

hashWithSalt :: Int -> ListUsers -> Int

hash :: ListUsers -> Int

ToJSON ListUsers

Methods

toJSON :: ListUsers -> Value

toEncoding :: ListUsers -> Encoding

toJSONList :: [ListUsers] -> Value

toEncodingList :: [ListUsers] -> Encoding

NFData ListUsers

Methods

rnf :: ListUsers -> ()

AWSPager ListUsers

Methods

page :: ListUsers -> Rs ListUsers -> Maybe ListUsers

AWSRequest ListUsers

Associated Types

type Rs ListUsers :: *

Methods

request :: ListUsers -> Request ListUsers

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

ToHeaders ListUsers

Methods

toHeaders :: ListUsers -> [Header]

ToPath ListUsers

Methods

toPath :: ListUsers -> ByteString

ToQuery ListUsers

Methods

toQuery :: ListUsers -> QueryString

type Rep ListUsers

type Rep ListUsers = D1 * (MetaData "ListUsers" "Network.AWS.WorkMail.ListUsers" "amazonka-workmail-1.6.0-8HAZCS55pFIAg9ZAclEI0R" False) (C1 * (MetaCons "ListUsers'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_luNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_luMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) (S1 * (MetaSel (Just Symbol "_luOrganizationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))

type Rs ListUsers

type Rs ListUsers = ListUsersResponse

Request Lenses

luNextToken :: Lens' ListUsers (Maybe Text)

TBD

luMaxResults :: Lens' ListUsers (Maybe Natural)

The maximum number of results to return in a single call.

luOrganizationId :: Lens' ListUsers Text

The identifier for the organization under which the users exist.

Destructuring the Response

listUsersResponse

Arguments

:: Int

lursResponseStatus

-> ListUsersResponse

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

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

• lursUsers - The overview of users for an organization.
• lursNextToken - The token to use to retrieve the next page of results. This value is null when there are no more results to return.
• lursResponseStatus - -- | The response status code.

data ListUsersResponse

See: listUsersResponse smart constructor.

Instances

Eq ListUsersResponse

Methods

(==) :: ListUsersResponse -> ListUsersResponse -> Bool

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

Data ListUsersResponse

Methods

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

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

toConstr :: ListUsersResponse -> Constr

dataTypeOf :: ListUsersResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read ListUsersResponse

Methods

readsPrec :: Int -> ReadS ListUsersResponse

readList :: ReadS [ListUsersResponse]

readPrec :: ReadPrec ListUsersResponse

readListPrec :: ReadPrec [ListUsersResponse]

Show ListUsersResponse

Methods

showsPrec :: Int -> ListUsersResponse -> ShowS

show :: ListUsersResponse -> String

showList :: [ListUsersResponse] -> ShowS

Generic ListUsersResponse

Associated Types

type Rep ListUsersResponse :: * -> *

Methods

from :: ListUsersResponse -> Rep ListUsersResponse x

to :: Rep ListUsersResponse x -> ListUsersResponse

NFData ListUsersResponse

Methods

rnf :: ListUsersResponse -> ()

type Rep ListUsersResponse

type Rep ListUsersResponse = D1 * (MetaData "ListUsersResponse" "Network.AWS.WorkMail.ListUsers" "amazonka-workmail-1.6.0-8HAZCS55pFIAg9ZAclEI0R" False) (C1 * (MetaCons "ListUsersResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_lursUsers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [User]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lursNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lursResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

lursUsers :: Lens' ListUsersResponse [User]

The overview of users for an organization.

lursNextToken :: Lens' ListUsersResponse (Maybe Text)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

lursResponseStatus :: Lens' ListUsersResponse Int

• - | The response status code.