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

Copyright(c) 2013-2016 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 IAM groups that have the specified path prefix.

You can paginate the results using the MaxItems and Marker parameters.

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:

data ListGroups Source #

See: listGroups smart constructor.

Instances

Eq ListGroups Source # 
Data ListGroups Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListGroups -> c ListGroups #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListGroups #

toConstr :: ListGroups -> Constr #

dataTypeOf :: ListGroups -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListGroups) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListGroups) #

gmapT :: (forall b. Data b => b -> b) -> ListGroups -> ListGroups #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListGroups -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListGroups -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListGroups -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListGroups -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListGroups -> m ListGroups #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListGroups -> m ListGroups #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListGroups -> m ListGroups #

Read ListGroups Source # 
Show ListGroups Source # 
Generic ListGroups Source # 

Associated Types

type Rep ListGroups :: * -> * #

Hashable ListGroups Source # 
NFData ListGroups Source # 

Methods

rnf :: ListGroups -> () #

AWSPager ListGroups Source # 
AWSRequest ListGroups Source # 
ToPath ListGroups Source # 
ToHeaders ListGroups Source # 

Methods

toHeaders :: ListGroups -> [Header] #

ToQuery ListGroups Source # 
type Rep ListGroups Source # 
type Rep ListGroups = D1 (MetaData "ListGroups" "Network.AWS.IAM.ListGroups" "amazonka-iam-1.4.4-BicPZt3TaHh2CoAkQqkWBu" False) (C1 (MetaCons "ListGroups'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lgPathPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lgMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lgMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))))))
type Rs ListGroups Source # 

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. The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\u0021) thru the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

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

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:

data ListGroupsResponse Source #

Contains the response to a successful ListGroups request.

See: listGroupsResponse smart constructor.

Instances

Eq ListGroupsResponse Source # 
Data ListGroupsResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListGroupsResponse -> c ListGroupsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListGroupsResponse #

toConstr :: ListGroupsResponse -> Constr #

dataTypeOf :: ListGroupsResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListGroupsResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListGroupsResponse) #

gmapT :: (forall b. Data b => b -> b) -> ListGroupsResponse -> ListGroupsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListGroupsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListGroupsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListGroupsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListGroupsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListGroupsResponse -> m ListGroupsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListGroupsResponse -> m ListGroupsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListGroupsResponse -> m ListGroupsResponse #

Read ListGroupsResponse Source # 
Show ListGroupsResponse Source # 
Generic ListGroupsResponse Source # 
NFData ListGroupsResponse Source # 

Methods

rnf :: ListGroupsResponse -> () #

type Rep ListGroupsResponse Source # 
type Rep ListGroupsResponse = D1 (MetaData "ListGroupsResponse" "Network.AWS.IAM.ListGroups" "amazonka-iam-1.4.4-BicPZt3TaHh2CoAkQqkWBu" False) (C1 (MetaCons "ListGroupsResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lgrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lgrsIsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_lgrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_lgrsGroups") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Group])))))

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.