amazonka-iam-1.4.5: 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 #

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:

  • lgPathPrefix - The path prefix for filtering the results. For example, the prefix division_abcsubdivision_xyz/ gets all groups whose path starts with division_abcsubdivision_xyz/ . This parameter is optional. If it is not included, it defaults to a slash (), listing all groups. The <http:wikipedia.orgwikiregex 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 - 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 - 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.

data ListGroups #

See: listGroups smart constructor.

Instances

Eq ListGroups # 
Data ListGroups # 

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 # 
Show ListGroups # 
Generic ListGroups # 

Associated Types

type Rep ListGroups :: * -> * #

Hashable ListGroups # 
NFData ListGroups # 

Methods

rnf :: ListGroups -> () #

AWSPager ListGroups # 
AWSRequest ListGroups # 
ToQuery ListGroups # 
ToPath ListGroups # 
ToHeaders ListGroups # 

Methods

toHeaders :: ListGroups -> [Header] #

type Rep ListGroups # 
type Rep ListGroups = D1 (MetaData "ListGroups" "Network.AWS.IAM.ListGroups" "amazonka-iam-1.4.5-1ijrgQyRuWgA7Tx0390Dx2" 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 # 

Request Lenses

lgPathPrefix :: Lens' ListGroups (Maybe Text) #

The path prefix for filtering the results. For example, the prefix division_abcsubdivision_xyz/ gets all groups whose path starts with division_abcsubdivision_xyz/ . This parameter is optional. If it is not included, it defaults to a slash (), listing all groups. The <http:wikipedia.orgwikiregex 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) #

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) #

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 #

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:

  • lgrsMarker - When IsTruncated is true , this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
  • lgrsIsTruncated - 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 - -- | The response status code.
  • lgrsGroups - A list of groups.

data ListGroupsResponse #

Contains the response to a successful ListGroups request.

See: listGroupsResponse smart constructor.

Instances

Eq ListGroupsResponse # 
Data ListGroupsResponse # 

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 # 
Show ListGroupsResponse # 
Generic ListGroupsResponse # 
NFData ListGroupsResponse # 

Methods

rnf :: ListGroupsResponse -> () #

type Rep ListGroupsResponse # 
type Rep ListGroupsResponse = D1 (MetaData "ListGroupsResponse" "Network.AWS.IAM.ListGroups" "amazonka-iam-1.4.5-1ijrgQyRuWgA7Tx0390Dx2" 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) #

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) #

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 #

  • - | The response status code.

lgrsGroups :: Lens' ListGroupsResponse [Group] #

A list of groups.