Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Returns summaries of the organization's groups.
This operation returns paginated results.
Synopsis
- data ListGroups = ListGroups' {}
- newListGroups :: Text -> ListGroups
- listGroups_maxResults :: Lens' ListGroups (Maybe Natural)
- listGroups_nextToken :: Lens' ListGroups (Maybe Text)
- listGroups_organizationId :: Lens' ListGroups Text
- data ListGroupsResponse = ListGroupsResponse' {}
- newListGroupsResponse :: Int -> ListGroupsResponse
- listGroupsResponse_groups :: Lens' ListGroupsResponse (Maybe [Group])
- listGroupsResponse_nextToken :: Lens' ListGroupsResponse (Maybe Text)
- listGroupsResponse_httpStatus :: Lens' ListGroupsResponse Int
Creating a Request
data ListGroups Source #
See: newListGroups
smart constructor.
ListGroups' | |
|
Instances
:: Text | |
-> ListGroups |
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:maxResults:ListGroups'
, listGroups_maxResults
- The maximum number of results to return in a single call.
ListGroups
, listGroups_nextToken
- The token to use to retrieve the next page of results. The first call
does not contain any tokens.
ListGroups
, listGroups_organizationId
- The identifier for the organization under which the groups exist.
Request Lenses
listGroups_maxResults :: Lens' ListGroups (Maybe Natural) Source #
The maximum number of results to return in a single call.
listGroups_nextToken :: Lens' ListGroups (Maybe Text) Source #
The token to use to retrieve the next page of results. The first call does not contain any tokens.
listGroups_organizationId :: Lens' ListGroups Text Source #
The identifier for the organization under which the groups exist.
Destructuring the Response
data ListGroupsResponse Source #
See: newListGroupsResponse
smart constructor.
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
- The overview of groups for an organization.
ListGroups
, listGroupsResponse_nextToken
- The token to use to retrieve the next page of results. The value is
"null" when there are no more results to return.
$sel:httpStatus:ListGroupsResponse'
, listGroupsResponse_httpStatus
- The response's http status code.
Response Lenses
listGroupsResponse_groups :: Lens' ListGroupsResponse (Maybe [Group]) Source #
The overview of groups for an organization.
listGroupsResponse_nextToken :: 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.
listGroupsResponse_httpStatus :: Lens' ListGroupsResponse Int Source #
The response's http status code.