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 |
Returns the data available for the group.
Synopsis
- describeGroup :: Text -> Text -> DescribeGroup
- data DescribeGroup
- dgOrganizationId :: Lens' DescribeGroup Text
- dgGroupId :: Lens' DescribeGroup Text
- describeGroupResponse :: Int -> DescribeGroupResponse
- data DescribeGroupResponse
- desrsEmail :: Lens' DescribeGroupResponse (Maybe Text)
- desrsState :: Lens' DescribeGroupResponse (Maybe EntityState)
- desrsDisabledDate :: Lens' DescribeGroupResponse (Maybe UTCTime)
- desrsName :: Lens' DescribeGroupResponse (Maybe Text)
- desrsGroupId :: Lens' DescribeGroupResponse (Maybe Text)
- desrsEnabledDate :: Lens' DescribeGroupResponse (Maybe UTCTime)
- desrsResponseStatus :: Lens' DescribeGroupResponse Int
Creating a Request
Creates a value of DescribeGroup
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dgOrganizationId
- The identifier for the organization under which the group exists.dgGroupId
- The identifier for the group to be described.
data DescribeGroup Source #
See: describeGroup
smart constructor.
Instances
Request Lenses
dgOrganizationId :: Lens' DescribeGroup Text Source #
The identifier for the organization under which the group exists.
Destructuring the Response
describeGroupResponse Source #
Creates a value of DescribeGroupResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
desrsEmail
- The email of the described group.desrsState
- The state of the user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to Amazon WorkMail).desrsDisabledDate
- The date and time when a user was deregistered from Amazon WorkMail, in UNIX epoch time format.desrsName
- The name of the described group.desrsGroupId
- The identifier of the described group.desrsEnabledDate
- The date and time when a user was registered to Amazon WorkMail, in UNIX epoch time format.desrsResponseStatus
- -- | The response status code.
data DescribeGroupResponse Source #
See: describeGroupResponse
smart constructor.
Instances
Response Lenses
desrsEmail :: Lens' DescribeGroupResponse (Maybe Text) Source #
The email of the described group.
desrsState :: Lens' DescribeGroupResponse (Maybe EntityState) Source #
The state of the user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to Amazon WorkMail).
desrsDisabledDate :: Lens' DescribeGroupResponse (Maybe UTCTime) Source #
The date and time when a user was deregistered from Amazon WorkMail, in UNIX epoch time format.
desrsGroupId :: Lens' DescribeGroupResponse (Maybe Text) Source #
The identifier of the described group.
desrsEnabledDate :: Lens' DescribeGroupResponse (Maybe UTCTime) Source #
The date and time when a user was registered to Amazon WorkMail, in UNIX epoch time format.
desrsResponseStatus :: Lens' DescribeGroupResponse Int Source #
- - | The response status code.