Network.AWS.IAM.GetGroup

Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the MaxItems and Marker parameters.

This operation returns paginated results.

Creating a Request

getGroup

Arguments

:: Text

ggGroupName

-> GetGroup

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

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

• ggMarker - 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.
• ggMaxItems - 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.
• ggGroupName - The name of the group. The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

data GetGroup

See: getGroup smart constructor.

Instances

Eq GetGroup

Methods

(==) :: GetGroup -> GetGroup -> Bool

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

Data GetGroup

Methods

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

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

toConstr :: GetGroup -> Constr

dataTypeOf :: GetGroup -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> GetGroup -> GetGroup

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

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

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

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

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

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

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

Read GetGroup

Methods

readsPrec :: Int -> ReadS GetGroup

readList :: ReadS [GetGroup]

readPrec :: ReadPrec GetGroup

readListPrec :: ReadPrec [GetGroup]

Show GetGroup

Methods

showsPrec :: Int -> GetGroup -> ShowS

show :: GetGroup -> String

showList :: [GetGroup] -> ShowS

Generic GetGroup

Associated Types

type Rep GetGroup :: * -> *

Methods

from :: GetGroup -> Rep GetGroup x

to :: Rep GetGroup x -> GetGroup

Hashable GetGroup

Methods

hashWithSalt :: Int -> GetGroup -> Int

hash :: GetGroup -> Int

NFData GetGroup

Methods

rnf :: GetGroup -> ()

AWSPager GetGroup

Methods

page :: GetGroup -> Rs GetGroup -> Maybe GetGroup

AWSRequest GetGroup

Associated Types

type Rs GetGroup :: *

Methods

request :: GetGroup -> Request GetGroup

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

ToPath GetGroup

Methods

toPath :: GetGroup -> ByteString

ToHeaders GetGroup

Methods

toHeaders :: GetGroup -> [Header]

ToQuery GetGroup

Methods

toQuery :: GetGroup -> QueryString

type Rep GetGroup

type Rep GetGroup = D1 (MetaData "GetGroup" "Network.AWS.IAM.GetGroup" "amazonka-iam-1.4.5-tAuuyG7nyKEp3j6LBO0rr" False) (C1 (MetaCons "GetGroup'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ggMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ggMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_ggGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs GetGroup

type Rs GetGroup = GetGroupResponse

Request Lenses

ggMarker :: Lens' GetGroup (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.

ggMaxItems :: Lens' GetGroup (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.

ggGroupName :: Lens' GetGroup Text

The name of the group. The regex pattern for this parameter is 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

getGroupResponse

Arguments

:: Int

ggrsResponseStatus

-> Group

ggrsGroup

-> GetGroupResponse

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

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

• ggrsMarker - When IsTruncated is true , this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
• ggrsIsTruncated - 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.
• ggrsResponseStatus - -- | The response status code.
• ggrsGroup - A structure that contains details about the group.
• ggrsUsers - A list of users in the group.

data GetGroupResponse

Contains the response to a successful GetGroup request.

See: getGroupResponse smart constructor.

Instances

Eq GetGroupResponse

Methods

(==) :: GetGroupResponse -> GetGroupResponse -> Bool

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

Data GetGroupResponse

Methods

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

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

toConstr :: GetGroupResponse -> Constr

dataTypeOf :: GetGroupResponse -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> GetGroupResponse -> GetGroupResponse

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

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

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

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

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

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

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

Read GetGroupResponse

Methods

readsPrec :: Int -> ReadS GetGroupResponse

readList :: ReadS [GetGroupResponse]

readPrec :: ReadPrec GetGroupResponse

readListPrec :: ReadPrec [GetGroupResponse]

Show GetGroupResponse

Methods

showsPrec :: Int -> GetGroupResponse -> ShowS

show :: GetGroupResponse -> String

showList :: [GetGroupResponse] -> ShowS

Generic GetGroupResponse

Associated Types

type Rep GetGroupResponse :: * -> *

Methods

from :: GetGroupResponse -> Rep GetGroupResponse x

to :: Rep GetGroupResponse x -> GetGroupResponse

NFData GetGroupResponse

Methods

rnf :: GetGroupResponse -> ()

type Rep GetGroupResponse

type Rep GetGroupResponse = D1 (MetaData "GetGroupResponse" "Network.AWS.IAM.GetGroup" "amazonka-iam-1.4.5-tAuuyG7nyKEp3j6LBO0rr" False) (C1 (MetaCons "GetGroupResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ggrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ggrsIsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_ggrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)) ((:*:) (S1 (MetaSel (Just Symbol "_ggrsGroup") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Group)) (S1 (MetaSel (Just Symbol "_ggrsUsers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [User]))))))

Response Lenses

ggrsMarker :: Lens' GetGroupResponse (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.

ggrsIsTruncated :: Lens' GetGroupResponse (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.

ggrsResponseStatus :: Lens' GetGroupResponse Int

• - | The response status code.

ggrsGroup :: Lens' GetGroupResponse Group

A structure that contains details about the group.

ggrsUsers :: Lens' GetGroupResponse [User]

A list of users in the group.