Network.AWS.IAM.GetGroup

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

See: AWS API Reference for GetGroup.

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:

• ggMaxItems
• ggMarker
• ggGroupName

data GetGroup

See: getGroup smart constructor.

Instances

Eq GetGroup

Data GetGroup

Read GetGroup

Show GetGroup

Generic GetGroup

AWSPager GetGroup

AWSRequest GetGroup

ToPath GetGroup

ToHeaders GetGroup

ToQuery GetGroup

Typeable * GetGroup

type Rep GetGroup

type Rs GetGroup = GetGroupResponse

Request Lenses

ggMaxItems :: Lens' GetGroup (Maybe Natural)

Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items 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.

ggMarker :: Lens' GetGroup (Maybe Text)

Use this parameter only when paginating results and only after you have received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

ggGroupName :: Lens' GetGroup Text

The name of the group.

Destructuring the Response

getGroupResponse

Arguments

:: Int

ggrsStatus

-> 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
• ggrsIsTruncated
• ggrsStatus
• ggrsGroup
• ggrsUsers

data GetGroupResponse

Contains the response to a successful GetGroup request.

See: getGroupResponse smart constructor.

Instances

Eq GetGroupResponse

Data GetGroupResponse

Read GetGroupResponse

Show GetGroupResponse

Generic GetGroupResponse

Typeable * GetGroupResponse

type Rep GetGroupResponse

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.

ggrsStatus :: Lens' GetGroupResponse Int

The response status code.

ggrsGroup :: Lens' GetGroupResponse Group

Information about the group.

ggrsUsers :: Lens' GetGroupResponse [User]

A list of users in the group.