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

Description

Synopsis

data Principal = Principal' {
- dataSourceId :: Maybe Text
- name :: Text
- type' :: PrincipalType
- access :: ReadAccessType
}
newPrincipal :: Text -> PrincipalType -> ReadAccessType -> Principal
principal_dataSourceId :: Lens' Principal (Maybe Text)
principal_name :: Lens' Principal Text
principal_type :: Lens' Principal PrincipalType
principal_access :: Lens' Principal ReadAccessType

Documentation

data Principal Source #

Provides user and group information for user context filtering.

See: newPrincipal smart constructor.

Constructors

Principal'
Fields dataSourceId :: Maybe Text The identifier of the data source the principal should access documents from. name :: Text The name of the user or group. type' :: PrincipalType The type of principal. access :: ReadAccessType Whether to allow or deny document access to the principal.

Instances

Instances details

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

newPrincipal Source #

Arguments

:: Text	`$sel:name:Principal'`
-> PrincipalType	`$sel:type':Principal'`
-> ReadAccessType	`$sel:access:Principal'`
-> Principal

Create a value of Principal 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:dataSourceId:Principal', principal_dataSourceId - The identifier of the data source the principal should access documents from.

$sel:name:Principal', principal_name - The name of the user or group.

$sel:type':Principal', principal_type - The type of principal.

$sel:access:Principal', principal_access - Whether to allow or deny document access to the principal.

principal_dataSourceId :: Lens' Principal (Maybe Text) Source #

The identifier of the data source the principal should access documents from.

principal_name :: Lens' Principal Text Source #

The name of the user or group.

principal_type :: Lens' Principal PrincipalType Source #

The type of principal.

principal_access :: Lens' Principal ReadAccessType Source #

Whether to allow or deny document access to the principal.