QuickSight / Client / list_group_memberships

list_group_memberships

QuickSight.Client.list_group_memberships(**kwargs)

Lists member users in a group.

See also: AWS API Documentation

Request Syntax

response = client.list_group_memberships(
    GroupName='string',
    NextToken='string',
    MaxResults=123,
    AwsAccountId='string',
    Namespace='string'
)
Parameters:

  • GroupName (string) –

    [REQUIRED]

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

  • NextToken (string) – A pagination token that can be used in a subsequent request.

  • MaxResults (integer) – The maximum number of results to return from this request.

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

Return type:

dict

Returns:

Response Syntax

{
    'GroupMemberList': [
        {
            'Arn': 'string',
            'MemberName': 'string'
        },
    ],
    'NextToken': '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).

    • NextToken (string) –

      A pagination token that can be used in a subsequent request.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • Status (integer) –

      The HTTP status of the request.

Exceptions