amazonka-iam-0.2.1: Amazon Identity and Access Management SDK.

Safe HaskellNone
LanguageHaskell2010

Network.AWS.IAM.ListGroups

Contents

Description

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

Synopsis

Request

Request constructor

listGroups :: ListGroups Source

ListGroups constructor.

The fields accessible through corresponding lenses are:

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

Response constructor

listGroupsResponse :: ListGroupsResponse Source

ListGroupsResponse constructor.

The fields accessible through corresponding lenses are:

Response lenses

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.

lgrMarker :: Lens' ListGroupsResponse (Maybe Text) Source

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.