Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Searches users and lists the ones that meet a set of filter and sort criteria.
This operation returns paginated results.
Synopsis
- searchUsers :: SearchUsers
- data SearchUsers
- suFilters :: Lens' SearchUsers [Filter]
- suSortCriteria :: Lens' SearchUsers [Sort]
- suNextToken :: Lens' SearchUsers (Maybe Text)
- suMaxResults :: Lens' SearchUsers (Maybe Natural)
- searchUsersResponse :: Int -> SearchUsersResponse
- data SearchUsersResponse
- sursUsers :: Lens' SearchUsersResponse [UserData]
- sursNextToken :: Lens' SearchUsersResponse (Maybe Text)
- sursTotalCount :: Lens' SearchUsersResponse (Maybe Int)
- sursResponseStatus :: Lens' SearchUsersResponse Int
Creating a Request
searchUsers :: SearchUsers Source #
Creates a value of SearchUsers
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
suFilters
- The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.suSortCriteria
- The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.suNextToken
- An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified byMaxResults
. Required.suMaxResults
- The maximum number of results to include in the response. If more results exist than the specifiedMaxResults
value, a token is included in the response so that the remaining results can be retrieved. Required.
data SearchUsers Source #
See: searchUsers
smart constructor.
Instances
Request Lenses
suFilters :: Lens' SearchUsers [Filter] Source #
The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
suSortCriteria :: Lens' SearchUsers [Sort] Source #
The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
suNextToken :: Lens' SearchUsers (Maybe Text) Source #
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults
. Required.
suMaxResults :: Lens' SearchUsers (Maybe Natural) Source #
The maximum number of results to include in the response. If more results exist than the specified MaxResults
value, a token is included in the response so that the remaining results can be retrieved. Required.
Destructuring the Response
Creates a value of SearchUsersResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sursUsers
- The users that meet the specified set of filter criteria, in sort order.sursNextToken
- The token returned to indicate that there is more data available.sursTotalCount
- The total number of users returned.sursResponseStatus
- -- | The response status code.
data SearchUsersResponse Source #
See: searchUsersResponse
smart constructor.
Instances
Response Lenses
sursUsers :: Lens' SearchUsersResponse [UserData] Source #
The users that meet the specified set of filter criteria, in sort order.
sursNextToken :: Lens' SearchUsersResponse (Maybe Text) Source #
The token returned to indicate that there is more data available.
sursTotalCount :: Lens' SearchUsersResponse (Maybe Int) Source #
The total number of users returned.
sursResponseStatus :: Lens' SearchUsersResponse Int Source #
- - | The response status code.