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 |
Lists the IAM users that have the specified path prefix. If no path prefix is specified, the operation returns all users in the AWS account. If there are none, the operation returns an empty list.
You can paginate the results using the MaxItems
and Marker
parameters.
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
listUsers :: ListUsers Source #
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:
luPathPrefix
- The path prefix for filtering the results. For example:division_abcsubdivision_xyz/
, which would get all user names whose path starts withdivision_abcsubdivision_xyz/
. This parameter is optional. If it is not included, it defaults to a slash (), listing all user names. This parameter allows (per its <http:wikipedia.orgwikiregex 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.luMarker
- 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.luMaxItems
- (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.
See: listUsers
smart constructor.
Request Lenses
luPathPrefix :: Lens' ListUsers (Maybe Text) Source #
The path prefix for filtering the results. For example: division_abcsubdivision_xyz/
, which would get all user names whose path starts with division_abcsubdivision_xyz/
. This parameter is optional. If it is not included, it defaults to a slash (), listing all user names. This parameter allows (per its <http:wikipedia.orgwikiregex 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.
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 that you received to indicate where the next call should start.
luMaxItems :: Lens' ListUsers (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.
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:
lursMarker
- WhenIsTruncated
istrue
, this element is present and contains the value to use for theMarker
parameter in a subsequent pagination request.lursIsTruncated
- 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.lursResponseStatus
- -- | The response status code.lursUsers
- A list of users.
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.