Copyright | (c) 2013-2016 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 groups that have the specified path prefix.
You can paginate the results using the MaxItems
and Marker
parameters.
This operation returns paginated results.
- listGroups :: ListGroups
- data ListGroups
- lgPathPrefix :: Lens' ListGroups (Maybe Text)
- lgMarker :: Lens' ListGroups (Maybe Text)
- lgMaxItems :: Lens' ListGroups (Maybe Natural)
- listGroupsResponse :: Int -> ListGroupsResponse
- data ListGroupsResponse
- lgrsMarker :: Lens' ListGroupsResponse (Maybe Text)
- lgrsIsTruncated :: Lens' ListGroupsResponse (Maybe Bool)
- lgrsResponseStatus :: Lens' ListGroupsResponse Int
- lgrsGroups :: Lens' ListGroupsResponse [Group]
Creating a Request
listGroups :: ListGroups Source #
Creates a value of ListGroups
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListGroups Source #
See: listGroups
smart constructor.
Request Lenses
lgPathPrefix :: Lens' ListGroups (Maybe Text) Source #
The path prefix for filtering the results. For example, the prefix '\/division_abc\/subdivision_xyz\/' gets all groups whose path starts with '\/division_abc\/subdivision_xyz\/'.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all groups.
lgMarker :: Lens' ListGroups (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.
lgMaxItems :: Lens' ListGroups (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
.
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. 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 ListGroupsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListGroupsResponse Source #
Contains the response to a successful ListGroups request.
See: listGroupsResponse
smart constructor.
Response Lenses
lgrsMarker :: Lens' ListGroupsResponse (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.
lgrsIsTruncated :: Lens' ListGroupsResponse (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.
lgrsResponseStatus :: Lens' ListGroupsResponse Int Source #
The response status code.
lgrsGroups :: Lens' ListGroupsResponse [Group] Source #
A list of groups.