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 a list of user groups.
This operation returns paginated results.
Synopsis
- data DescribeUserGroups = DescribeUserGroups' {
- marker :: Maybe Text
- maxRecords :: Maybe Int
- userGroupId :: Maybe Text
- newDescribeUserGroups :: DescribeUserGroups
- describeUserGroups_marker :: Lens' DescribeUserGroups (Maybe Text)
- describeUserGroups_maxRecords :: Lens' DescribeUserGroups (Maybe Int)
- describeUserGroups_userGroupId :: Lens' DescribeUserGroups (Maybe Text)
- data DescribeUserGroupsResponse = DescribeUserGroupsResponse' {
- marker :: Maybe Text
- userGroups :: Maybe [UserGroup]
- httpStatus :: Int
- newDescribeUserGroupsResponse :: Int -> DescribeUserGroupsResponse
- describeUserGroupsResponse_marker :: Lens' DescribeUserGroupsResponse (Maybe Text)
- describeUserGroupsResponse_userGroups :: Lens' DescribeUserGroupsResponse (Maybe [UserGroup])
- describeUserGroupsResponse_httpStatus :: Lens' DescribeUserGroupsResponse Int
Creating a Request
data DescribeUserGroups Source #
See: newDescribeUserGroups
smart constructor.
DescribeUserGroups' | |
|
Instances
newDescribeUserGroups :: DescribeUserGroups Source #
Create a value of DescribeUserGroups
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:
DescribeUserGroups
, describeUserGroups_marker
- An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords. >
$sel:maxRecords:DescribeUserGroups'
, describeUserGroups_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a marker is included
in the response so that the remaining results can be retrieved.
DescribeUserGroups
, describeUserGroups_userGroupId
- The ID of the user group.
Request Lenses
describeUserGroups_marker :: Lens' DescribeUserGroups (Maybe Text) Source #
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >
describeUserGroups_maxRecords :: Lens' DescribeUserGroups (Maybe Int) Source #
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
describeUserGroups_userGroupId :: Lens' DescribeUserGroups (Maybe Text) Source #
The ID of the user group.
Destructuring the Response
data DescribeUserGroupsResponse Source #
See: newDescribeUserGroupsResponse
smart constructor.
DescribeUserGroupsResponse' | |
|
Instances
newDescribeUserGroupsResponse Source #
Create a value of DescribeUserGroupsResponse
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:
DescribeUserGroups
, describeUserGroupsResponse_marker
- An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords. >
DescribeUserGroupsResponse
, describeUserGroupsResponse_userGroups
- Returns a list of user groups.
$sel:httpStatus:DescribeUserGroupsResponse'
, describeUserGroupsResponse_httpStatus
- The response's http status code.
Response Lenses
describeUserGroupsResponse_marker :: Lens' DescribeUserGroupsResponse (Maybe Text) Source #
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >
describeUserGroupsResponse_userGroups :: Lens' DescribeUserGroupsResponse (Maybe [UserGroup]) Source #
Returns a list of user groups.
describeUserGroupsResponse_httpStatus :: Lens' DescribeUserGroupsResponse Int Source #
The response's http status code.