QBusiness / Client / list_groups

list_groups

QBusiness.Client.list_groups(**kwargs)

Provides a list of groups that are mapped to users.

See also: AWS API Documentation

Request Syntax

response = client.list_groups(
    applicationId='string',
    indexId='string',
    updatedEarlierThan=datetime(2015, 1, 1),
    dataSourceId='string',
    nextToken='string',
    maxResults=123
)

Parameters:

• applicationId (string) –

  [REQUIRED]

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

• indexId (string) –

  [REQUIRED]

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

• updatedEarlierThan (datetime) –

  [REQUIRED]

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

• dataSourceId (string) – The identifier of the data source for getting a list of groups mapped to users.

• nextToken (string) – 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.

• maxResults (integer) – The maximum number of returned groups that are mapped to users.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'items': [
        {
            'groupName': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • nextToken (string) –

    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.

  • items (list) –

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

    • (dict) –

      Summary information for groups.

      • groupName (string) –

        The name of the group the summary information is for.

Exceptions

• QBusiness.Client.exceptions.ResourceNotFoundException

• QBusiness.Client.exceptions.InternalServerException

• QBusiness.Client.exceptions.ConflictException

• QBusiness.Client.exceptions.ThrottlingException

• QBusiness.Client.exceptions.ValidationException

• QBusiness.Client.exceptions.AccessDeniedException