Copyright | (c) 2013-2017 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Lists the groups associated with a user pool.
Requires developer credentials.
- listGroups :: Text -> ListGroups
- data ListGroups
- lgNextToken :: Lens' ListGroups (Maybe Text)
- lgLimit :: Lens' ListGroups (Maybe Natural)
- lgUserPoolId :: Lens' ListGroups Text
- listGroupsResponse :: Int -> ListGroupsResponse
- data ListGroupsResponse
- lgrsGroups :: Lens' ListGroupsResponse [GroupType]
- lgrsNextToken :: Lens' ListGroupsResponse (Maybe Text)
- lgrsResponseStatus :: Lens' ListGroupsResponse Int
Creating a Request
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:
lgNextToken
- An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.lgLimit
- The limit of the request to list groups.lgUserPoolId
- The user pool ID for the user pool.
data ListGroups Source #
See: listGroups
smart constructor.
Request Lenses
lgNextToken :: Lens' ListGroups (Maybe Text) Source #
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
lgUserPoolId :: Lens' ListGroups Text Source #
The user pool ID for the user pool.
Destructuring the Response
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:
lgrsGroups
- The group objects for the groups.lgrsNextToken
- An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.lgrsResponseStatus
- -- | The response status code.
data ListGroupsResponse Source #
See: listGroupsResponse
smart constructor.
Response Lenses
lgrsGroups :: Lens' ListGroupsResponse [GroupType] Source #
The group objects for the groups.
lgrsNextToken :: Lens' ListGroupsResponse (Maybe Text) Source #
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
lgrsResponseStatus :: Lens' ListGroupsResponse Int Source #
- - | The response status code.