Qbusiness  >  Operations  >  list_groups

list_groups

Operation

list_groups async

list_groups(input: ListGroupsInput, plugins: list[Plugin] | None = None) -> ListGroupsOutput

Provides a list of groups that are mapped to users.

Parameters:

Name	Type	Description	Default
input	ListGroupsInput	An instance of ListGroupsInput.	required
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

Returns:

Type	Description
ListGroupsOutput	An instance of ListGroupsOutput.

Input

ListGroupsInput dataclass

Dataclass for ListGroupsInput structure.

Attributes

application_id class-attribute instance-attribute

application_id: str | None = None

The identifier of the application for getting a list of groups mapped to users.

data_source_id class-attribute instance-attribute

data_source_id: str | None = None

The identifier of the data source for getting a list of groups mapped to users.

index_id class-attribute instance-attribute

index_id: str | None = None

The identifier of the index for getting a list of groups mapped to users.

max_results class-attribute instance-attribute

max_results: int | None = None

The maximum number of returned groups that are mapped to users.

next_token class-attribute instance-attribute

next_token: str | None = None

If the previous response was incomplete (because there is more data to retrieve), Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of groups that are mapped to users.

updated_earlier_than class-attribute instance-attribute

updated_earlier_than: datetime | None = None

The timestamp identifier used for the latest PUT or DELETE action for mapping users to their groups.

Output

ListGroupsOutput dataclass

Dataclass for ListGroupsOutput structure.

Attributes

items class-attribute instance-attribute

items: list[GroupSummary] | None = None

Summary information for list of groups that are mapped to users.

next_token class-attribute instance-attribute

next_token: str | None = None

If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of groups that are mapped to users.