| 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 |
Amazonka.IdentityStore.ListGroups
Description
Lists all groups in the identity store. Returns a paginated list of
complete Group objects. Filtering for a Group by the DisplayName
attribute is deprecated. Instead, use the GetGroupId API action.
This operation returns paginated results.
Synopsis
- data ListGroups = ListGroups' {}
- newListGroups :: Text -> ListGroups
- listGroups_filters :: Lens' ListGroups (Maybe [Filter])
- listGroups_maxResults :: Lens' ListGroups (Maybe Natural)
- listGroups_nextToken :: Lens' ListGroups (Maybe Text)
- listGroups_identityStoreId :: Lens' ListGroups Text
- data ListGroupsResponse = ListGroupsResponse' {}
- newListGroupsResponse :: Int -> ListGroupsResponse
- listGroupsResponse_nextToken :: Lens' ListGroupsResponse (Maybe Text)
- listGroupsResponse_httpStatus :: Lens' ListGroupsResponse Int
- listGroupsResponse_groups :: Lens' ListGroupsResponse [Group]
Creating a Request
data ListGroups Source #
See: newListGroups smart constructor.
Constructors
| ListGroups' | |
Fields
| |
Instances
Arguments
| :: 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:filters:ListGroups', listGroups_filters - A list of Filter objects, which is used in the ListUsers and
ListGroups requests.
$sel:maxResults:ListGroups', listGroups_maxResults - The maximum number of results to be returned per request. This parameter
is used in the ListUsers and ListGroups requests to specify how many
results to return in one page. The length limit is 50 characters.
ListGroups, listGroups_nextToken - The pagination token used for the ListUsers and ListGroups API
operations. This value is generated by the identity store service. It is
returned in the API response if the total results are more than the size
of one page. This token is also returned when it is used in the API
request to search for the next page.
ListGroups, listGroups_identityStoreId - The globally unique identifier for the identity store, such as
d-1234567890. In this example, d- is a fixed prefix, and
1234567890 is a randomly generated string that contains numbers and
lower case letters. This value is generated at the time that a new
identity store is created.
Request Lenses
listGroups_filters :: Lens' ListGroups (Maybe [Filter]) Source #
A list of Filter objects, which is used in the ListUsers and
ListGroups requests.
listGroups_maxResults :: Lens' ListGroups (Maybe Natural) Source #
The maximum number of results to be returned per request. This parameter
is used in the ListUsers and ListGroups requests to specify how many
results to return in one page. The length limit is 50 characters.
listGroups_nextToken :: Lens' ListGroups (Maybe Text) Source #
The pagination token used for the ListUsers and ListGroups API
operations. This value is generated by the identity store service. It is
returned in the API response if the total results are more than the size
of one page. This token is also returned when it is used in the API
request to search for the next page.
listGroups_identityStoreId :: Lens' ListGroups Text Source #
The globally unique identifier for the identity store, such as
d-1234567890. In this example, d- is a fixed prefix, and
1234567890 is a randomly generated string that contains numbers and
lower case letters. This value is generated at the time that a new
identity store is created.
Destructuring the Response
data ListGroupsResponse Source #
See: newListGroupsResponse smart constructor.
Constructors
| ListGroupsResponse' | |
Fields
| |
Instances
newListGroupsResponse Source #
Arguments
| :: Int | |
| -> ListGroupsResponse |
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:
ListGroups, listGroupsResponse_nextToken - The pagination token used for the ListUsers and ListGroups API
operations. This value is generated by the identity store service. It is
returned in the API response if the total results are more than the size
of one page. This token is also returned when it1 is used in the API
request to search for the next page.
$sel:httpStatus:ListGroupsResponse', listGroupsResponse_httpStatus - The response's http status code.
$sel:groups:ListGroupsResponse', listGroupsResponse_groups - A list of Group objects in the identity store.
Response Lenses
listGroupsResponse_nextToken :: Lens' ListGroupsResponse (Maybe Text) Source #
The pagination token used for the ListUsers and ListGroups API
operations. This value is generated by the identity store service. It is
returned in the API response if the total results are more than the size
of one page. This token is also returned when it1 is used in the API
request to search for the next page.
listGroupsResponse_httpStatus :: Lens' ListGroupsResponse Int Source #
The response's http status code.
listGroupsResponse_groups :: Lens' ListGroupsResponse [Group] Source #
A list of Group objects in the identity store.