| 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.Synthetics.ListGroups
Description
Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups from all Regions are returned.
Synopsis
- data ListGroups = ListGroups' {}
- newListGroups :: ListGroups
- listGroups_maxResults :: Lens' ListGroups (Maybe Natural)
- listGroups_nextToken :: Lens' ListGroups (Maybe Text)
- data ListGroupsResponse = ListGroupsResponse' {
- groups :: Maybe [GroupSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListGroupsResponse :: Int -> ListGroupsResponse
- listGroupsResponse_groups :: Lens' ListGroupsResponse (Maybe [GroupSummary])
- listGroupsResponse_nextToken :: Lens' ListGroupsResponse (Maybe Text)
- listGroupsResponse_httpStatus :: Lens' ListGroupsResponse Int
Creating a Request
data ListGroups Source #
See: newListGroups smart constructor.
Constructors
| ListGroups' | |
Fields
| |
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:maxResults:ListGroups', listGroups_maxResults - Specify this parameter to limit how many groups are returned each time
you use the ListGroups operation. If you omit this parameter, the
default of 20 is used.
ListGroups, listGroups_nextToken - A token that indicates that there is more data available. You can use
this token in a subsequent operation to retrieve the next set of
results.
Request Lenses
listGroups_maxResults :: Lens' ListGroups (Maybe Natural) Source #
Specify this parameter to limit how many groups are returned each time
you use the ListGroups operation. If you omit this parameter, the
default of 20 is used.
listGroups_nextToken :: Lens' ListGroups (Maybe Text) Source #
A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.
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:
$sel:groups:ListGroupsResponse', listGroupsResponse_groups - An array of structures that each contain information about one group.
ListGroups, listGroupsResponse_nextToken - A token that indicates that there is more data available. You can use
this token in a subsequent ListGroups operation to retrieve the next
set of results.
$sel:httpStatus:ListGroupsResponse', listGroupsResponse_httpStatus - The response's http status code.
Response Lenses
listGroupsResponse_groups :: Lens' ListGroupsResponse (Maybe [GroupSummary]) Source #
An array of structures that each contain information about one group.
listGroupsResponse_nextToken :: Lens' ListGroupsResponse (Maybe Text) Source #
A token that indicates that there is more data available. You can use
this token in a subsequent ListGroups operation to retrieve the next
set of results.
listGroupsResponse_httpStatus :: Lens' ListGroupsResponse Int Source #
The response's http status code.