Class: Aws::Kendra::Types::GroupMembers
- Inherits:
-
Struct
- Object
- Struct
- Aws::Kendra::Types::GroupMembers
- Defined in:
- gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb
Overview
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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#member_groups ⇒ Array<Types::MemberGroup>
A list of sub groups that belong to a group.
-
#member_users ⇒ Array<Types::MemberUser>
A list of users that belong to a group.
-
#s3_pathfor_group_members ⇒ Types::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.
Instance Attribute Details
#member_groups ⇒ Array<Types::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".
6302 6303 6304 6305 6306 6307 6308 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6302 class GroupMembers < Struct.new( :member_groups, :member_users, :s3_pathfor_group_members) SENSITIVE = [] include Aws::Structure end |
#member_users ⇒ Array<Types::MemberUser>
A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.
6302 6303 6304 6305 6306 6307 6308 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6302 class GroupMembers < Struct.new( :member_groups, :member_users, :s3_pathfor_group_members) SENSITIVE = [] include Aws::Structure end |
#s3_pathfor_group_members ⇒ Types::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
.
6302 6303 6304 6305 6306 6307 6308 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6302 class GroupMembers < Struct.new( :member_groups, :member_users, :s3_pathfor_group_members) SENSITIVE = [] include Aws::Structure end |