Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.WorkMail.DescribeUser

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides information regarding the user.

Synopsis

data DescribeUser = DescribeUser' {
- organizationId :: Text
- userId :: Text
}
newDescribeUser :: Text -> Text -> DescribeUser
describeUser_organizationId :: Lens' DescribeUser Text
describeUser_userId :: Lens' DescribeUser Text
data DescribeUserResponse = DescribeUserResponse' {
- email :: Maybe Text
- state :: Maybe EntityState
- userId :: Maybe Text
- disabledDate :: Maybe POSIX
- name :: Maybe Text
- displayName :: Maybe Text
- userRole :: Maybe UserRole
- enabledDate :: Maybe POSIX
- httpStatus :: Int
}
newDescribeUserResponse :: Int -> DescribeUserResponse
describeUserResponse_email :: Lens' DescribeUserResponse (Maybe Text)
describeUserResponse_state :: Lens' DescribeUserResponse (Maybe EntityState)
describeUserResponse_userId :: Lens' DescribeUserResponse (Maybe Text)
describeUserResponse_disabledDate :: Lens' DescribeUserResponse (Maybe UTCTime)
describeUserResponse_name :: Lens' DescribeUserResponse (Maybe Text)
describeUserResponse_displayName :: Lens' DescribeUserResponse (Maybe Text)
describeUserResponse_userRole :: Lens' DescribeUserResponse (Maybe UserRole)
describeUserResponse_enabledDate :: Lens' DescribeUserResponse (Maybe UTCTime)
describeUserResponse_httpStatus :: Lens' DescribeUserResponse Int

Creating a Request

data DescribeUser Source #

See: newDescribeUser smart constructor.

Constructors

DescribeUser'
Fields organizationId :: Text The identifier for the organization under which the user exists. userId :: Text The identifier for the user to be described.

Instances

Instances details

Eq DescribeUser Source #
Instance details Defined in Amazonka.WorkMail.DescribeUser Methods (==) :: DescribeUser -> DescribeUser -> Bool # (/=) :: DescribeUser -> DescribeUser -> Bool #
Read DescribeUser Source #
Instance details Defined in Amazonka.WorkMail.DescribeUser Methods readsPrec :: Int -> ReadS DescribeUser # readList :: ReadS [DescribeUser] # readPrec :: ReadPrec DescribeUser # readListPrec :: ReadPrec [DescribeUser] #
Show DescribeUser Source #
Instance details Defined in Amazonka.WorkMail.DescribeUser Methods showsPrec :: Int -> DescribeUser -> ShowS # show :: DescribeUser -> String # showList :: [DescribeUser] -> ShowS #
Generic DescribeUser Source #
Instance details Defined in Amazonka.WorkMail.DescribeUser Associated Types type Rep DescribeUser :: Type -> Type # Methods from :: DescribeUser -> Rep DescribeUser x # to :: Rep DescribeUser x -> DescribeUser #
NFData DescribeUser Source #
Instance details Defined in Amazonka.WorkMail.DescribeUser Methods rnf :: DescribeUser -> () #
Hashable DescribeUser Source #
Instance details Defined in Amazonka.WorkMail.DescribeUser Methods hashWithSalt :: Int -> DescribeUser -> Int # hash :: DescribeUser -> Int #
ToJSON DescribeUser Source #
Instance details Defined in Amazonka.WorkMail.DescribeUser Methods toJSON :: DescribeUser -> Value # toEncoding :: DescribeUser -> Encoding # toJSONList :: [DescribeUser] -> Value # toEncodingList :: [DescribeUser] -> Encoding #
AWSRequest DescribeUser Source #
Instance details Defined in Amazonka.WorkMail.DescribeUser Associated Types type AWSResponse DescribeUser # Methods request :: DescribeUser -> Request DescribeUser # response :: MonadResource m => Logger -> Service -> Proxy DescribeUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeUser))) #
ToHeaders DescribeUser Source #
Instance details Defined in Amazonka.WorkMail.DescribeUser Methods toHeaders :: DescribeUser -> [Header] #
ToPath DescribeUser Source #
Instance details Defined in Amazonka.WorkMail.DescribeUser Methods toPath :: DescribeUser -> ByteString #
ToQuery DescribeUser Source #
Instance details Defined in Amazonka.WorkMail.DescribeUser Methods toQuery :: DescribeUser -> QueryString #
type Rep DescribeUser Source #
Instance details Defined in Amazonka.WorkMail.DescribeUser type Rep DescribeUser = D1 ('MetaData "DescribeUser" "Amazonka.WorkMail.DescribeUser" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "DescribeUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeUser Source #
Instance details Defined in Amazonka.WorkMail.DescribeUser type AWSResponse DescribeUser = DescribeUserResponse

newDescribeUser Source #

Arguments

:: Text	`$sel:organizationId:DescribeUser'`
-> Text	`$sel:userId:DescribeUser'`
-> DescribeUser

Create a value of DescribeUser with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:organizationId:DescribeUser', describeUser_organizationId - The identifier for the organization under which the user exists.

$sel:userId:DescribeUser', describeUser_userId - The identifier for the user to be described.

Request Lenses

describeUser_organizationId :: Lens' DescribeUser Text Source #

The identifier for the organization under which the user exists.

describeUser_userId :: Lens' DescribeUser Text Source #

The identifier for the user to be described.

Destructuring the Response

data DescribeUserResponse Source #

See: newDescribeUserResponse smart constructor.

Constructors

DescribeUserResponse'

Fields

email :: Maybe Text
The email of the user.
state :: Maybe EntityState
The state of a user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to WorkMail).
userId :: Maybe Text
The identifier for the described user.
disabledDate :: Maybe POSIX
The date and time at which the user was disabled for Amazon WorkMail usage, in UNIX epoch time format.
name :: Maybe Text
The name for the user.
displayName :: Maybe Text
The display name of the user.
userRole :: Maybe UserRole
In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into Amazon WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, and SYSTEM_USER.
enabledDate :: Maybe POSIX
The date and time at which the user was enabled for Amazon WorkMail usage, in UNIX epoch time format.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeUserResponse Source #
Instance details Defined in Amazonka.WorkMail.DescribeUser Methods (==) :: DescribeUserResponse -> DescribeUserResponse -> Bool # (/=) :: DescribeUserResponse -> DescribeUserResponse -> Bool #
Read DescribeUserResponse Source #
Instance details Defined in Amazonka.WorkMail.DescribeUser Methods readsPrec :: Int -> ReadS DescribeUserResponse # readList :: ReadS [DescribeUserResponse] # readPrec :: ReadPrec DescribeUserResponse # readListPrec :: ReadPrec [DescribeUserResponse] #
Show DescribeUserResponse Source #
Instance details Defined in Amazonka.WorkMail.DescribeUser Methods showsPrec :: Int -> DescribeUserResponse -> ShowS # show :: DescribeUserResponse -> String # showList :: [DescribeUserResponse] -> ShowS #
Generic DescribeUserResponse Source #
Instance details Defined in Amazonka.WorkMail.DescribeUser Associated Types type Rep DescribeUserResponse :: Type -> Type # Methods from :: DescribeUserResponse -> Rep DescribeUserResponse x # to :: Rep DescribeUserResponse x -> DescribeUserResponse #
NFData DescribeUserResponse Source #
Instance details Defined in Amazonka.WorkMail.DescribeUser Methods rnf :: DescribeUserResponse -> () #
type Rep DescribeUserResponse Source #
Instance details Defined in Amazonka.WorkMail.DescribeUser type Rep DescribeUserResponse = D1 ('MetaData "DescribeUserResponse" "Amazonka.WorkMail.DescribeUser" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "DescribeUserResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "email") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntityState))) :: (S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "disabledDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "userRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserRole)) :: (S1 ('MetaSel ('Just "enabledDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeUserResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeUserResponse'`
-> DescribeUserResponse

Create a value of DescribeUserResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:email:DescribeUserResponse', describeUserResponse_email - The email of the user.

$sel:state:DescribeUserResponse', describeUserResponse_state - The state of a user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to WorkMail).

$sel:userId:DescribeUser', describeUserResponse_userId - The identifier for the described user.

$sel:disabledDate:DescribeUserResponse', describeUserResponse_disabledDate - The date and time at which the user was disabled for Amazon WorkMail usage, in UNIX epoch time format.

$sel:name:DescribeUserResponse', describeUserResponse_name - The name for the user.

$sel:displayName:DescribeUserResponse', describeUserResponse_displayName - The display name of the user.

$sel:userRole:DescribeUserResponse', describeUserResponse_userRole - In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into Amazon WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, and SYSTEM_USER.

$sel:enabledDate:DescribeUserResponse', describeUserResponse_enabledDate - The date and time at which the user was enabled for Amazon WorkMail usage, in UNIX epoch time format.

$sel:httpStatus:DescribeUserResponse', describeUserResponse_httpStatus - The response's http status code.

Response Lenses

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

The email of the user.

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

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

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

The identifier for the described user.

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

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

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

The name for the user.

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

The display name of the user.

describeUserResponse_userRole :: 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 WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, and SYSTEM_USER.

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

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

describeUserResponse_httpStatus :: Lens' DescribeUserResponse Int Source #

The response's http status code.