{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# 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.Types.ExperienceEntitiesSummary
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.Kendra.Types.ExperienceEntitiesSummary 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.EntityDisplayData
import Amazonka.Kendra.Types.EntityType
import qualified Amazonka.Prelude as Prelude

-- | Summary information for users or groups in your IAM Identity Center
-- identity source with 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>.
--
-- /See:/ 'newExperienceEntitiesSummary' smart constructor.
data ExperienceEntitiesSummary = ExperienceEntitiesSummary'
  { -- | Information about the user entity.
    ExperienceEntitiesSummary -> Maybe EntityDisplayData
displayData :: Prelude.Maybe EntityDisplayData,
    -- | The identifier of a user or group in your IAM Identity Center identity
    -- source. For example, a user ID could be an email.
    ExperienceEntitiesSummary -> Maybe Text
entityId :: Prelude.Maybe Prelude.Text,
    -- | Shows the type as @User@ or @Group@.
    ExperienceEntitiesSummary -> Maybe EntityType
entityType :: Prelude.Maybe EntityType
  }
  deriving (ExperienceEntitiesSummary -> ExperienceEntitiesSummary -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ExperienceEntitiesSummary -> ExperienceEntitiesSummary -> Bool
$c/= :: ExperienceEntitiesSummary -> ExperienceEntitiesSummary -> Bool
== :: ExperienceEntitiesSummary -> ExperienceEntitiesSummary -> Bool
$c== :: ExperienceEntitiesSummary -> ExperienceEntitiesSummary -> Bool
Prelude.Eq, Int -> ExperienceEntitiesSummary -> ShowS
[ExperienceEntitiesSummary] -> ShowS
ExperienceEntitiesSummary -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ExperienceEntitiesSummary] -> ShowS
$cshowList :: [ExperienceEntitiesSummary] -> ShowS
show :: ExperienceEntitiesSummary -> String
$cshow :: ExperienceEntitiesSummary -> String
showsPrec :: Int -> ExperienceEntitiesSummary -> ShowS
$cshowsPrec :: Int -> ExperienceEntitiesSummary -> ShowS
Prelude.Show, forall x.
Rep ExperienceEntitiesSummary x -> ExperienceEntitiesSummary
forall x.
ExperienceEntitiesSummary -> Rep ExperienceEntitiesSummary x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep ExperienceEntitiesSummary x -> ExperienceEntitiesSummary
$cfrom :: forall x.
ExperienceEntitiesSummary -> Rep ExperienceEntitiesSummary x
Prelude.Generic)

-- |
-- Create a value of 'ExperienceEntitiesSummary' 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:
--
-- 'displayData', 'experienceEntitiesSummary_displayData' - Information about the user entity.
--
-- 'entityId', 'experienceEntitiesSummary_entityId' - The identifier of a user or group in your IAM Identity Center identity
-- source. For example, a user ID could be an email.
--
-- 'entityType', 'experienceEntitiesSummary_entityType' - Shows the type as @User@ or @Group@.
newExperienceEntitiesSummary ::
  ExperienceEntitiesSummary
newExperienceEntitiesSummary :: ExperienceEntitiesSummary
newExperienceEntitiesSummary =
  ExperienceEntitiesSummary'
    { $sel:displayData:ExperienceEntitiesSummary' :: Maybe EntityDisplayData
displayData =
        forall a. Maybe a
Prelude.Nothing,
      $sel:entityId:ExperienceEntitiesSummary' :: Maybe Text
entityId = forall a. Maybe a
Prelude.Nothing,
      $sel:entityType:ExperienceEntitiesSummary' :: Maybe EntityType
entityType = forall a. Maybe a
Prelude.Nothing
    }

-- | Information about the user entity.
experienceEntitiesSummary_displayData :: Lens.Lens' ExperienceEntitiesSummary (Prelude.Maybe EntityDisplayData)
experienceEntitiesSummary_displayData :: Lens' ExperienceEntitiesSummary (Maybe EntityDisplayData)
experienceEntitiesSummary_displayData = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ExperienceEntitiesSummary' {Maybe EntityDisplayData
displayData :: Maybe EntityDisplayData
$sel:displayData:ExperienceEntitiesSummary' :: ExperienceEntitiesSummary -> Maybe EntityDisplayData
displayData} -> Maybe EntityDisplayData
displayData) (\s :: ExperienceEntitiesSummary
s@ExperienceEntitiesSummary' {} Maybe EntityDisplayData
a -> ExperienceEntitiesSummary
s {$sel:displayData:ExperienceEntitiesSummary' :: Maybe EntityDisplayData
displayData = Maybe EntityDisplayData
a} :: ExperienceEntitiesSummary)

-- | The identifier of a user or group in your IAM Identity Center identity
-- source. For example, a user ID could be an email.
experienceEntitiesSummary_entityId :: Lens.Lens' ExperienceEntitiesSummary (Prelude.Maybe Prelude.Text)
experienceEntitiesSummary_entityId :: Lens' ExperienceEntitiesSummary (Maybe Text)
experienceEntitiesSummary_entityId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ExperienceEntitiesSummary' {Maybe Text
entityId :: Maybe Text
$sel:entityId:ExperienceEntitiesSummary' :: ExperienceEntitiesSummary -> Maybe Text
entityId} -> Maybe Text
entityId) (\s :: ExperienceEntitiesSummary
s@ExperienceEntitiesSummary' {} Maybe Text
a -> ExperienceEntitiesSummary
s {$sel:entityId:ExperienceEntitiesSummary' :: Maybe Text
entityId = Maybe Text
a} :: ExperienceEntitiesSummary)

-- | Shows the type as @User@ or @Group@.
experienceEntitiesSummary_entityType :: Lens.Lens' ExperienceEntitiesSummary (Prelude.Maybe EntityType)
experienceEntitiesSummary_entityType :: Lens' ExperienceEntitiesSummary (Maybe EntityType)
experienceEntitiesSummary_entityType = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ExperienceEntitiesSummary' {Maybe EntityType
entityType :: Maybe EntityType
$sel:entityType:ExperienceEntitiesSummary' :: ExperienceEntitiesSummary -> Maybe EntityType
entityType} -> Maybe EntityType
entityType) (\s :: ExperienceEntitiesSummary
s@ExperienceEntitiesSummary' {} Maybe EntityType
a -> ExperienceEntitiesSummary
s {$sel:entityType:ExperienceEntitiesSummary' :: Maybe EntityType
entityType = Maybe EntityType
a} :: ExperienceEntitiesSummary)

instance Data.FromJSON ExperienceEntitiesSummary where
  parseJSON :: Value -> Parser ExperienceEntitiesSummary
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"ExperienceEntitiesSummary"
      ( \Object
x ->
          Maybe EntityDisplayData
-> Maybe Text -> Maybe EntityType -> ExperienceEntitiesSummary
ExperienceEntitiesSummary'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"DisplayData")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"EntityId")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"EntityType")
      )

instance Prelude.Hashable ExperienceEntitiesSummary where
  hashWithSalt :: Int -> ExperienceEntitiesSummary -> Int
hashWithSalt Int
_salt ExperienceEntitiesSummary' {Maybe Text
Maybe EntityDisplayData
Maybe EntityType
entityType :: Maybe EntityType
entityId :: Maybe Text
displayData :: Maybe EntityDisplayData
$sel:entityType:ExperienceEntitiesSummary' :: ExperienceEntitiesSummary -> Maybe EntityType
$sel:entityId:ExperienceEntitiesSummary' :: ExperienceEntitiesSummary -> Maybe Text
$sel:displayData:ExperienceEntitiesSummary' :: ExperienceEntitiesSummary -> Maybe EntityDisplayData
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe EntityDisplayData
displayData
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
entityId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe EntityType
entityType

instance Prelude.NFData ExperienceEntitiesSummary where
  rnf :: ExperienceEntitiesSummary -> ()
rnf ExperienceEntitiesSummary' {Maybe Text
Maybe EntityDisplayData
Maybe EntityType
entityType :: Maybe EntityType
entityId :: Maybe Text
displayData :: Maybe EntityDisplayData
$sel:entityType:ExperienceEntitiesSummary' :: ExperienceEntitiesSummary -> Maybe EntityType
$sel:entityId:ExperienceEntitiesSummary' :: ExperienceEntitiesSummary -> Maybe Text
$sel:displayData:ExperienceEntitiesSummary' :: ExperienceEntitiesSummary -> Maybe EntityDisplayData
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe EntityDisplayData
displayData
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
entityId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe EntityType
entityType