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 |
Lists the IAM groups that the specified IAM user belongs to.
You can paginate the results using the MaxItems
and Marker
parameters.
This operation returns paginated results.
Synopsis
- data ListGroupsForUser = ListGroupsForUser' {}
- newListGroupsForUser :: Text -> ListGroupsForUser
- listGroupsForUser_marker :: Lens' ListGroupsForUser (Maybe Text)
- listGroupsForUser_maxItems :: Lens' ListGroupsForUser (Maybe Natural)
- listGroupsForUser_userName :: Lens' ListGroupsForUser Text
- data ListGroupsForUserResponse = ListGroupsForUserResponse' {
- marker :: Maybe Text
- isTruncated :: Maybe Bool
- httpStatus :: Int
- groups :: [Group]
- newListGroupsForUserResponse :: Int -> ListGroupsForUserResponse
- listGroupsForUserResponse_marker :: Lens' ListGroupsForUserResponse (Maybe Text)
- listGroupsForUserResponse_isTruncated :: Lens' ListGroupsForUserResponse (Maybe Bool)
- listGroupsForUserResponse_httpStatus :: Lens' ListGroupsForUserResponse Int
- listGroupsForUserResponse_groups :: Lens' ListGroupsForUserResponse [Group]
Creating a Request
data ListGroupsForUser Source #
See: newListGroupsForUser
smart constructor.
ListGroupsForUser' | |
|
Instances
Create a value of ListGroupsForUser
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:ListGroupsForUser'
, listGroupsForUser_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:ListGroupsForUser'
, listGroupsForUser_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:userName:ListGroupsForUser'
, listGroupsForUser_userName
- The name of the user to list groups for.
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
listGroupsForUser_marker :: Lens' ListGroupsForUser (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.
listGroupsForUser_maxItems :: Lens' ListGroupsForUser (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.
listGroupsForUser_userName :: Lens' ListGroupsForUser Text Source #
The name of the user to list groups for.
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 ListGroupsForUserResponse Source #
Contains the response to a successful ListGroupsForUser request.
See: newListGroupsForUserResponse
smart constructor.
ListGroupsForUserResponse' | |
|
Instances
newListGroupsForUserResponse Source #
Create a value of ListGroupsForUserResponse
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:ListGroupsForUser'
, listGroupsForUserResponse_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:ListGroupsForUserResponse'
, listGroupsForUserResponse_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:ListGroupsForUserResponse'
, listGroupsForUserResponse_httpStatus
- The response's http status code.
$sel:groups:ListGroupsForUserResponse'
, listGroupsForUserResponse_groups
- A list of groups.
Response Lenses
listGroupsForUserResponse_marker :: Lens' ListGroupsForUserResponse (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.
listGroupsForUserResponse_isTruncated :: Lens' ListGroupsForUserResponse (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.
listGroupsForUserResponse_httpStatus :: Lens' ListGroupsForUserResponse Int Source #
The response's http status code.
listGroupsForUserResponse_groups :: Lens' ListGroupsForUserResponse [Group] Source #
A list of groups.