:doc:`QuickSight <../../quicksight>` / Client / list_user_groups

****************
list_user_groups
****************



.. py:method:: QuickSight.Client.list_user_groups(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUserGroups>`_  


  **Request Syntax**
  ::

    response = client.list_user_groups(
        UserName='string',
        AwsAccountId='string',
        Namespace='string',
        NextToken='string',
        MaxResults=123
    )
    
  :type UserName: string
  :param UserName: **[REQUIRED]** 

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

    

  
  :type AwsAccountId: string
  :param AwsAccountId: **[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 Quick Sight account.

    

  
  :type Namespace: string
  :param Namespace: **[REQUIRED]** 

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

    

  
  :type NextToken: string
  :param NextToken: 

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

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return from this request.

    

  
  
  :rtype: 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 Quick Sight 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**
  
  *   :py:class:`QuickSight.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`QuickSight.Client.exceptions.InvalidParameterValueException`

  
  *   :py:class:`QuickSight.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`QuickSight.Client.exceptions.ThrottlingException`

  
  *   :py:class:`QuickSight.Client.exceptions.PreconditionNotMetException`

  
  *   :py:class:`QuickSight.Client.exceptions.InternalFailureException`

  
  *   :py:class:`QuickSight.Client.exceptions.ResourceUnavailableException`

  