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

Description

Synopsis

data AclConfiguration = AclConfiguration' {
- allowedGroupsColumnName :: Text
}
newAclConfiguration :: Text -> AclConfiguration
aclConfiguration_allowedGroupsColumnName :: Lens' AclConfiguration Text

Documentation

data AclConfiguration Source #

Provides information about the column that should be used for filtering the query response by groups.

See: newAclConfiguration smart constructor.

Constructors

AclConfiguration'
Fields allowedGroupsColumnName :: Text A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the `UserContext` field of the `Query` API.

Instances

Instances details

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

newAclConfiguration Source #

Arguments

:: Text	`$sel:allowedGroupsColumnName:AclConfiguration'`
-> AclConfiguration

Create a value of AclConfiguration 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:allowedGroupsColumnName:AclConfiguration', aclConfiguration_allowedGroupsColumnName - A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the UserContext field of the Query API.

aclConfiguration_allowedGroupsColumnName :: Lens' AclConfiguration Text Source #

A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the UserContext field of the Query API.