GroupMembers - Amazon Kendra

GroupMembers

A list of users or sub groups that belong to a group. Users and groups are useful for filtering search results to different users based on their group's access to documents.

Contents

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

Type: Array of MemberGroup objects

Array Members: Minimum number of 1 item. Maximum number of 1000 items.

Required: No

MemberUsers

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

Type: Array of MemberUser objects

Array Members: Minimum number of 1 item. Maximum number of 1000 items.

Required: No

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.

Type: S3Path object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: