amazonka-workmail-1.6.0: Amazon WorkMail 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.WorkMail.DescribeUser

Contents

Description

Provides information regarding the user.

Synopsis

Creating a Request

describeUser Source #

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

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

  • duOrganizationId - The identifier for the organization under which the user exists.
  • duUserId - The identifier for the user to be described.

data DescribeUser Source #

See: describeUser smart constructor.

Instances

Eq DescribeUser Source # 
Data DescribeUser Source # 

Methods

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

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

toConstr :: DescribeUser -> Constr #

dataTypeOf :: DescribeUser -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeUser Source # 
Show DescribeUser Source # 
Generic DescribeUser Source # 

Associated Types

type Rep DescribeUser :: * -> * #

Hashable DescribeUser Source # 
ToJSON DescribeUser Source # 
NFData DescribeUser Source # 

Methods

rnf :: DescribeUser -> () #

AWSRequest DescribeUser Source # 
ToHeaders DescribeUser Source # 
ToPath DescribeUser Source # 
ToQuery DescribeUser Source # 
type Rep DescribeUser Source # 
type Rep DescribeUser = D1 * (MetaData "DescribeUser" "Network.AWS.WorkMail.DescribeUser" "amazonka-workmail-1.6.0-8HAZCS55pFIAg9ZAclEI0R" False) (C1 * (MetaCons "DescribeUser'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_duOrganizationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_duUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))
type Rs DescribeUser Source # 

Request Lenses

duOrganizationId :: Lens' DescribeUser Text Source #

The identifier for the organization under which the user exists.

duUserId :: Lens' DescribeUser Text Source #

The identifier for the user to be described.

Destructuring the Response

describeUserResponse Source #

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

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

  • dursEmail - The email of the user.
  • dursState - The state of a user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to Amazon WorkMail).
  • dursUserId - The identifier for the described user.
  • dursDisabledDate - The date and time at which the user was disabled for Amazon WorkMail usage, in UNIX epoch time format.
  • dursName - The name for the user.
  • dursDisplayName - The display name of the user.
  • dursUserRole - In certain cases other entities are modeled as users. If interoperability is enabled, resources are imported into Amazon WorkMail as users. Because different Amazon WorkMail organizations rely on different directory types, administrators can distinguish between a user that is not registered to Amazon WorkMail (is disabled and has a user role) and the administrative users of the directory. The values are USER, RESOURCE, and SYSTEM_USER.
  • dursEnabledDate - The date and time at which the user was enabled for Amazon WorkMail usage, in UNIX epoch time format.
  • dursResponseStatus - -- | The response status code.

data DescribeUserResponse Source #

See: describeUserResponse smart constructor.

Instances

Eq DescribeUserResponse Source # 
Data DescribeUserResponse Source # 

Methods

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

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

toConstr :: DescribeUserResponse -> Constr #

dataTypeOf :: DescribeUserResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeUserResponse Source # 
Show DescribeUserResponse Source # 
Generic DescribeUserResponse Source # 
NFData DescribeUserResponse Source # 

Methods

rnf :: DescribeUserResponse -> () #

type Rep DescribeUserResponse Source # 

Response Lenses

dursState :: Lens' DescribeUserResponse (Maybe EntityState) Source #

The state of a user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to Amazon WorkMail).

dursUserId :: Lens' DescribeUserResponse (Maybe Text) Source #

The identifier for the described user.

dursDisabledDate :: Lens' DescribeUserResponse (Maybe UTCTime) Source #

The date and time at which the user was disabled for Amazon WorkMail usage, in UNIX epoch time format.

dursName :: Lens' DescribeUserResponse (Maybe Text) Source #

The name for the user.

dursDisplayName :: Lens' DescribeUserResponse (Maybe Text) Source #

The display name of the user.

dursUserRole :: Lens' DescribeUserResponse (Maybe UserRole) Source #

In certain cases other entities are modeled as users. If interoperability is enabled, resources are imported into Amazon WorkMail as users. Because different Amazon WorkMail organizations rely on different directory types, administrators can distinguish between a user that is not registered to Amazon WorkMail (is disabled and has a user role) and the administrative users of the directory. The values are USER, RESOURCE, and SYSTEM_USER.

dursEnabledDate :: Lens' DescribeUserResponse (Maybe UTCTime) Source #

The date and time at which the user was enabled for Amazon WorkMail usage, in UNIX epoch time format.

dursResponseStatus :: Lens' DescribeUserResponse Int Source #

  • - | The response status code.