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

***********
list_groups
***********



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

  

  Lists all user groups in Amazon Quick Sight.

  

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


  **Request Syntax**
  ::

    response = client.list_groups(
        AwsAccountId='string',
        NextToken='string',
        MaxResults=123,
        Namespace='string'
    )
    
  :type AwsAccountId: string
  :param AwsAccountId: **[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.

    

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

    

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

    The namespace that you want a list of groups from.

    

  
  
  :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 the groups.

        
        

        - *(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.InvalidNextTokenException`

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

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

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

  