Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Provides information regarding the user.
- describeUser :: Text -> Text -> DescribeUser
- data DescribeUser
- duOrganizationId :: Lens' DescribeUser Text
- duUserId :: Lens' DescribeUser Text
- describeUserResponse :: Int -> DescribeUserResponse
- data DescribeUserResponse
- dursEmail :: Lens' DescribeUserResponse (Maybe Text)
- dursState :: Lens' DescribeUserResponse (Maybe EntityState)
- dursUserId :: Lens' DescribeUserResponse (Maybe Text)
- dursDisabledDate :: Lens' DescribeUserResponse (Maybe UTCTime)
- dursName :: Lens' DescribeUserResponse (Maybe Text)
- dursDisplayName :: Lens' DescribeUserResponse (Maybe Text)
- dursUserRole :: Lens' DescribeUserResponse (Maybe UserRole)
- dursEnabledDate :: Lens' DescribeUserResponse (Maybe UTCTime)
- dursResponseStatus :: Lens' DescribeUserResponse Int
Creating a Request
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.
Request Lenses
duOrganizationId :: Lens' DescribeUser Text Source #
The identifier for the organization under which the user exists.
Destructuring the Response
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.
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.
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.