Network.AWS.IAM.ListGroups

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.

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. This paramater allows (per its <http:wikipedia.orgwikiregex regex pattern> ) 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 - (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.

data ListGroups

See: listGroups smart constructor.

Instances

Eq ListGroups

Methods

(==) :: ListGroups -> ListGroups -> Bool

(/=) :: ListGroups -> ListGroups -> Bool

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

Methods

readsPrec :: Int -> ReadS ListGroups

readList :: ReadS [ListGroups]

readPrec :: ReadPrec ListGroups

readListPrec :: ReadPrec [ListGroups]

Show ListGroups

Methods

showsPrec :: Int -> ListGroups -> ShowS

show :: ListGroups -> String

showList :: [ListGroups] -> ShowS

Generic ListGroups

Associated Types

type Rep ListGroups :: * -> *

Methods

from :: ListGroups -> Rep ListGroups x

to :: Rep ListGroups x -> ListGroups

Hashable ListGroups

Methods

hashWithSalt :: Int -> ListGroups -> Int

hash :: ListGroups -> Int

NFData ListGroups

Methods

rnf :: ListGroups -> ()

AWSPager ListGroups

Methods

page :: ListGroups -> Rs ListGroups -> Maybe ListGroups

AWSRequest ListGroups

Associated Types

type Rs ListGroups :: *

Methods

request :: ListGroups -> Request ListGroups

response :: MonadResource m => Logger -> Service -> Proxy * ListGroups -> ClientResponse -> m (Response ListGroups)

ToQuery ListGroups

Methods

toQuery :: ListGroups -> QueryString

ToPath ListGroups

Methods

toPath :: ListGroups -> ByteString

ToHeaders ListGroups

Methods

toHeaders :: ListGroups -> [Header]

type Rep ListGroups

type Rep ListGroups = D1 (MetaData "ListGroups" "Network.AWS.IAM.ListGroups" "amazonka-iam-1.5.0-2w4nVHAOrDgI2P1QVLKd9e" 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

type Rs ListGroups = ListGroupsResponse

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. This paramater allows (per its <http:wikipedia.orgwikiregex regex pattern> ) 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)

(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.

Destructuring the Response

listGroupsResponse

Arguments

:: Int

lgrsResponseStatus

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

Methods

(==) :: ListGroupsResponse -> ListGroupsResponse -> Bool

(/=) :: ListGroupsResponse -> ListGroupsResponse -> Bool

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

Methods

readsPrec :: Int -> ReadS ListGroupsResponse

readList :: ReadS [ListGroupsResponse]

readPrec :: ReadPrec ListGroupsResponse

readListPrec :: ReadPrec [ListGroupsResponse]

Show ListGroupsResponse

Methods

showsPrec :: Int -> ListGroupsResponse -> ShowS

show :: ListGroupsResponse -> String

showList :: [ListGroupsResponse] -> ShowS

Generic ListGroupsResponse

Associated Types

type Rep ListGroupsResponse :: * -> *

Methods

from :: ListGroupsResponse -> Rep ListGroupsResponse x

to :: Rep ListGroupsResponse x -> ListGroupsResponse

NFData ListGroupsResponse

Methods

rnf :: ListGroupsResponse -> ()

type Rep ListGroupsResponse

type Rep ListGroupsResponse = D1 (MetaData "ListGroupsResponse" "Network.AWS.IAM.ListGroups" "amazonka-iam-1.5.0-2w4nVHAOrDgI2P1QVLKd9e" 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 DecidedStrict) (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.