{-# 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.AppStream.DescribeUsers
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Retrieves a list that describes one or more specified users in the user
-- pool.
--
-- This operation returns paginated results.
module Amazonka.AppStream.DescribeUsers
  ( -- * Creating a Request
    DescribeUsers (..),
    newDescribeUsers,

    -- * Request Lenses
    describeUsers_maxResults,
    describeUsers_nextToken,
    describeUsers_authenticationType,

    -- * Destructuring the Response
    DescribeUsersResponse (..),
    newDescribeUsersResponse,

    -- * Response Lenses
    describeUsersResponse_nextToken,
    describeUsersResponse_users,
    describeUsersResponse_httpStatus,
  )
where

import Amazonka.AppStream.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:/ 'newDescribeUsers' smart constructor.
data DescribeUsers = DescribeUsers'
  { -- | The maximum size of each page of results.
    DescribeUsers -> Maybe Int
maxResults :: Prelude.Maybe Prelude.Int,
    -- | The pagination token to use to retrieve the next page of results for
    -- this operation. If this value is null, it retrieves the first page.
    DescribeUsers -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The authentication type for the users in the user pool to describe. You
    -- must specify USERPOOL.
    DescribeUsers -> AuthenticationType
authenticationType :: AuthenticationType
  }
  deriving (DescribeUsers -> DescribeUsers -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeUsers -> DescribeUsers -> Bool
$c/= :: DescribeUsers -> DescribeUsers -> Bool
== :: DescribeUsers -> DescribeUsers -> Bool
$c== :: DescribeUsers -> DescribeUsers -> Bool
Prelude.Eq, ReadPrec [DescribeUsers]
ReadPrec DescribeUsers
Int -> ReadS DescribeUsers
ReadS [DescribeUsers]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeUsers]
$creadListPrec :: ReadPrec [DescribeUsers]
readPrec :: ReadPrec DescribeUsers
$creadPrec :: ReadPrec DescribeUsers
readList :: ReadS [DescribeUsers]
$creadList :: ReadS [DescribeUsers]
readsPrec :: Int -> ReadS DescribeUsers
$creadsPrec :: Int -> ReadS DescribeUsers
Prelude.Read, Int -> DescribeUsers -> ShowS
[DescribeUsers] -> ShowS
DescribeUsers -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeUsers] -> ShowS
$cshowList :: [DescribeUsers] -> ShowS
show :: DescribeUsers -> String
$cshow :: DescribeUsers -> String
showsPrec :: Int -> DescribeUsers -> ShowS
$cshowsPrec :: Int -> DescribeUsers -> ShowS
Prelude.Show, forall x. Rep DescribeUsers x -> DescribeUsers
forall x. DescribeUsers -> Rep DescribeUsers x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeUsers x -> DescribeUsers
$cfrom :: forall x. DescribeUsers -> Rep DescribeUsers x
Prelude.Generic)

-- |
-- Create a value of 'DescribeUsers' 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:
--
-- 'maxResults', 'describeUsers_maxResults' - The maximum size of each page of results.
--
-- 'nextToken', 'describeUsers_nextToken' - The pagination token to use to retrieve the next page of results for
-- this operation. If this value is null, it retrieves the first page.
--
-- 'authenticationType', 'describeUsers_authenticationType' - The authentication type for the users in the user pool to describe. You
-- must specify USERPOOL.
newDescribeUsers ::
  -- | 'authenticationType'
  AuthenticationType ->
  DescribeUsers
newDescribeUsers :: AuthenticationType -> DescribeUsers
newDescribeUsers AuthenticationType
pAuthenticationType_ =
  DescribeUsers'
    { $sel:maxResults:DescribeUsers' :: Maybe Int
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:DescribeUsers' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:authenticationType:DescribeUsers' :: AuthenticationType
authenticationType = AuthenticationType
pAuthenticationType_
    }

-- | The maximum size of each page of results.
describeUsers_maxResults :: Lens.Lens' DescribeUsers (Prelude.Maybe Prelude.Int)
describeUsers_maxResults :: Lens' DescribeUsers (Maybe Int)
describeUsers_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeUsers' {Maybe Int
maxResults :: Maybe Int
$sel:maxResults:DescribeUsers' :: DescribeUsers -> Maybe Int
maxResults} -> Maybe Int
maxResults) (\s :: DescribeUsers
s@DescribeUsers' {} Maybe Int
a -> DescribeUsers
s {$sel:maxResults:DescribeUsers' :: Maybe Int
maxResults = Maybe Int
a} :: DescribeUsers)

-- | The pagination token to use to retrieve the next page of results for
-- this operation. If this value is null, it retrieves the first page.
describeUsers_nextToken :: Lens.Lens' DescribeUsers (Prelude.Maybe Prelude.Text)
describeUsers_nextToken :: Lens' DescribeUsers (Maybe Text)
describeUsers_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeUsers' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:DescribeUsers' :: DescribeUsers -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: DescribeUsers
s@DescribeUsers' {} Maybe Text
a -> DescribeUsers
s {$sel:nextToken:DescribeUsers' :: Maybe Text
nextToken = Maybe Text
a} :: DescribeUsers)

-- | The authentication type for the users in the user pool to describe. You
-- must specify USERPOOL.
describeUsers_authenticationType :: Lens.Lens' DescribeUsers AuthenticationType
describeUsers_authenticationType :: Lens' DescribeUsers AuthenticationType
describeUsers_authenticationType = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeUsers' {AuthenticationType
authenticationType :: AuthenticationType
$sel:authenticationType:DescribeUsers' :: DescribeUsers -> AuthenticationType
authenticationType} -> AuthenticationType
authenticationType) (\s :: DescribeUsers
s@DescribeUsers' {} AuthenticationType
a -> DescribeUsers
s {$sel:authenticationType:DescribeUsers' :: AuthenticationType
authenticationType = AuthenticationType
a} :: DescribeUsers)

instance Core.AWSPager DescribeUsers where
  page :: DescribeUsers -> AWSResponse DescribeUsers -> Maybe DescribeUsers
page DescribeUsers
rq AWSResponse DescribeUsers
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse DescribeUsers
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' DescribeUsersResponse (Maybe Text)
describeUsersResponse_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 DescribeUsers
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' DescribeUsersResponse (Maybe [User])
describeUsersResponse_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.$ DescribeUsers
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' DescribeUsers (Maybe Text)
describeUsers_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse DescribeUsers
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' DescribeUsersResponse (Maybe Text)
describeUsersResponse_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 DescribeUsers where
  type
    AWSResponse DescribeUsers =
      DescribeUsersResponse
  request :: (Service -> Service) -> DescribeUsers -> Request DescribeUsers
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 DescribeUsers
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DescribeUsers)))
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 Text -> Maybe [User] -> Int -> DescribeUsersResponse
DescribeUsersResponse'
            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
"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 DescribeUsers where
  hashWithSalt :: Int -> DescribeUsers -> Int
hashWithSalt Int
_salt DescribeUsers' {Maybe Int
Maybe Text
AuthenticationType
authenticationType :: AuthenticationType
nextToken :: Maybe Text
maxResults :: Maybe Int
$sel:authenticationType:DescribeUsers' :: DescribeUsers -> AuthenticationType
$sel:nextToken:DescribeUsers' :: DescribeUsers -> Maybe Text
$sel:maxResults:DescribeUsers' :: DescribeUsers -> Maybe Int
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
maxResults
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
nextToken
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` AuthenticationType
authenticationType

instance Prelude.NFData DescribeUsers where
  rnf :: DescribeUsers -> ()
rnf DescribeUsers' {Maybe Int
Maybe Text
AuthenticationType
authenticationType :: AuthenticationType
nextToken :: Maybe Text
maxResults :: Maybe Int
$sel:authenticationType:DescribeUsers' :: DescribeUsers -> AuthenticationType
$sel:nextToken:DescribeUsers' :: DescribeUsers -> Maybe Text
$sel:maxResults:DescribeUsers' :: DescribeUsers -> Maybe Int
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
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 AuthenticationType
authenticationType

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

instance Data.ToJSON DescribeUsers where
  toJSON :: DescribeUsers -> Value
toJSON DescribeUsers' {Maybe Int
Maybe Text
AuthenticationType
authenticationType :: AuthenticationType
nextToken :: Maybe Text
maxResults :: Maybe Int
$sel:authenticationType:DescribeUsers' :: DescribeUsers -> AuthenticationType
$sel:nextToken:DescribeUsers' :: DescribeUsers -> Maybe Text
$sel:maxResults:DescribeUsers' :: DescribeUsers -> Maybe Int
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (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 Int
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,
            forall a. a -> Maybe a
Prelude.Just
              (Key
"AuthenticationType" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= AuthenticationType
authenticationType)
          ]
      )

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

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

-- | /See:/ 'newDescribeUsersResponse' smart constructor.
data DescribeUsersResponse = DescribeUsersResponse'
  { -- | The pagination token to use to retrieve the next page of results for
    -- this operation. If there are no more pages, this value is null.
    DescribeUsersResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | Information about users in the user pool.
    DescribeUsersResponse -> Maybe [User]
users :: Prelude.Maybe [User],
    -- | The response's http status code.
    DescribeUsersResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DescribeUsersResponse -> DescribeUsersResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeUsersResponse -> DescribeUsersResponse -> Bool
$c/= :: DescribeUsersResponse -> DescribeUsersResponse -> Bool
== :: DescribeUsersResponse -> DescribeUsersResponse -> Bool
$c== :: DescribeUsersResponse -> DescribeUsersResponse -> Bool
Prelude.Eq, Int -> DescribeUsersResponse -> ShowS
[DescribeUsersResponse] -> ShowS
DescribeUsersResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeUsersResponse] -> ShowS
$cshowList :: [DescribeUsersResponse] -> ShowS
show :: DescribeUsersResponse -> String
$cshow :: DescribeUsersResponse -> String
showsPrec :: Int -> DescribeUsersResponse -> ShowS
$cshowsPrec :: Int -> DescribeUsersResponse -> ShowS
Prelude.Show, forall x. Rep DescribeUsersResponse x -> DescribeUsersResponse
forall x. DescribeUsersResponse -> Rep DescribeUsersResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeUsersResponse x -> DescribeUsersResponse
$cfrom :: forall x. DescribeUsersResponse -> Rep DescribeUsersResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeUsersResponse' 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:
--
-- 'nextToken', 'describeUsersResponse_nextToken' - The pagination token to use to retrieve the next page of results for
-- this operation. If there are no more pages, this value is null.
--
-- 'users', 'describeUsersResponse_users' - Information about users in the user pool.
--
-- 'httpStatus', 'describeUsersResponse_httpStatus' - The response's http status code.
newDescribeUsersResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribeUsersResponse
newDescribeUsersResponse :: Int -> DescribeUsersResponse
newDescribeUsersResponse Int
pHttpStatus_ =
  DescribeUsersResponse'
    { $sel:nextToken:DescribeUsersResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:users:DescribeUsersResponse' :: Maybe [User]
users = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DescribeUsersResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The pagination token to use to retrieve the next page of results for
-- this operation. If there are no more pages, this value is null.
describeUsersResponse_nextToken :: Lens.Lens' DescribeUsersResponse (Prelude.Maybe Prelude.Text)
describeUsersResponse_nextToken :: Lens' DescribeUsersResponse (Maybe Text)
describeUsersResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeUsersResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:DescribeUsersResponse' :: DescribeUsersResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: DescribeUsersResponse
s@DescribeUsersResponse' {} Maybe Text
a -> DescribeUsersResponse
s {$sel:nextToken:DescribeUsersResponse' :: Maybe Text
nextToken = Maybe Text
a} :: DescribeUsersResponse)

-- | Information about users in the user pool.
describeUsersResponse_users :: Lens.Lens' DescribeUsersResponse (Prelude.Maybe [User])
describeUsersResponse_users :: Lens' DescribeUsersResponse (Maybe [User])
describeUsersResponse_users = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeUsersResponse' {Maybe [User]
users :: Maybe [User]
$sel:users:DescribeUsersResponse' :: DescribeUsersResponse -> Maybe [User]
users} -> Maybe [User]
users) (\s :: DescribeUsersResponse
s@DescribeUsersResponse' {} Maybe [User]
a -> DescribeUsersResponse
s {$sel:users:DescribeUsersResponse' :: Maybe [User]
users = Maybe [User]
a} :: DescribeUsersResponse) 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.
describeUsersResponse_httpStatus :: Lens.Lens' DescribeUsersResponse Prelude.Int
describeUsersResponse_httpStatus :: Lens' DescribeUsersResponse Int
describeUsersResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeUsersResponse' {Int
httpStatus :: Int
$sel:httpStatus:DescribeUsersResponse' :: DescribeUsersResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: DescribeUsersResponse
s@DescribeUsersResponse' {} Int
a -> DescribeUsersResponse
s {$sel:httpStatus:DescribeUsersResponse' :: Int
httpStatus = Int
a} :: DescribeUsersResponse)

instance Prelude.NFData DescribeUsersResponse where
  rnf :: DescribeUsersResponse -> ()
rnf DescribeUsersResponse' {Int
Maybe [User]
Maybe Text
httpStatus :: Int
users :: Maybe [User]
nextToken :: Maybe Text
$sel:httpStatus:DescribeUsersResponse' :: DescribeUsersResponse -> Int
$sel:users:DescribeUsersResponse' :: DescribeUsersResponse -> Maybe [User]
$sel:nextToken:DescribeUsersResponse' :: DescribeUsersResponse -> Maybe Text
..} =
    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 [User]
users
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus