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 a list of IAM users that are in the specified IAM group. You can paginate the results using the MaxItems
and Marker
parameters.
This operation returns paginated results.
Synopsis
- 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:
ggMarker
- 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 theMarker
element in the response that you received to indicate where the next call should start.ggMaxItems
- (Optional) 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, theIsTruncated
response element istrue
. If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, theIsTruncated
response element returnstrue
andMarker
contains a value to include in the subsequent call that tells the service where to continue from.ggGroupName
- The name of the group. This parameter allows (per its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
See: getGroup
smart constructor.
Instances
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 #
(Optional) 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
. If you do not include this parameter, 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. This parameter allows (per its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
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:
ggrsMarker
- WhenIsTruncated
istrue
, this element is present and contains the value to use for theMarker
parameter in a subsequent pagination request.ggrsIsTruncated
- A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using theMarker
request parameter to retrieve more items. Note that IAM might return fewer than theMaxItems
number of results even when there are more results available. We recommend that you checkIsTruncated
after every call to ensure that you receive all of your results.ggrsResponseStatus
- -- | The response status code.ggrsGroup
- A structure that contains details about the group.ggrsUsers
- A list of users in the group.
data GetGroupResponse Source #
Contains the response to a successful GetGroup
request.
See: getGroupResponse
smart constructor.
Instances
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.