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 users that have the specified path prefix. If no path prefix is specified, the operation returns all users in the Amazon Web Services account. If there are none, the operation returns an empty list.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a user, see GetUser.
You can paginate the results using the MaxItems
and Marker
parameters.
This operation returns paginated results.
Synopsis
- data ListUsers = ListUsers' {}
- newListUsers :: ListUsers
- listUsers_pathPrefix :: Lens' ListUsers (Maybe Text)
- listUsers_marker :: Lens' ListUsers (Maybe Text)
- listUsers_maxItems :: Lens' ListUsers (Maybe Natural)
- data ListUsersResponse = ListUsersResponse' {
- marker :: Maybe Text
- isTruncated :: Maybe Bool
- httpStatus :: Int
- users :: [User]
- newListUsersResponse :: Int -> ListUsersResponse
- listUsersResponse_marker :: Lens' ListUsersResponse (Maybe Text)
- listUsersResponse_isTruncated :: Lens' ListUsersResponse (Maybe Bool)
- listUsersResponse_httpStatus :: Lens' ListUsersResponse Int
- listUsersResponse_users :: Lens' ListUsersResponse [User]
Creating a Request
See: newListUsers
smart constructor.
ListUsers' | |
|
Instances
newListUsers :: ListUsers Source #
Create a value of ListUsers
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:pathPrefix:ListUsers'
, listUsers_pathPrefix
- 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. This parameter allows (through its
regex pattern) a string of characters
consisting of either a forward slash (/) by itself or a string that
must begin and end with forward slashes. In addition, it can contain any
ASCII character from the ! (\u0021
) through the DEL character
(\u007F
), including most punctuation characters, digits, and upper
and lowercased letters.
$sel:marker:ListUsers'
, listUsers_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:ListUsers'
, listUsers_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.
Request Lenses
listUsers_pathPrefix :: 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. This parameter allows (through its
regex pattern) a string of characters
consisting of either a forward slash (/) by itself or a string that
must begin and end with forward slashes. In addition, it can contain any
ASCII character from the ! (\u0021
) through the DEL character
(\u007F
), including most punctuation characters, digits, and upper
and lowercased letters.
listUsers_marker :: 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 that you received to
indicate where the next call should start.
listUsers_maxItems :: Lens' ListUsers (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.
Destructuring the Response
data ListUsersResponse Source #
Contains the response to a successful ListUsers request.
See: newListUsersResponse
smart constructor.
ListUsersResponse' | |
|
Instances
Create a value of ListUsersResponse
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:ListUsers'
, listUsersResponse_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:ListUsersResponse'
, listUsersResponse_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:ListUsersResponse'
, listUsersResponse_httpStatus
- The response's http status code.
$sel:users:ListUsersResponse'
, listUsersResponse_users
- A list of users.
Response Lenses
listUsersResponse_marker :: 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.
listUsersResponse_isTruncated :: 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 your
results.
listUsersResponse_httpStatus :: Lens' ListUsersResponse Int Source #
The response's http status code.
listUsersResponse_users :: Lens' ListUsersResponse [User] Source #
A list of users.