Skip to content

GroupMembers

Used by
Source code in docs_src/capo_kendra/types/group_members.py 
13
14
15
16
17
18
19
class GroupMembers(TypedDict, closed=True):
    member_groups: NotRequired["capo_kendra.types.member_groups.MemberGroups"]
    """<p>A list of users that belong to a group. This can also include sub groups. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company A".</p>"""
    member_users: NotRequired["capo_kendra.types.member_users.MemberUsers"]
    """<p>A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.</p>"""
    s3_pathfor_group_members: NotRequired["capo_kendra.types.s3_path.S3Path"]
    """<p>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.</p> <p>You can download this <a href="https://docs.aws.amazon.com/kendra/latest/dg/samples/group_members.zip">example S3 file</a> that uses the correct format for listing group members. Note, <code>dataSourceId</code> is optional. The value of <code>type</code> for a group is always <code>GROUP</code> and for a user it is always <code>USER</code>.</p>"""

member_groups instance-attribute 

member_groups: NotRequired[MemberGroups]

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

member_users instance-attribute 

member_users: NotRequired[MemberUsers]

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

s3_pathfor_group_members instance-attribute 

s3_pathfor_group_members: NotRequired[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.