{-# 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.Kendra.ListExperienceEntities
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Lists users or groups in your IAM Identity Center identity source that
-- are granted access to your Amazon Kendra experience. You can create an
-- Amazon Kendra experience such as a search application. For more
-- information on creating a search application experience, see
-- <https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html Building a search experience with no code>.
module Amazonka.Kendra.ListExperienceEntities
  ( -- * Creating a Request
    ListExperienceEntities (..),
    newListExperienceEntities,

    -- * Request Lenses
    listExperienceEntities_nextToken,
    listExperienceEntities_id,
    listExperienceEntities_indexId,

    -- * Destructuring the Response
    ListExperienceEntitiesResponse (..),
    newListExperienceEntitiesResponse,

    -- * Response Lenses
    listExperienceEntitiesResponse_nextToken,
    listExperienceEntitiesResponse_summaryItems,
    listExperienceEntitiesResponse_httpStatus,
  )
where

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

-- | /See:/ 'newListExperienceEntities' smart constructor.
data ListExperienceEntities = ListExperienceEntities'
  { -- | If the previous response was incomplete (because there is more data to
    -- retrieve), Amazon Kendra returns a pagination token in the response. You
    -- can use this pagination token to retrieve the next set of users or
    -- groups.
    ListExperienceEntities -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The identifier of your Amazon Kendra experience.
    ListExperienceEntities -> Text
id :: Prelude.Text,
    -- | The identifier of the index for your Amazon Kendra experience.
    ListExperienceEntities -> Text
indexId :: Prelude.Text
  }
  deriving (ListExperienceEntities -> ListExperienceEntities -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListExperienceEntities -> ListExperienceEntities -> Bool
$c/= :: ListExperienceEntities -> ListExperienceEntities -> Bool
== :: ListExperienceEntities -> ListExperienceEntities -> Bool
$c== :: ListExperienceEntities -> ListExperienceEntities -> Bool
Prelude.Eq, ReadPrec [ListExperienceEntities]
ReadPrec ListExperienceEntities
Int -> ReadS ListExperienceEntities
ReadS [ListExperienceEntities]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListExperienceEntities]
$creadListPrec :: ReadPrec [ListExperienceEntities]
readPrec :: ReadPrec ListExperienceEntities
$creadPrec :: ReadPrec ListExperienceEntities
readList :: ReadS [ListExperienceEntities]
$creadList :: ReadS [ListExperienceEntities]
readsPrec :: Int -> ReadS ListExperienceEntities
$creadsPrec :: Int -> ReadS ListExperienceEntities
Prelude.Read, Int -> ListExperienceEntities -> ShowS
[ListExperienceEntities] -> ShowS
ListExperienceEntities -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListExperienceEntities] -> ShowS
$cshowList :: [ListExperienceEntities] -> ShowS
show :: ListExperienceEntities -> String
$cshow :: ListExperienceEntities -> String
showsPrec :: Int -> ListExperienceEntities -> ShowS
$cshowsPrec :: Int -> ListExperienceEntities -> ShowS
Prelude.Show, forall x. Rep ListExperienceEntities x -> ListExperienceEntities
forall x. ListExperienceEntities -> Rep ListExperienceEntities x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListExperienceEntities x -> ListExperienceEntities
$cfrom :: forall x. ListExperienceEntities -> Rep ListExperienceEntities x
Prelude.Generic)

-- |
-- Create a value of 'ListExperienceEntities' 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', 'listExperienceEntities_nextToken' - If the previous response was incomplete (because there is more data to
-- retrieve), Amazon Kendra returns a pagination token in the response. You
-- can use this pagination token to retrieve the next set of users or
-- groups.
--
-- 'id', 'listExperienceEntities_id' - The identifier of your Amazon Kendra experience.
--
-- 'indexId', 'listExperienceEntities_indexId' - The identifier of the index for your Amazon Kendra experience.
newListExperienceEntities ::
  -- | 'id'
  Prelude.Text ->
  -- | 'indexId'
  Prelude.Text ->
  ListExperienceEntities
newListExperienceEntities :: Text -> Text -> ListExperienceEntities
newListExperienceEntities Text
pId_ Text
pIndexId_ =
  ListExperienceEntities'
    { $sel:nextToken:ListExperienceEntities' :: Maybe Text
nextToken =
        forall a. Maybe a
Prelude.Nothing,
      $sel:id:ListExperienceEntities' :: Text
id = Text
pId_,
      $sel:indexId:ListExperienceEntities' :: Text
indexId = Text
pIndexId_
    }

-- | If the previous response was incomplete (because there is more data to
-- retrieve), Amazon Kendra returns a pagination token in the response. You
-- can use this pagination token to retrieve the next set of users or
-- groups.
listExperienceEntities_nextToken :: Lens.Lens' ListExperienceEntities (Prelude.Maybe Prelude.Text)
listExperienceEntities_nextToken :: Lens' ListExperienceEntities (Maybe Text)
listExperienceEntities_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListExperienceEntities' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListExperienceEntities' :: ListExperienceEntities -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListExperienceEntities
s@ListExperienceEntities' {} Maybe Text
a -> ListExperienceEntities
s {$sel:nextToken:ListExperienceEntities' :: Maybe Text
nextToken = Maybe Text
a} :: ListExperienceEntities)

-- | The identifier of your Amazon Kendra experience.
listExperienceEntities_id :: Lens.Lens' ListExperienceEntities Prelude.Text
listExperienceEntities_id :: Lens' ListExperienceEntities Text
listExperienceEntities_id = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListExperienceEntities' {Text
id :: Text
$sel:id:ListExperienceEntities' :: ListExperienceEntities -> Text
id} -> Text
id) (\s :: ListExperienceEntities
s@ListExperienceEntities' {} Text
a -> ListExperienceEntities
s {$sel:id:ListExperienceEntities' :: Text
id = Text
a} :: ListExperienceEntities)

-- | The identifier of the index for your Amazon Kendra experience.
listExperienceEntities_indexId :: Lens.Lens' ListExperienceEntities Prelude.Text
listExperienceEntities_indexId :: Lens' ListExperienceEntities Text
listExperienceEntities_indexId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListExperienceEntities' {Text
indexId :: Text
$sel:indexId:ListExperienceEntities' :: ListExperienceEntities -> Text
indexId} -> Text
indexId) (\s :: ListExperienceEntities
s@ListExperienceEntities' {} Text
a -> ListExperienceEntities
s {$sel:indexId:ListExperienceEntities' :: Text
indexId = Text
a} :: ListExperienceEntities)

instance Core.AWSRequest ListExperienceEntities where
  type
    AWSResponse ListExperienceEntities =
      ListExperienceEntitiesResponse
  request :: (Service -> Service)
-> ListExperienceEntities -> Request ListExperienceEntities
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 ListExperienceEntities
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse ListExperienceEntities)))
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 [ExperienceEntitiesSummary]
-> Int
-> ListExperienceEntitiesResponse
ListExperienceEntitiesResponse'
            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
"SummaryItems" 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 ListExperienceEntities where
  hashWithSalt :: Int -> ListExperienceEntities -> Int
hashWithSalt Int
_salt ListExperienceEntities' {Maybe Text
Text
indexId :: Text
id :: Text
nextToken :: Maybe Text
$sel:indexId:ListExperienceEntities' :: ListExperienceEntities -> Text
$sel:id:ListExperienceEntities' :: ListExperienceEntities -> Text
$sel:nextToken:ListExperienceEntities' :: ListExperienceEntities -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
nextToken
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
id
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
indexId

instance Prelude.NFData ListExperienceEntities where
  rnf :: ListExperienceEntities -> ()
rnf ListExperienceEntities' {Maybe Text
Text
indexId :: Text
id :: Text
nextToken :: Maybe Text
$sel:indexId:ListExperienceEntities' :: ListExperienceEntities -> Text
$sel:id:ListExperienceEntities' :: ListExperienceEntities -> Text
$sel:nextToken:ListExperienceEntities' :: ListExperienceEntities -> 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 Text
id
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
indexId

instance Data.ToHeaders ListExperienceEntities where
  toHeaders :: ListExperienceEntities -> 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
"AWSKendraFrontendService.ListExperienceEntities" ::
                          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 ListExperienceEntities where
  toJSON :: ListExperienceEntities -> Value
toJSON ListExperienceEntities' {Maybe Text
Text
indexId :: Text
id :: Text
nextToken :: Maybe Text
$sel:indexId:ListExperienceEntities' :: ListExperienceEntities -> Text
$sel:id:ListExperienceEntities' :: ListExperienceEntities -> Text
$sel:nextToken:ListExperienceEntities' :: ListExperienceEntities -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (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
"Id" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
id),
            forall a. a -> Maybe a
Prelude.Just (Key
"IndexId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
indexId)
          ]
      )

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

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

-- | /See:/ 'newListExperienceEntitiesResponse' smart constructor.
data ListExperienceEntitiesResponse = ListExperienceEntitiesResponse'
  { -- | If the response is truncated, Amazon Kendra returns this token, which
    -- you can use in a later request to retrieve the next set of users or
    -- groups.
    ListExperienceEntitiesResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | An array of summary information for one or more users or groups.
    ListExperienceEntitiesResponse -> Maybe [ExperienceEntitiesSummary]
summaryItems :: Prelude.Maybe [ExperienceEntitiesSummary],
    -- | The response's http status code.
    ListExperienceEntitiesResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (ListExperienceEntitiesResponse
-> ListExperienceEntitiesResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListExperienceEntitiesResponse
-> ListExperienceEntitiesResponse -> Bool
$c/= :: ListExperienceEntitiesResponse
-> ListExperienceEntitiesResponse -> Bool
== :: ListExperienceEntitiesResponse
-> ListExperienceEntitiesResponse -> Bool
$c== :: ListExperienceEntitiesResponse
-> ListExperienceEntitiesResponse -> Bool
Prelude.Eq, Int -> ListExperienceEntitiesResponse -> ShowS
[ListExperienceEntitiesResponse] -> ShowS
ListExperienceEntitiesResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListExperienceEntitiesResponse] -> ShowS
$cshowList :: [ListExperienceEntitiesResponse] -> ShowS
show :: ListExperienceEntitiesResponse -> String
$cshow :: ListExperienceEntitiesResponse -> String
showsPrec :: Int -> ListExperienceEntitiesResponse -> ShowS
$cshowsPrec :: Int -> ListExperienceEntitiesResponse -> ShowS
Prelude.Show, forall x.
Rep ListExperienceEntitiesResponse x
-> ListExperienceEntitiesResponse
forall x.
ListExperienceEntitiesResponse
-> Rep ListExperienceEntitiesResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep ListExperienceEntitiesResponse x
-> ListExperienceEntitiesResponse
$cfrom :: forall x.
ListExperienceEntitiesResponse
-> Rep ListExperienceEntitiesResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListExperienceEntitiesResponse' 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', 'listExperienceEntitiesResponse_nextToken' - If the response is truncated, Amazon Kendra returns this token, which
-- you can use in a later request to retrieve the next set of users or
-- groups.
--
-- 'summaryItems', 'listExperienceEntitiesResponse_summaryItems' - An array of summary information for one or more users or groups.
--
-- 'httpStatus', 'listExperienceEntitiesResponse_httpStatus' - The response's http status code.
newListExperienceEntitiesResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListExperienceEntitiesResponse
newListExperienceEntitiesResponse :: Int -> ListExperienceEntitiesResponse
newListExperienceEntitiesResponse Int
pHttpStatus_ =
  ListExperienceEntitiesResponse'
    { $sel:nextToken:ListExperienceEntitiesResponse' :: Maybe Text
nextToken =
        forall a. Maybe a
Prelude.Nothing,
      $sel:summaryItems:ListExperienceEntitiesResponse' :: Maybe [ExperienceEntitiesSummary]
summaryItems = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListExperienceEntitiesResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | If the response is truncated, Amazon Kendra returns this token, which
-- you can use in a later request to retrieve the next set of users or
-- groups.
listExperienceEntitiesResponse_nextToken :: Lens.Lens' ListExperienceEntitiesResponse (Prelude.Maybe Prelude.Text)
listExperienceEntitiesResponse_nextToken :: Lens' ListExperienceEntitiesResponse (Maybe Text)
listExperienceEntitiesResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListExperienceEntitiesResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListExperienceEntitiesResponse' :: ListExperienceEntitiesResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListExperienceEntitiesResponse
s@ListExperienceEntitiesResponse' {} Maybe Text
a -> ListExperienceEntitiesResponse
s {$sel:nextToken:ListExperienceEntitiesResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListExperienceEntitiesResponse)

-- | An array of summary information for one or more users or groups.
listExperienceEntitiesResponse_summaryItems :: Lens.Lens' ListExperienceEntitiesResponse (Prelude.Maybe [ExperienceEntitiesSummary])
listExperienceEntitiesResponse_summaryItems :: Lens'
  ListExperienceEntitiesResponse (Maybe [ExperienceEntitiesSummary])
listExperienceEntitiesResponse_summaryItems = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListExperienceEntitiesResponse' {Maybe [ExperienceEntitiesSummary]
summaryItems :: Maybe [ExperienceEntitiesSummary]
$sel:summaryItems:ListExperienceEntitiesResponse' :: ListExperienceEntitiesResponse -> Maybe [ExperienceEntitiesSummary]
summaryItems} -> Maybe [ExperienceEntitiesSummary]
summaryItems) (\s :: ListExperienceEntitiesResponse
s@ListExperienceEntitiesResponse' {} Maybe [ExperienceEntitiesSummary]
a -> ListExperienceEntitiesResponse
s {$sel:summaryItems:ListExperienceEntitiesResponse' :: Maybe [ExperienceEntitiesSummary]
summaryItems = Maybe [ExperienceEntitiesSummary]
a} :: ListExperienceEntitiesResponse) 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.
listExperienceEntitiesResponse_httpStatus :: Lens.Lens' ListExperienceEntitiesResponse Prelude.Int
listExperienceEntitiesResponse_httpStatus :: Lens' ListExperienceEntitiesResponse Int
listExperienceEntitiesResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListExperienceEntitiesResponse' {Int
httpStatus :: Int
$sel:httpStatus:ListExperienceEntitiesResponse' :: ListExperienceEntitiesResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: ListExperienceEntitiesResponse
s@ListExperienceEntitiesResponse' {} Int
a -> ListExperienceEntitiesResponse
s {$sel:httpStatus:ListExperienceEntitiesResponse' :: Int
httpStatus = Int
a} :: ListExperienceEntitiesResponse)

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