QuickSight / Paginator / ListUserGroups


class QuickSight.Paginator.ListUserGroups#
paginator = client.get_paginator('list_user_groups')

Creates an iterator that will paginate through responses from QuickSight.Client.list_user_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • UserName (string) –


    The Amazon QuickSight user name that you want to list group memberships for.

  • AwsAccountId (string) –


    The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

  • Namespace (string) –


    The namespace. Currently, you should set this to default.

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



Response Syntax

    'GroupList': [
            'Arn': 'string',
            'GroupName': 'string',
            'Description': 'string',
            'PrincipalId': 'string'
    'RequestId': 'string',
    'Status': 123

Response Structure

  • (dict) –

    • GroupList (list) –

      The list of groups the user is a member of.

      • (dict) –

        A group in Amazon QuickSight consists of a set of users. You can use groups to make it easier to manage access and security.

        • Arn (string) –

          The Amazon Resource Name (ARN) for the group.

        • GroupName (string) –

          The name of the group.

        • Description (string) –

          The group description.

        • PrincipalId (string) –

          The principal ID of the group.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • Status (integer) –

      The HTTP status of the request.