QuickSight / Paginator / ListGroupMemberships

ListGroupMemberships

class QuickSight.Paginator.ListGroupMemberships

paginator = client.get_paginator('list_group_memberships')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GroupName='string',
    AwsAccountId='string',
    Namespace='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• GroupName (string) –

  [REQUIRED]

  The name of the group that you want to see a membership list of.

• AwsAccountId (string) –

  [REQUIRED]

  The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.

• Namespace (string) –

  [REQUIRED]

  The namespace of the group that you want a list of users from.

• 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

{
    'GroupMemberList': [
        {
            'Arn': 'string',
            'MemberName': 'string'
        },
    ],
    'RequestId': 'string',
    'Status': 123
}

Response Structure

• (dict) –

  • GroupMemberList (list) –

    The list of the members of the group.

    • (dict) –

      A member of an Quick Sight group. Currently, group members must be users. Groups can’t be members of another group. .

      • Arn (string) –

        The Amazon Resource Name (ARN) for the group member (user).

      • MemberName (string) –

        The name of the group member (user).

  • RequestId (string) –

    The Amazon Web Services request ID for this operation.

  • Status (integer) –

    The HTTP status of the request.