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 |
Lists the IAM users that have the specified path prefix. If no path prefix is specified, the action returns all users in the AWS account. If there are none, the action returns an empty list.
You can paginate the results using the MaxItems
and Marker
parameters.
See: AWS API Reference for ListUsers.
This operation returns paginated results.
- listUsers :: ListUsers
- data ListUsers
- luPathPrefix :: Lens' ListUsers (Maybe Text)
- luMarker :: Lens' ListUsers (Maybe Text)
- luMaxItems :: Lens' ListUsers (Maybe Natural)
- listUsersResponse :: Int -> ListUsersResponse
- data ListUsersResponse
- lursMarker :: Lens' ListUsersResponse (Maybe Text)
- lursIsTruncated :: Lens' ListUsersResponse (Maybe Bool)
- lursResponseStatus :: Lens' ListUsersResponse Int
- lursUsers :: Lens' ListUsersResponse [User]
Creating a Request
Creates a value of ListUsers
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
See: listUsers
smart constructor.
Request Lenses
luPathPrefix :: Lens' ListUsers (Maybe Text) Source
The path prefix for filtering the results. For example: '\/division_abc\/subdivision_xyz\/', which would get all user names whose path starts with '\/division_abc\/subdivision_xyz\/'.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all user names.
luMarker :: Lens' ListUsers (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 you received to inform
the next call about where to start.
luMaxItems :: Lens' ListUsers (Maybe Natural) Source
Use this only when paginating results to indicate the maximum number of
items you want in the response. If there are additional items 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. If this is the 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.
Destructuring the Response
Creates a value of ListUsersResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListUsersResponse Source
Contains the response to a successful ListUsers request.
See: listUsersResponse
smart constructor.
Response Lenses
lursMarker :: Lens' ListUsersResponse (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.
lursIsTruncated :: Lens' ListUsersResponse (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.
lursResponseStatus :: Lens' ListUsersResponse Int Source
The response status code.
lursUsers :: Lens' ListUsersResponse [User] Source
A list of users.