list_user_groups

QuickSight.Client.list_user_groups(**kwargs)

Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.

See also: AWS API Documentation

Request Syntax

response = client.list_user_groups(
    UserName='string',
    AwsAccountId='string',
    Namespace='string',
    NextToken='string',
    MaxResults=123
)

Parameters

• UserName (string) --

  [REQUIRED]

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

• AwsAccountId (string) --

  [REQUIRED]

  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) --

  [REQUIRED]

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

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

Return type

dict

Returns

Response Syntax

{
    'GroupList': [
        {
            'Arn': 'string',
            'GroupName': 'string',
            'Description': 'string',
            'PrincipalId': 'string'
        },
    ],
    'NextToken': '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.

  • 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

• QuickSight.Client.exceptions.AccessDeniedException
• QuickSight.Client.exceptions.InvalidParameterValueException
• QuickSight.Client.exceptions.ResourceNotFoundException
• QuickSight.Client.exceptions.ThrottlingException
• QuickSight.Client.exceptions.PreconditionNotMetException
• QuickSight.Client.exceptions.InternalFailureException
• QuickSight.Client.exceptions.ResourceUnavailableException