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

Copyright(c) 2013-2017 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.IAM.ListGroupsForUser

Contents

Description

Lists the IAM groups that the specified IAM user belongs to.

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

This operation returns paginated results.

Synopsis

Creating a Request

listGroupsForUser Source #

Creates a value of ListGroupsForUser with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • lgfuMarker - 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.
  • lgfuMaxItems - (Optional) 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 . If you do not include this parameter, 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.
  • lgfuUserName - The name of the user to list groups for. This parameter allows (per its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

data ListGroupsForUser Source #

See: listGroupsForUser smart constructor.

Instances

Eq ListGroupsForUser Source # 
Data ListGroupsForUser Source # 

Methods

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

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

toConstr :: ListGroupsForUser -> Constr #

dataTypeOf :: ListGroupsForUser -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListGroupsForUser Source # 
Show ListGroupsForUser Source # 
Generic ListGroupsForUser Source # 
Hashable ListGroupsForUser Source # 
NFData ListGroupsForUser Source # 

Methods

rnf :: ListGroupsForUser -> () #

AWSPager ListGroupsForUser Source # 
AWSRequest ListGroupsForUser Source # 
ToQuery ListGroupsForUser Source # 
ToPath ListGroupsForUser Source # 
ToHeaders ListGroupsForUser Source # 
type Rep ListGroupsForUser Source # 
type Rep ListGroupsForUser = D1 (MetaData "ListGroupsForUser" "Network.AWS.IAM.ListGroupsForUser" "amazonka-iam-1.5.0-2w4nVHAOrDgI2P1QVLKd9e" False) (C1 (MetaCons "ListGroupsForUser'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lgfuMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lgfuMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_lgfuUserName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs ListGroupsForUser Source # 

Request Lenses

lgfuMarker :: Lens' ListGroupsForUser (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.

lgfuMaxItems :: Lens' ListGroupsForUser (Maybe Natural) Source #

(Optional) 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 . If you do not include this parameter, 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.

lgfuUserName :: Lens' ListGroupsForUser Text Source #

The name of the user to list groups for. This parameter allows (per its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Destructuring the Response

listGroupsForUserResponse Source #

Creates a value of ListGroupsForUserResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

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

data ListGroupsForUserResponse Source #

Contains the response to a successful ListGroupsForUser request.

See: listGroupsForUserResponse smart constructor.

Instances

Eq ListGroupsForUserResponse Source # 
Data ListGroupsForUserResponse Source # 

Methods

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

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

toConstr :: ListGroupsForUserResponse -> Constr #

dataTypeOf :: ListGroupsForUserResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListGroupsForUserResponse Source # 
Show ListGroupsForUserResponse Source # 
Generic ListGroupsForUserResponse Source # 
NFData ListGroupsForUserResponse Source # 
type Rep ListGroupsForUserResponse Source # 
type Rep ListGroupsForUserResponse = D1 (MetaData "ListGroupsForUserResponse" "Network.AWS.IAM.ListGroupsForUser" "amazonka-iam-1.5.0-2w4nVHAOrDgI2P1QVLKd9e" False) (C1 (MetaCons "ListGroupsForUserResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lgfursMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lgfursIsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_lgfursResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_lgfursGroups") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Group])))))

Response Lenses

lgfursMarker :: Lens' ListGroupsForUserResponse (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.

lgfursIsTruncated :: Lens' ListGroupsForUserResponse (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.