Skip to content

ListGroupsRequest

Source code in docs_src/capo_qbusiness/types/list_groups_request.py
class ListGroupsRequest(TypedDict, closed=True):
    application_id: "capo_qbusiness.types.application_id.ApplicationId"
    """<p>The identifier of the application for getting a list of groups mapped to users.</p>"""
    index_id: "capo_qbusiness.types.index_id.IndexId"
    """<p>The identifier of the index for getting a list of groups mapped to users.</p>"""
    updated_earlier_than: "capo_qbusiness.types.timestamp.Timestamp"
    """<p>The timestamp identifier used for the latest <code>PUT</code> or <code>DELETE</code> action for mapping users to their groups.</p>"""
    data_source_id: NotRequired["capo_qbusiness.types.data_source_id.DataSourceId"]
    """<p>The identifier of the data source for getting a list of groups mapped to users.</p>"""
    next_token: NotRequired["capo_qbusiness.types.next_token.NextToken"]
    """<p>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.</p>"""
    max_results: NotRequired[
        "capo_qbusiness.types.max_results_integer_for_list_groups_request.MaxResultsIntegerForListGroupsRequest"
    ]
    """<p>The maximum number of returned groups that are mapped to users.</p>"""

application_id instance-attribute

application_id: ApplicationId

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

data_source_id instance-attribute

data_source_id: NotRequired[DataSourceId]

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

index_id instance-attribute

index_id: IndexId

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

max_results instance-attribute

max_results: NotRequired[MaxResultsIntegerForListGroupsRequest]

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

next_token instance-attribute

next_token: NotRequired[NextToken]

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 instance-attribute

updated_earlier_than: Timestamp

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