Copyright | (c) 2013-2021 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 |
Retrieves a list of groups.
This operation returns paginated results.
Synopsis
- data ListGroups = ListGroups' {}
- newListGroups :: ListGroups
- listGroups_nextToken :: Lens' ListGroups (Maybe Text)
- listGroups_maxResults :: Lens' ListGroups (Maybe Text)
- data ListGroupsResponse = ListGroupsResponse' {
- groups :: Maybe [GroupInformation]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListGroupsResponse :: Int -> ListGroupsResponse
- listGroupsResponse_groups :: Lens' ListGroupsResponse (Maybe [GroupInformation])
- listGroupsResponse_nextToken :: Lens' ListGroupsResponse (Maybe Text)
- listGroupsResponse_httpStatus :: Lens' ListGroupsResponse Int
Creating a Request
data ListGroups Source #
See: newListGroups
smart constructor.
Instances
newListGroups :: ListGroups Source #
Create a value of ListGroups
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListGroups'
, listGroups_nextToken
- The token for the next set of results, or ''null'' if there are no
additional results.
$sel:maxResults:ListGroups'
, listGroups_maxResults
- The maximum number of results to be returned per request.
Request Lenses
listGroups_nextToken :: Lens' ListGroups (Maybe Text) Source #
The token for the next set of results, or ''null'' if there are no additional results.
listGroups_maxResults :: Lens' ListGroups (Maybe Text) Source #
The maximum number of results to be returned per request.
Destructuring the Response
data ListGroupsResponse Source #
See: newListGroupsResponse
smart constructor.
ListGroupsResponse' | |
|
Instances
newListGroupsResponse Source #
Create a value of ListGroupsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groups:ListGroupsResponse'
, listGroupsResponse_groups
- Information about a group.
$sel:nextToken:ListGroups'
, listGroupsResponse_nextToken
- The token for the next set of results, or ''null'' if there are no
additional results.
$sel:httpStatus:ListGroupsResponse'
, listGroupsResponse_httpStatus
- The response's http status code.
Response Lenses
listGroupsResponse_groups :: Lens' ListGroupsResponse (Maybe [GroupInformation]) Source #
Information about a group.
listGroupsResponse_nextToken :: Lens' ListGroupsResponse (Maybe Text) Source #
The token for the next set of results, or ''null'' if there are no additional results.
listGroupsResponse_httpStatus :: Lens' ListGroupsResponse Int Source #
The response's http status code.