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 |
Searches users in an Amazon Connect instance, with optional filtering.
AfterContactWorkTimeLimit
is returned in milliseconds.
This operation returns paginated results.
Synopsis
- data SearchUsers = SearchUsers' {}
- newSearchUsers :: SearchUsers
- searchUsers_instanceId :: Lens' SearchUsers (Maybe Text)
- searchUsers_maxResults :: Lens' SearchUsers (Maybe Natural)
- searchUsers_nextToken :: Lens' SearchUsers (Maybe Text)
- searchUsers_searchCriteria :: Lens' SearchUsers (Maybe UserSearchCriteria)
- searchUsers_searchFilter :: Lens' SearchUsers (Maybe UserSearchFilter)
- data SearchUsersResponse = SearchUsersResponse' {}
- newSearchUsersResponse :: Int -> SearchUsersResponse
- searchUsersResponse_approximateTotalCount :: Lens' SearchUsersResponse (Maybe Integer)
- searchUsersResponse_nextToken :: Lens' SearchUsersResponse (Maybe Text)
- searchUsersResponse_users :: Lens' SearchUsersResponse (Maybe [UserSearchSummary])
- searchUsersResponse_httpStatus :: Lens' SearchUsersResponse Int
Creating a Request
data SearchUsers Source #
See: newSearchUsers
smart constructor.
SearchUsers' | |
|
Instances
newSearchUsers :: SearchUsers Source #
Create a value of SearchUsers
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:
SearchUsers
, searchUsers_instanceId
- The identifier of the Amazon Connect instance. You can find the
instanceId in the ARN of the instance.
$sel:maxResults:SearchUsers'
, searchUsers_maxResults
- The maximum number of results to return per page.
SearchUsers
, searchUsers_nextToken
- The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of
results.
$sel:searchCriteria:SearchUsers'
, searchUsers_searchCriteria
- Undocumented member.
$sel:searchFilter:SearchUsers'
, searchUsers_searchFilter
- Filters to be applied to search results.
Request Lenses
searchUsers_instanceId :: Lens' SearchUsers (Maybe Text) Source #
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
searchUsers_maxResults :: Lens' SearchUsers (Maybe Natural) Source #
The maximum number of results to return per page.
searchUsers_nextToken :: Lens' SearchUsers (Maybe Text) Source #
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
searchUsers_searchCriteria :: Lens' SearchUsers (Maybe UserSearchCriteria) Source #
Undocumented member.
searchUsers_searchFilter :: Lens' SearchUsers (Maybe UserSearchFilter) Source #
Filters to be applied to search results.
Destructuring the Response
data SearchUsersResponse Source #
See: newSearchUsersResponse
smart constructor.
SearchUsersResponse' | |
|
Instances
newSearchUsersResponse Source #
Create a value of SearchUsersResponse
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:approximateTotalCount:SearchUsersResponse'
, searchUsersResponse_approximateTotalCount
- The total number of users who matched your search query.
SearchUsers
, searchUsersResponse_nextToken
- If there are additional results, this is the token for the next set of
results.
$sel:users:SearchUsersResponse'
, searchUsersResponse_users
- Information about the users.
$sel:httpStatus:SearchUsersResponse'
, searchUsersResponse_httpStatus
- The response's http status code.
Response Lenses
searchUsersResponse_approximateTotalCount :: Lens' SearchUsersResponse (Maybe Integer) Source #
The total number of users who matched your search query.
searchUsersResponse_nextToken :: Lens' SearchUsersResponse (Maybe Text) Source #
If there are additional results, this is the token for the next set of results.
searchUsersResponse_users :: Lens' SearchUsersResponse (Maybe [UserSearchSummary]) Source #
Information about the users.
searchUsersResponse_httpStatus :: Lens' SearchUsersResponse Int Source #
The response's http status code.