QBusiness / Paginator / ListGroups

ListGroups#

class QBusiness.Paginator.ListGroups#
paginator = client.get_paginator('list_groups')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from QBusiness.Client.list_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    applicationId='string',
    dataSourceId='string',
    indexId='string',
    updatedEarlierThan=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • applicationId (string) –

    [REQUIRED]

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

  • dataSourceId (string) – The identifier of the data source 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.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • 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.

    • NextToken (string) –

      A token to resume pagination.