Skip to content

put_group

Operation

put_group

put_group(request: PutGroupInput | PutGroupInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutGroupInputDict]) -> PutGroupOutput

Create, or updates, a mapping of users---who have access to a document---to groups.

You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their Amazon Q Business chat results.

There are two options for creating groups, either passing group members inline or using an S3 file via the S3PathForGroupMembers field. For inline groups, there is a limit of 1000 members per group and for provided S3 files there is a limit of 100 thousand members. When creating a group using an S3 file, you provide both an S3 file and a RoleArn for Amazon Q Buisness to access the file.

Parameters:

Name Type Description Default
request PutGroupInput | PutGroupInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[PutGroupInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
PutGroupOutput

An instance of PutGroupOutput.

put_group async

put_group(request: PutGroupInput | PutGroupInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutGroupInputDict]) -> PutGroupOutput

Create, or updates, a mapping of users---who have access to a document---to groups.

You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their Amazon Q Business chat results.

There are two options for creating groups, either passing group members inline or using an S3 file via the S3PathForGroupMembers field. For inline groups, there is a limit of 1000 members per group and for provided S3 files there is a limit of 100 thousand members. When creating a group using an S3 file, you provide both an S3 file and a RoleArn for Amazon Q Buisness to access the file.

Parameters:

Name Type Description Default
request PutGroupInput | PutGroupInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[PutGroupInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
PutGroupOutput

An instance of PutGroupOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

PutGroupInputDict

Bases: TypedDict

Dictionary form of PutGroupInput.

Attributes

application_id instance-attribute
application_id: Required[str]

The identifier of the application in which the user and group mapping belongs.

data_source_id instance-attribute
data_source_id: str | None

The identifier of the data source for which you want to map users to their groups. This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. However, "Sales and Marketing" team only needs access to customer-related documents stored in Salesforce.

group_members instance-attribute

A list of users or sub groups that belong to a group. This is for generating Amazon Q Business chat results only from document a user has access to.

group_name instance-attribute
group_name: Required[str]

The list that contains your users or sub groups that belong the same group. For example, the group "Company" includes the user "CEO" and the sub groups "Research", "Engineering", and "Sales and Marketing".

index_id instance-attribute
index_id: Required[str]

The identifier of the index in which you want to map users to their groups.

role_arn instance-attribute
role_arn: str | None

The Amazon Resource Name (ARN) of an IAM role that has access to the S3 file that contains your list of users that belong to a group.

type instance-attribute
type: Required[str]

The type of the group.

PutGroupInput dataclass

Bases: _SerdeShape

Dataclass for PutGroupInput structure.

Attributes

application_id class-attribute instance-attribute
application_id: str | None = ...

The identifier of the application in which the user and group mapping belongs.

data_source_id class-attribute instance-attribute
data_source_id: str | None = ...

The identifier of the data source for which you want to map users to their groups. This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. However, "Sales and Marketing" team only needs access to customer-related documents stored in Salesforce.

group_members class-attribute instance-attribute
group_members: GroupMembers | None = ...

A list of users or sub groups that belong to a group. This is for generating Amazon Q Business chat results only from document a user has access to.

group_name class-attribute instance-attribute
group_name: str | None = ...

The list that contains your users or sub groups that belong the same group. For example, the group "Company" includes the user "CEO" and the sub groups "Research", "Engineering", and "Sales and Marketing".

index_id class-attribute instance-attribute
index_id: str | None = ...

The identifier of the index in which you want to map users to their groups.

role_arn class-attribute instance-attribute
role_arn: str | None = ...

The Amazon Resource Name (ARN) of an IAM role that has access to the S3 file that contains your list of users that belong to a group.

type class-attribute instance-attribute
type: str | None = ...

The type of the group.

Output

PutGroupOutput dataclass

Bases: _SerdeShape

Dataclass for PutGroupOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.