:doc:`Synthetics <../../synthetics>` / Client / list_groups

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



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

  

  Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups from all Regions are returned.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListGroups>`_  


  **Request Syntax**
  ::

    response = client.list_groups(
        NextToken='string',
        MaxResults=123
    )
    
  :type NextToken: string
  :param NextToken: 

    A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    Specify this parameter to limit how many groups are returned each time you use the ``ListGroups`` operation. If you omit this parameter, the default of 20 is used.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'Groups': [
              {
                  'Id': 'string',
                  'Name': 'string',
                  'Arn': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Groups** *(list) --* 

        An array of structures that each contain information about one group.

        
        

        - *(dict) --* 

          A structure containing some information about a group.

          
          

          - **Id** *(string) --* 

            The unique ID of the group.

            
          

          - **Name** *(string) --* 

            The name of the group.

            
          

          - **Arn** *(string) --* 

            The ARN of the group.

            
      
    
      

      - **NextToken** *(string) --* 

        A token that indicates that there is more data available. You can use this token in a subsequent ``ListGroups`` operation to retrieve the next set of results.

        
  
  **Exceptions**
  
  *   :py:class:`Synthetics.Client.exceptions.InternalServerException`

  
  *   :py:class:`Synthetics.Client.exceptions.ValidationException`

  