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.Connect.SearchUsers

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Searches users in an Amazon Connect instance, with optional filtering.

AfterContactWorkTimeLimit is returned in milliseconds.

This operation returns paginated results.

Synopsis

data SearchUsers = SearchUsers' {
- instanceId :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- searchCriteria :: Maybe UserSearchCriteria
- searchFilter :: Maybe UserSearchFilter
}
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' {
- approximateTotalCount :: Maybe Integer
- nextToken :: Maybe Text
- users :: Maybe [UserSearchSummary]
- httpStatus :: Int
}
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.

Constructors

SearchUsers'

Fields

instanceId :: Maybe Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
maxResults :: Maybe Natural
The maximum number of results to return per page.
nextToken :: Maybe Text
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.
searchCriteria :: Maybe UserSearchCriteria
searchFilter :: Maybe UserSearchFilter
Filters to be applied to search results.

Instances

Instances details

ToJSON SearchUsers Source #
Instance details Defined in Amazonka.Connect.SearchUsers Methods toJSON :: SearchUsers -> Value # toEncoding :: SearchUsers -> Encoding # toJSONList :: [SearchUsers] -> Value # toEncodingList :: [SearchUsers] -> Encoding #
ToHeaders SearchUsers Source #
Instance details Defined in Amazonka.Connect.SearchUsers Methods toHeaders :: SearchUsers -> [Header] #
ToPath SearchUsers Source #
Instance details Defined in Amazonka.Connect.SearchUsers Methods toPath :: SearchUsers -> ByteString #
ToQuery SearchUsers Source #
Instance details Defined in Amazonka.Connect.SearchUsers Methods toQuery :: SearchUsers -> QueryString #
AWSPager SearchUsers Source #
Instance details Defined in Amazonka.Connect.SearchUsers Methods page :: SearchUsers -> AWSResponse SearchUsers -> Maybe SearchUsers #
AWSRequest SearchUsers Source #
Instance details Defined in Amazonka.Connect.SearchUsers Associated Types type AWSResponse SearchUsers # Methods request :: (Service -> Service) -> SearchUsers -> Request SearchUsers # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SearchUsers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchUsers))) #
Generic SearchUsers Source #
Instance details Defined in Amazonka.Connect.SearchUsers Associated Types type Rep SearchUsers :: Type -> Type # Methods from :: SearchUsers -> Rep SearchUsers x # to :: Rep SearchUsers x -> SearchUsers #
Read SearchUsers Source #
Instance details Defined in Amazonka.Connect.SearchUsers Methods readsPrec :: Int -> ReadS SearchUsers # readList :: ReadS [SearchUsers] # readPrec :: ReadPrec SearchUsers # readListPrec :: ReadPrec [SearchUsers] #
Show SearchUsers Source #
Instance details Defined in Amazonka.Connect.SearchUsers Methods showsPrec :: Int -> SearchUsers -> ShowS # show :: SearchUsers -> String # showList :: [SearchUsers] -> ShowS #
NFData SearchUsers Source #
Instance details Defined in Amazonka.Connect.SearchUsers Methods rnf :: SearchUsers -> () #
Eq SearchUsers Source #
Instance details Defined in Amazonka.Connect.SearchUsers Methods (==) :: SearchUsers -> SearchUsers -> Bool # (/=) :: SearchUsers -> SearchUsers -> Bool #
Hashable SearchUsers Source #
Instance details Defined in Amazonka.Connect.SearchUsers Methods hashWithSalt :: Int -> SearchUsers -> Int # hash :: SearchUsers -> Int #
type AWSResponse SearchUsers Source #
Instance details Defined in Amazonka.Connect.SearchUsers type AWSResponse SearchUsers = SearchUsersResponse
type Rep SearchUsers Source #
Instance details Defined in Amazonka.Connect.SearchUsers type Rep SearchUsers = D1 ('MetaData "SearchUsers" "Amazonka.Connect.SearchUsers" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "SearchUsers'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "searchCriteria") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserSearchCriteria)) :: S1 ('MetaSel ('Just "searchFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserSearchFilter))))))

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.

Constructors

SearchUsersResponse'
Fields approximateTotalCount :: Maybe Integer The total number of users who matched your search query. nextToken :: Maybe Text If there are additional results, this is the token for the next set of results. users :: Maybe [UserSearchSummary] Information about the users. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic SearchUsersResponse Source #
Instance details Defined in Amazonka.Connect.SearchUsers Associated Types type Rep SearchUsersResponse :: Type -> Type # Methods from :: SearchUsersResponse -> Rep SearchUsersResponse x # to :: Rep SearchUsersResponse x -> SearchUsersResponse #
Read SearchUsersResponse Source #
Instance details Defined in Amazonka.Connect.SearchUsers Methods readsPrec :: Int -> ReadS SearchUsersResponse # readList :: ReadS [SearchUsersResponse] # readPrec :: ReadPrec SearchUsersResponse # readListPrec :: ReadPrec [SearchUsersResponse] #
Show SearchUsersResponse Source #
Instance details Defined in Amazonka.Connect.SearchUsers Methods showsPrec :: Int -> SearchUsersResponse -> ShowS # show :: SearchUsersResponse -> String # showList :: [SearchUsersResponse] -> ShowS #
NFData SearchUsersResponse Source #
Instance details Defined in Amazonka.Connect.SearchUsers Methods rnf :: SearchUsersResponse -> () #
Eq SearchUsersResponse Source #
Instance details Defined in Amazonka.Connect.SearchUsers Methods (==) :: SearchUsersResponse -> SearchUsersResponse -> Bool # (/=) :: SearchUsersResponse -> SearchUsersResponse -> Bool #
type Rep SearchUsersResponse Source #
Instance details Defined in Amazonka.Connect.SearchUsers type Rep SearchUsersResponse = D1 ('MetaData "SearchUsersResponse" "Amazonka.Connect.SearchUsers" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "SearchUsersResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "approximateTotalCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "users") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UserSearchSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchUsersResponse Source #

Arguments

:: Int	`$sel:httpStatus:SearchUsersResponse'`
-> SearchUsersResponse

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.