Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Returns a list of users that are in the specified group. You can
paginate the results using the MaxItems
and Marker
parameters.
See: AWS API Reference for GetGroup.
This operation returns paginated results.
- getGroup :: Text -> GetGroup
- data GetGroup
- ggMarker :: Lens' GetGroup (Maybe Text)
- ggMaxItems :: Lens' GetGroup (Maybe Natural)
- ggGroupName :: Lens' GetGroup Text
- getGroupResponse :: Int -> Group -> GetGroupResponse
- data GetGroupResponse
- ggrsMarker :: Lens' GetGroupResponse (Maybe Text)
- ggrsIsTruncated :: Lens' GetGroupResponse (Maybe Bool)
- ggrsResponseStatus :: Lens' GetGroupResponse Int
- ggrsGroup :: Lens' GetGroupResponse Group
- ggrsUsers :: Lens' GetGroupResponse [User]
Creating a Request
Creates a value of GetGroup
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
See: getGroup
smart constructor.
Request Lenses
ggMarker :: Lens' GetGroup (Maybe Text) Source
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated. Set it to
the value of the Marker
element in the response that you received to
indicate where the next call should start.
ggMaxItems :: Lens' GetGroup (Maybe Natural) Source
Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the
maximum you specify, the IsTruncated
response element is true
.
This parameter is optional. If you do not include it, it defaults to
100. Note that IAM might return fewer results, even when there are more
results available. In that case, the IsTruncated
response element
returns true
and Marker
contains a value to include in the
subsequent call that tells the service where to continue from.
ggGroupName :: Lens' GetGroup Text Source
The name of the group.
Destructuring the Response
Creates a value of GetGroupResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data GetGroupResponse Source
Contains the response to a successful GetGroup request.
See: getGroupResponse
smart constructor.
Response Lenses
ggrsMarker :: Lens' GetGroupResponse (Maybe Text) Source
When IsTruncated
is true
, this element is present and contains the
value to use for the Marker
parameter in a subsequent pagination
request.
ggrsIsTruncated :: Lens' GetGroupResponse (Maybe Bool) Source
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker
request parameter to retrieve more items. Note that
IAM might return fewer than the MaxItems
number of results even when
there are more results available. We recommend that you check
IsTruncated
after every call to ensure that you receive all of your
results.
ggrsResponseStatus :: Lens' GetGroupResponse Int Source
The response status code.
ggrsGroup :: Lens' GetGroupResponse Group Source
Information about the group.
ggrsUsers :: Lens' GetGroupResponse [User] Source
A list of users in the group.