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.Kendra.Types.EntityConfiguration

Description

Synopsis

data EntityConfiguration = EntityConfiguration' {
- entityId :: Text
- entityType :: EntityType
}
newEntityConfiguration :: Text -> EntityType -> EntityConfiguration
entityConfiguration_entityId :: Lens' EntityConfiguration Text
entityConfiguration_entityType :: Lens' EntityConfiguration EntityType

Documentation

data EntityConfiguration Source #

Provides the configuration information for users or groups in your IAM Identity Center identity source to grant access your Amazon Kendra experience.

See: newEntityConfiguration smart constructor.

Constructors

EntityConfiguration'
Fields entityId :: Text The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an email. entityType :: EntityType Specifies whether you are configuring a `User` or a `Group`.

Instances

Instances details

ToJSON EntityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.EntityConfiguration Methods toJSON :: EntityConfiguration -> Value # toEncoding :: EntityConfiguration -> Encoding # toJSONList :: [EntityConfiguration] -> Value # toEncodingList :: [EntityConfiguration] -> Encoding #
Generic EntityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.EntityConfiguration Associated Types type Rep EntityConfiguration :: Type -> Type # Methods from :: EntityConfiguration -> Rep EntityConfiguration x # to :: Rep EntityConfiguration x -> EntityConfiguration #
Read EntityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.EntityConfiguration Methods readsPrec :: Int -> ReadS EntityConfiguration # readList :: ReadS [EntityConfiguration] # readPrec :: ReadPrec EntityConfiguration # readListPrec :: ReadPrec [EntityConfiguration] #
Show EntityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.EntityConfiguration Methods showsPrec :: Int -> EntityConfiguration -> ShowS # show :: EntityConfiguration -> String # showList :: [EntityConfiguration] -> ShowS #
NFData EntityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.EntityConfiguration Methods rnf :: EntityConfiguration -> () #
Eq EntityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.EntityConfiguration Methods (==) :: EntityConfiguration -> EntityConfiguration -> Bool # (/=) :: EntityConfiguration -> EntityConfiguration -> Bool #
Hashable EntityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.EntityConfiguration Methods hashWithSalt :: Int -> EntityConfiguration -> Int # hash :: EntityConfiguration -> Int #
type Rep EntityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.EntityConfiguration type Rep EntityConfiguration = D1 ('MetaData "EntityConfiguration" "Amazonka.Kendra.Types.EntityConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "EntityConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "entityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EntityType)))

newEntityConfiguration Source #

Arguments

:: Text	`$sel:entityId:EntityConfiguration'`
-> EntityType	`$sel:entityType:EntityConfiguration'`
-> EntityConfiguration

Create a value of EntityConfiguration 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:entityId:EntityConfiguration', entityConfiguration_entityId - The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an email.

$sel:entityType:EntityConfiguration', entityConfiguration_entityType - Specifies whether you are configuring a User or a Group.

entityConfiguration_entityId :: Lens' EntityConfiguration Text Source #

The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an email.

entityConfiguration_entityType :: Lens' EntityConfiguration EntityType Source #

Specifies whether you are configuring a User or a Group.