Copyright | (c) 2013-2018 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 |
Returns summaries of the organization's groups.
This operation returns paginated results.
Synopsis
- listGroups :: Text -> ListGroups
- data ListGroups
- lgNextToken :: Lens' ListGroups (Maybe Text)
- lgMaxResults :: Lens' ListGroups (Maybe Natural)
- lgOrganizationId :: Lens' ListGroups Text
- listGroupsResponse :: Int -> ListGroupsResponse
- data ListGroupsResponse
- lgrsGroups :: Lens' ListGroupsResponse [Group]
- 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
- The token to use to retrieve the next page of results. The first call does not contain any tokens.lgMaxResults
- The maximum number of results to return in a single call.lgOrganizationId
- The identifier for the organization under which the groups exist.
data ListGroups Source #
See: listGroups
smart constructor.
Instances
Request Lenses
lgNextToken :: Lens' ListGroups (Maybe Text) Source #
The token to use to retrieve the next page of results. The first call does not contain any tokens.
lgMaxResults :: Lens' ListGroups (Maybe Natural) Source #
The maximum number of results to return in a single call.
lgOrganizationId :: Lens' ListGroups Text Source #
The identifier for the organization under which the groups exist.
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 overview of groups for an organization.lgrsNextToken
- The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.lgrsResponseStatus
- -- | The response status code.
data ListGroupsResponse Source #
See: listGroupsResponse
smart constructor.
Instances
Response Lenses
lgrsGroups :: Lens' ListGroupsResponse [Group] Source #
The overview of groups for an organization.
lgrsNextToken :: Lens' ListGroupsResponse (Maybe Text) Source #
The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.
lgrsResponseStatus :: Lens' ListGroupsResponse Int Source #
- - | The response status code.