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

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
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.

See: AWS API Reference for ListGroups.

This operation returns paginated results.

Synopsis

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:

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 you received to inform the next call about where to 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 there are additional items 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. If this is the 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

listGroupsResponse Source

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:

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.