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

Description

Documentation

data GroupMembers Source #

A list of users or sub groups that belong to a group. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

See: newGroupMembers smart constructor.

Constructors

GroupMembers'

Fields

memberGroups :: Maybe (NonEmpty MemberGroup)
A list of sub groups that belong to a group. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company".
memberUsers :: Maybe (NonEmpty MemberUser)
A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.
s3PathforGroupMembers :: Maybe S3Path
If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.
You can download this example S3 file that uses the correct format for listing group members. Note, dataSourceId is optional. The value of type for a group is always GROUP and for a user it is always USER.

Instances

Instances details

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

newGroupMembers :: GroupMembers Source #

Create a value of GroupMembers 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:memberGroups:GroupMembers', groupMembers_memberGroups - A list of sub groups that belong to a group. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company".

$sel:memberUsers:GroupMembers', groupMembers_memberUsers - A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.

$sel:s3PathforGroupMembers:GroupMembers', groupMembers_s3PathforGroupMembers - If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.

You can download this example S3 file that uses the correct format for listing group members. Note, dataSourceId is optional. The value of type for a group is always GROUP and for a user it is always USER.

groupMembers_memberGroups :: Lens' GroupMembers (Maybe (NonEmpty MemberGroup)) Source #

A list of sub groups that belong to a group. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company".

groupMembers_memberUsers :: Lens' GroupMembers (Maybe (NonEmpty MemberUser)) Source #

A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.

groupMembers_s3PathforGroupMembers :: Lens' GroupMembers (Maybe S3Path) Source #

If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.

You can download this example S3 file that uses the correct format for listing group members. Note, dataSourceId is optional. The value of type for a group is always GROUP and for a user it is always USER.