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.UserGroupResolutionConfiguration

Description

Synopsis

Documentation

data UserGroupResolutionConfiguration Source #

Provides the configuration information to fetch access levels of groups and users from an IAM Identity Center (successor to Single Sign-On) identity source. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. You can also use the PutPrincipalMapping API to map users to their groups so that you only need to provide the user ID when you issue the query.

To set up an IAM Identity Center identity source in the console to use with Amazon Kendra, see Getting started with an IAM Identity Center identity source. You must also grant the required permissions to use IAM Identity Center with Amazon Kendra. For more information, see IAM roles for IAM Identity Center.

Amazon Kendra currently does not support using UserGroupResolutionConfiguration with an Amazon Web Services organization member account for your IAM Identity Center identify source. You must create your index in the management account for the organization in order to use UserGroupResolutionConfiguration.

See: newUserGroupResolutionConfiguration smart constructor.

Constructors

UserGroupResolutionConfiguration'
Fields userGroupResolutionMode :: UserGroupResolutionMode The identity store provider (mode) you want to use to fetch access levels of groups and users. IAM Identity Center (successor to Single Sign-On) is currently the only available mode. Your users and groups must exist in an IAM Identity Center identity source in order to use this mode.

Instances

Instances details

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

newUserGroupResolutionConfiguration Source #

Arguments

:: UserGroupResolutionMode	`$sel:userGroupResolutionMode:UserGroupResolutionConfiguration'`
-> UserGroupResolutionConfiguration

Create a value of UserGroupResolutionConfiguration 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:userGroupResolutionMode:UserGroupResolutionConfiguration', userGroupResolutionConfiguration_userGroupResolutionMode - The identity store provider (mode) you want to use to fetch access levels of groups and users. IAM Identity Center (successor to Single Sign-On) is currently the only available mode. Your users and groups must exist in an IAM Identity Center identity source in order to use this mode.

userGroupResolutionConfiguration_userGroupResolutionMode :: Lens' UserGroupResolutionConfiguration UserGroupResolutionMode Source #

The identity store provider (mode) you want to use to fetch access levels of groups and users. IAM Identity Center (successor to Single Sign-On) is currently the only available mode. Your users and groups must exist in an IAM Identity Center identity source in order to use this mode.