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.
http://docs.aws.amazon.com/IAM/latest/APIReference/API_ListGroups.html
- data ListGroups
- listGroups :: ListGroups
- lgMarker :: Lens' ListGroups (Maybe Text)
- lgMaxItems :: Lens' ListGroups (Maybe Natural)
- lgPathPrefix :: Lens' ListGroups (Maybe Text)
- data ListGroupsResponse
- listGroupsResponse :: ListGroupsResponse
- lgrGroups :: Lens' ListGroupsResponse [Group]
- lgrIsTruncated :: Lens' ListGroupsResponse (Maybe Bool)
- lgrMarker :: Lens' ListGroupsResponse (Maybe Text)
Request
data ListGroups Source
Request constructor
listGroups :: ListGroups Source
ListGroups
constructor.
The fields accessible through corresponding lenses are:
lgMarker
::
Maybe
Text
lgMaxItems
::
Maybe
Natural
lgPathPrefix
::
Maybe
Text
Request lenses
lgMarker :: Lens' ListGroups (Maybe Text) Source
Use this only when paginating results, and only in a subsequent request
after you've received a response where the results are truncated. Set it to
the value of the Marker
element in the response you just received.
lgMaxItems :: Lens' ListGroups (Maybe Natural) Source
Use this only when paginating results to indicate the maximum number of
groups you want in the response. If there are additional groups 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.
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.
Response
data ListGroupsResponse Source
Response constructor
listGroupsResponse :: ListGroupsResponse Source
ListGroupsResponse
constructor.
The fields accessible through corresponding lenses are:
Response lenses
lgrGroups :: Lens' ListGroupsResponse [Group] Source
A list of groups.
lgrIsTruncated :: Lens' ListGroupsResponse (Maybe Bool) Source
A flag that indicates whether there are more groups to list. If your results
were truncated, you can make a subsequent pagination request using the Marker
request parameter to retrieve more groups in the list.