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 |
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
- data GetGroup = GetGroup' {}
- newGetGroup :: Text -> GetGroup
- getGroup_marker :: Lens' GetGroup (Maybe Text)
- getGroup_maxItems :: Lens' GetGroup (Maybe Natural)
- getGroup_groupName :: Lens' GetGroup Text
- data GetGroupResponse = GetGroupResponse' {}
- newGetGroupResponse :: Int -> Group -> GetGroupResponse
- getGroupResponse_marker :: Lens' GetGroupResponse (Maybe Text)
- getGroupResponse_isTruncated :: Lens' GetGroupResponse (Maybe Bool)
- getGroupResponse_httpStatus :: Lens' GetGroupResponse Int
- getGroupResponse_group :: Lens' GetGroupResponse Group
- getGroupResponse_users :: Lens' GetGroupResponse [User]
Creating a Request
See: newGetGroup
smart constructor.
GetGroup' | |
|
Instances
Create a value of GetGroup
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:marker:GetGroup'
, getGroup_marker
- 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.
$sel:maxItems:GetGroup'
, getGroup_maxItems
- 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, the number of items 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.
$sel:groupName:GetGroup'
, getGroup_groupName
- The name of the group.
This parameter allows (through 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: _+=,.@-
Request Lenses
getGroup_marker :: 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.
getGroup_maxItems :: 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
.
If you do not include this parameter, the number of items 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.
getGroup_groupName :: Lens' GetGroup Text Source #
The name of the group.
This parameter allows (through 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
data GetGroupResponse Source #
Contains the response to a successful GetGroup request.
See: newGetGroupResponse
smart constructor.
GetGroupResponse' | |
|
Instances
Create a value of GetGroupResponse
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:marker:GetGroup'
, getGroupResponse_marker
- When IsTruncated
is true
, this element is present and contains the
value to use for the Marker
parameter in a subsequent pagination
request.
$sel:isTruncated:GetGroupResponse'
, getGroupResponse_isTruncated
- 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 your
results.
$sel:httpStatus:GetGroupResponse'
, getGroupResponse_httpStatus
- The response's http status code.
$sel:group':GetGroupResponse'
, getGroupResponse_group
- A structure that contains details about the group.
$sel:users:GetGroupResponse'
, getGroupResponse_users
- A list of users in the group.
Response Lenses
getGroupResponse_marker :: 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.
getGroupResponse_isTruncated :: 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 your
results.
getGroupResponse_httpStatus :: Lens' GetGroupResponse Int Source #
The response's http status code.
getGroupResponse_group :: Lens' GetGroupResponse Group Source #
A structure that contains details about the group.
getGroupResponse_users :: Lens' GetGroupResponse [User] Source #
A list of users in the group.