{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.Connect.SearchUsers
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Searches users in an Amazon Connect instance, with optional filtering.
--
-- @AfterContactWorkTimeLimit@ is returned in milliseconds.
--
-- This operation returns paginated results.
module Amazonka.Connect.SearchUsers
  ( -- * Creating a Request
    SearchUsers (..),
    newSearchUsers,

    -- * Request Lenses
    searchUsers_instanceId,
    searchUsers_maxResults,
    searchUsers_nextToken,
    searchUsers_searchCriteria,
    searchUsers_searchFilter,

    -- * Destructuring the Response
    SearchUsersResponse (..),
    newSearchUsersResponse,

    -- * Response Lenses
    searchUsersResponse_approximateTotalCount,
    searchUsersResponse_nextToken,
    searchUsersResponse_users,
    searchUsersResponse_httpStatus,
  )
where

import Amazonka.Connect.Types
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newSearchUsers' smart constructor.
data SearchUsers = SearchUsers'
  { -- | The identifier of the Amazon Connect instance. You can find the
    -- instanceId in the ARN of the instance.
    SearchUsers -> Maybe Text
instanceId :: Prelude.Maybe Prelude.Text,
    -- | The maximum number of results to return per page.
    SearchUsers -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | 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 -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    SearchUsers -> Maybe UserSearchCriteria
searchCriteria :: Prelude.Maybe UserSearchCriteria,
    -- | Filters to be applied to search results.
    SearchUsers -> Maybe UserSearchFilter
searchFilter :: Prelude.Maybe UserSearchFilter
  }
  deriving (SearchUsers -> SearchUsers -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: SearchUsers -> SearchUsers -> Bool
$c/= :: SearchUsers -> SearchUsers -> Bool
== :: SearchUsers -> SearchUsers -> Bool
$c== :: SearchUsers -> SearchUsers -> Bool
Prelude.Eq, ReadPrec [SearchUsers]
ReadPrec SearchUsers
Int -> ReadS SearchUsers
ReadS [SearchUsers]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [SearchUsers]
$creadListPrec :: ReadPrec [SearchUsers]
readPrec :: ReadPrec SearchUsers
$creadPrec :: ReadPrec SearchUsers
readList :: ReadS [SearchUsers]
$creadList :: ReadS [SearchUsers]
readsPrec :: Int -> ReadS SearchUsers
$creadsPrec :: Int -> ReadS SearchUsers
Prelude.Read, Int -> SearchUsers -> ShowS
[SearchUsers] -> ShowS
SearchUsers -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [SearchUsers] -> ShowS
$cshowList :: [SearchUsers] -> ShowS
show :: SearchUsers -> String
$cshow :: SearchUsers -> String
showsPrec :: Int -> SearchUsers -> ShowS
$cshowsPrec :: Int -> SearchUsers -> ShowS
Prelude.Show, forall x. Rep SearchUsers x -> SearchUsers
forall x. SearchUsers -> Rep SearchUsers x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep SearchUsers x -> SearchUsers
$cfrom :: forall x. SearchUsers -> Rep SearchUsers x
Prelude.Generic)

-- |
-- Create a value of 'SearchUsers' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'instanceId', 'searchUsers_instanceId' - The identifier of the Amazon Connect instance. You can find the
-- instanceId in the ARN of the instance.
--
-- 'maxResults', 'searchUsers_maxResults' - The maximum number of results to return per page.
--
-- 'nextToken', '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.
--
-- 'searchCriteria', 'searchUsers_searchCriteria' - Undocumented member.
--
-- 'searchFilter', 'searchUsers_searchFilter' - Filters to be applied to search results.
newSearchUsers ::
  SearchUsers
newSearchUsers :: SearchUsers
newSearchUsers =
  SearchUsers'
    { $sel:instanceId:SearchUsers' :: Maybe Text
instanceId = forall a. Maybe a
Prelude.Nothing,
      $sel:maxResults:SearchUsers' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:SearchUsers' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:searchCriteria:SearchUsers' :: Maybe UserSearchCriteria
searchCriteria = forall a. Maybe a
Prelude.Nothing,
      $sel:searchFilter:SearchUsers' :: Maybe UserSearchFilter
searchFilter = forall a. Maybe a
Prelude.Nothing
    }

-- | The identifier of the Amazon Connect instance. You can find the
-- instanceId in the ARN of the instance.
searchUsers_instanceId :: Lens.Lens' SearchUsers (Prelude.Maybe Prelude.Text)
searchUsers_instanceId :: Lens' SearchUsers (Maybe Text)
searchUsers_instanceId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SearchUsers' {Maybe Text
instanceId :: Maybe Text
$sel:instanceId:SearchUsers' :: SearchUsers -> Maybe Text
instanceId} -> Maybe Text
instanceId) (\s :: SearchUsers
s@SearchUsers' {} Maybe Text
a -> SearchUsers
s {$sel:instanceId:SearchUsers' :: Maybe Text
instanceId = Maybe Text
a} :: SearchUsers)

-- | The maximum number of results to return per page.
searchUsers_maxResults :: Lens.Lens' SearchUsers (Prelude.Maybe Prelude.Natural)
searchUsers_maxResults :: Lens' SearchUsers (Maybe Natural)
searchUsers_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SearchUsers' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:SearchUsers' :: SearchUsers -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: SearchUsers
s@SearchUsers' {} Maybe Natural
a -> SearchUsers
s {$sel:maxResults:SearchUsers' :: Maybe Natural
maxResults = Maybe Natural
a} :: SearchUsers)

-- | 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_nextToken :: Lens.Lens' SearchUsers (Prelude.Maybe Prelude.Text)
searchUsers_nextToken :: Lens' SearchUsers (Maybe Text)
searchUsers_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SearchUsers' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:SearchUsers' :: SearchUsers -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: SearchUsers
s@SearchUsers' {} Maybe Text
a -> SearchUsers
s {$sel:nextToken:SearchUsers' :: Maybe Text
nextToken = Maybe Text
a} :: SearchUsers)

-- | Undocumented member.
searchUsers_searchCriteria :: Lens.Lens' SearchUsers (Prelude.Maybe UserSearchCriteria)
searchUsers_searchCriteria :: Lens' SearchUsers (Maybe UserSearchCriteria)
searchUsers_searchCriteria = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SearchUsers' {Maybe UserSearchCriteria
searchCriteria :: Maybe UserSearchCriteria
$sel:searchCriteria:SearchUsers' :: SearchUsers -> Maybe UserSearchCriteria
searchCriteria} -> Maybe UserSearchCriteria
searchCriteria) (\s :: SearchUsers
s@SearchUsers' {} Maybe UserSearchCriteria
a -> SearchUsers
s {$sel:searchCriteria:SearchUsers' :: Maybe UserSearchCriteria
searchCriteria = Maybe UserSearchCriteria
a} :: SearchUsers)

-- | Filters to be applied to search results.
searchUsers_searchFilter :: Lens.Lens' SearchUsers (Prelude.Maybe UserSearchFilter)
searchUsers_searchFilter :: Lens' SearchUsers (Maybe UserSearchFilter)
searchUsers_searchFilter = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SearchUsers' {Maybe UserSearchFilter
searchFilter :: Maybe UserSearchFilter
$sel:searchFilter:SearchUsers' :: SearchUsers -> Maybe UserSearchFilter
searchFilter} -> Maybe UserSearchFilter
searchFilter) (\s :: SearchUsers
s@SearchUsers' {} Maybe UserSearchFilter
a -> SearchUsers
s {$sel:searchFilter:SearchUsers' :: Maybe UserSearchFilter
searchFilter = Maybe UserSearchFilter
a} :: SearchUsers)

instance Core.AWSPager SearchUsers where
  page :: SearchUsers -> AWSResponse SearchUsers -> Maybe SearchUsers
page SearchUsers
rq AWSResponse SearchUsers
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse SearchUsers
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' SearchUsersResponse (Maybe Text)
searchUsersResponse_nextToken
            forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
        forall a. Maybe a
Prelude.Nothing
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse SearchUsers
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' SearchUsersResponse (Maybe [UserSearchSummary])
searchUsersResponse_users
            forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
        forall a. Maybe a
Prelude.Nothing
    | Bool
Prelude.otherwise =
        forall a. a -> Maybe a
Prelude.Just
          forall a b. (a -> b) -> a -> b
Prelude.$ SearchUsers
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' SearchUsers (Maybe Text)
searchUsers_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse SearchUsers
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' SearchUsersResponse (Maybe Text)
searchUsersResponse_nextToken
          forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just

instance Core.AWSRequest SearchUsers where
  type AWSResponse SearchUsers = SearchUsersResponse
  request :: (Service -> Service) -> SearchUsers -> Request SearchUsers
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy SearchUsers
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse SearchUsers)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe Integer
-> Maybe Text
-> Maybe [UserSearchSummary]
-> Int
-> SearchUsersResponse
SearchUsersResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"ApproximateTotalCount")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"NextToken")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"Users" forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable SearchUsers where
  hashWithSalt :: Int -> SearchUsers -> Int
hashWithSalt Int
_salt SearchUsers' {Maybe Natural
Maybe Text
Maybe UserSearchCriteria
Maybe UserSearchFilter
searchFilter :: Maybe UserSearchFilter
searchCriteria :: Maybe UserSearchCriteria
nextToken :: Maybe Text
maxResults :: Maybe Natural
instanceId :: Maybe Text
$sel:searchFilter:SearchUsers' :: SearchUsers -> Maybe UserSearchFilter
$sel:searchCriteria:SearchUsers' :: SearchUsers -> Maybe UserSearchCriteria
$sel:nextToken:SearchUsers' :: SearchUsers -> Maybe Text
$sel:maxResults:SearchUsers' :: SearchUsers -> Maybe Natural
$sel:instanceId:SearchUsers' :: SearchUsers -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
instanceId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
maxResults
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
nextToken
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe UserSearchCriteria
searchCriteria
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe UserSearchFilter
searchFilter

instance Prelude.NFData SearchUsers where
  rnf :: SearchUsers -> ()
rnf SearchUsers' {Maybe Natural
Maybe Text
Maybe UserSearchCriteria
Maybe UserSearchFilter
searchFilter :: Maybe UserSearchFilter
searchCriteria :: Maybe UserSearchCriteria
nextToken :: Maybe Text
maxResults :: Maybe Natural
instanceId :: Maybe Text
$sel:searchFilter:SearchUsers' :: SearchUsers -> Maybe UserSearchFilter
$sel:searchCriteria:SearchUsers' :: SearchUsers -> Maybe UserSearchCriteria
$sel:nextToken:SearchUsers' :: SearchUsers -> Maybe Text
$sel:maxResults:SearchUsers' :: SearchUsers -> Maybe Natural
$sel:instanceId:SearchUsers' :: SearchUsers -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
instanceId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
maxResults
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe UserSearchCriteria
searchCriteria
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe UserSearchFilter
searchFilter

instance Data.ToHeaders SearchUsers where
  toHeaders :: SearchUsers -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON SearchUsers where
  toJSON :: SearchUsers -> Value
toJSON SearchUsers' {Maybe Natural
Maybe Text
Maybe UserSearchCriteria
Maybe UserSearchFilter
searchFilter :: Maybe UserSearchFilter
searchCriteria :: Maybe UserSearchCriteria
nextToken :: Maybe Text
maxResults :: Maybe Natural
instanceId :: Maybe Text
$sel:searchFilter:SearchUsers' :: SearchUsers -> Maybe UserSearchFilter
$sel:searchCriteria:SearchUsers' :: SearchUsers -> Maybe UserSearchCriteria
$sel:nextToken:SearchUsers' :: SearchUsers -> Maybe Text
$sel:maxResults:SearchUsers' :: SearchUsers -> Maybe Natural
$sel:instanceId:SearchUsers' :: SearchUsers -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"InstanceId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
instanceId,
            (Key
"MaxResults" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Natural
maxResults,
            (Key
"NextToken" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
nextToken,
            (Key
"SearchCriteria" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe UserSearchCriteria
searchCriteria,
            (Key
"SearchFilter" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe UserSearchFilter
searchFilter
          ]
      )

instance Data.ToPath SearchUsers where
  toPath :: SearchUsers -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/search-users"

instance Data.ToQuery SearchUsers where
  toQuery :: SearchUsers -> QueryString
toQuery = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

-- | /See:/ 'newSearchUsersResponse' smart constructor.
data SearchUsersResponse = SearchUsersResponse'
  { -- | The total number of users who matched your search query.
    SearchUsersResponse -> Maybe Integer
approximateTotalCount :: Prelude.Maybe Prelude.Integer,
    -- | If there are additional results, this is the token for the next set of
    -- results.
    SearchUsersResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | Information about the users.
    SearchUsersResponse -> Maybe [UserSearchSummary]
users :: Prelude.Maybe [UserSearchSummary],
    -- | The response's http status code.
    SearchUsersResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (SearchUsersResponse -> SearchUsersResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: SearchUsersResponse -> SearchUsersResponse -> Bool
$c/= :: SearchUsersResponse -> SearchUsersResponse -> Bool
== :: SearchUsersResponse -> SearchUsersResponse -> Bool
$c== :: SearchUsersResponse -> SearchUsersResponse -> Bool
Prelude.Eq, ReadPrec [SearchUsersResponse]
ReadPrec SearchUsersResponse
Int -> ReadS SearchUsersResponse
ReadS [SearchUsersResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [SearchUsersResponse]
$creadListPrec :: ReadPrec [SearchUsersResponse]
readPrec :: ReadPrec SearchUsersResponse
$creadPrec :: ReadPrec SearchUsersResponse
readList :: ReadS [SearchUsersResponse]
$creadList :: ReadS [SearchUsersResponse]
readsPrec :: Int -> ReadS SearchUsersResponse
$creadsPrec :: Int -> ReadS SearchUsersResponse
Prelude.Read, Int -> SearchUsersResponse -> ShowS
[SearchUsersResponse] -> ShowS
SearchUsersResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [SearchUsersResponse] -> ShowS
$cshowList :: [SearchUsersResponse] -> ShowS
show :: SearchUsersResponse -> String
$cshow :: SearchUsersResponse -> String
showsPrec :: Int -> SearchUsersResponse -> ShowS
$cshowsPrec :: Int -> SearchUsersResponse -> ShowS
Prelude.Show, forall x. Rep SearchUsersResponse x -> SearchUsersResponse
forall x. SearchUsersResponse -> Rep SearchUsersResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep SearchUsersResponse x -> SearchUsersResponse
$cfrom :: forall x. SearchUsersResponse -> Rep SearchUsersResponse x
Prelude.Generic)

-- |
-- Create a value of 'SearchUsersResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'approximateTotalCount', 'searchUsersResponse_approximateTotalCount' - The total number of users who matched your search query.
--
-- 'nextToken', 'searchUsersResponse_nextToken' - If there are additional results, this is the token for the next set of
-- results.
--
-- 'users', 'searchUsersResponse_users' - Information about the users.
--
-- 'httpStatus', 'searchUsersResponse_httpStatus' - The response's http status code.
newSearchUsersResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  SearchUsersResponse
newSearchUsersResponse :: Int -> SearchUsersResponse
newSearchUsersResponse Int
pHttpStatus_ =
  SearchUsersResponse'
    { $sel:approximateTotalCount:SearchUsersResponse' :: Maybe Integer
approximateTotalCount =
        forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:SearchUsersResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:users:SearchUsersResponse' :: Maybe [UserSearchSummary]
users = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:SearchUsersResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The total number of users who matched your search query.
searchUsersResponse_approximateTotalCount :: Lens.Lens' SearchUsersResponse (Prelude.Maybe Prelude.Integer)
searchUsersResponse_approximateTotalCount :: Lens' SearchUsersResponse (Maybe Integer)
searchUsersResponse_approximateTotalCount = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SearchUsersResponse' {Maybe Integer
approximateTotalCount :: Maybe Integer
$sel:approximateTotalCount:SearchUsersResponse' :: SearchUsersResponse -> Maybe Integer
approximateTotalCount} -> Maybe Integer
approximateTotalCount) (\s :: SearchUsersResponse
s@SearchUsersResponse' {} Maybe Integer
a -> SearchUsersResponse
s {$sel:approximateTotalCount:SearchUsersResponse' :: Maybe Integer
approximateTotalCount = Maybe Integer
a} :: SearchUsersResponse)

-- | If there are additional results, this is the token for the next set of
-- results.
searchUsersResponse_nextToken :: Lens.Lens' SearchUsersResponse (Prelude.Maybe Prelude.Text)
searchUsersResponse_nextToken :: Lens' SearchUsersResponse (Maybe Text)
searchUsersResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SearchUsersResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:SearchUsersResponse' :: SearchUsersResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: SearchUsersResponse
s@SearchUsersResponse' {} Maybe Text
a -> SearchUsersResponse
s {$sel:nextToken:SearchUsersResponse' :: Maybe Text
nextToken = Maybe Text
a} :: SearchUsersResponse)

-- | Information about the users.
searchUsersResponse_users :: Lens.Lens' SearchUsersResponse (Prelude.Maybe [UserSearchSummary])
searchUsersResponse_users :: Lens' SearchUsersResponse (Maybe [UserSearchSummary])
searchUsersResponse_users = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SearchUsersResponse' {Maybe [UserSearchSummary]
users :: Maybe [UserSearchSummary]
$sel:users:SearchUsersResponse' :: SearchUsersResponse -> Maybe [UserSearchSummary]
users} -> Maybe [UserSearchSummary]
users) (\s :: SearchUsersResponse
s@SearchUsersResponse' {} Maybe [UserSearchSummary]
a -> SearchUsersResponse
s {$sel:users:SearchUsersResponse' :: Maybe [UserSearchSummary]
users = Maybe [UserSearchSummary]
a} :: SearchUsersResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The response's http status code.
searchUsersResponse_httpStatus :: Lens.Lens' SearchUsersResponse Prelude.Int
searchUsersResponse_httpStatus :: Lens' SearchUsersResponse Int
searchUsersResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SearchUsersResponse' {Int
httpStatus :: Int
$sel:httpStatus:SearchUsersResponse' :: SearchUsersResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: SearchUsersResponse
s@SearchUsersResponse' {} Int
a -> SearchUsersResponse
s {$sel:httpStatus:SearchUsersResponse' :: Int
httpStatus = Int
a} :: SearchUsersResponse)

instance Prelude.NFData SearchUsersResponse where
  rnf :: SearchUsersResponse -> ()
rnf SearchUsersResponse' {Int
Maybe Integer
Maybe [UserSearchSummary]
Maybe Text
httpStatus :: Int
users :: Maybe [UserSearchSummary]
nextToken :: Maybe Text
approximateTotalCount :: Maybe Integer
$sel:httpStatus:SearchUsersResponse' :: SearchUsersResponse -> Int
$sel:users:SearchUsersResponse' :: SearchUsersResponse -> Maybe [UserSearchSummary]
$sel:nextToken:SearchUsersResponse' :: SearchUsersResponse -> Maybe Text
$sel:approximateTotalCount:SearchUsersResponse' :: SearchUsersResponse -> Maybe Integer
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Integer
approximateTotalCount
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [UserSearchSummary]
users
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus