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
When making an API call, you may pass GroupMembers data as a hash:
{
member_groups: [
{
group_id: "GroupId", # required
data_source_id: "DataSourceId",
},
],
member_users: [
{
user_id: "UserId", # required
},
],
s3_pathfor_group_members: {
bucket: "S3BucketName", # required
key: "S3ObjectKey", # required
},
}
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.
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".
6990 6991 6992 6993 6994 6995 6996 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6990 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.
6990 6991 6992 6993 6994 6995 6996 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6990 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
.
6990 6991 6992 6993 6994 6995 6996 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6990 class GroupMembers < Struct.new( :member_groups, :member_users, :s3_pathfor_group_members) SENSITIVE = [] include Aws::Structure end |