:doc:`XRay <../../xray>` / Paginator / GetGroups

*********
GetGroups
*********



.. py:class:: XRay.Paginator.GetGroups

  ::

    
    paginator = client.get_paginator('get_groups')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`XRay.Client.get_groups`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetGroups>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'StartingToken': 'string'
          }
      )
      
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

      
      ::

        {
            'Groups': [
                {
                    'GroupName': 'string',
                    'GroupARN': 'string',
                    'FilterExpression': 'string',
                    'InsightsConfiguration': {
                        'InsightsEnabled': True|False,
                        'NotificationsEnabled': True|False
                    }
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

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

          The collection of all active groups.

          
          

          - *(dict) --* 

            Details for a group without metadata.

            
            

            - **GroupName** *(string) --* 

              The unique case-sensitive name of the group.

              
            

            - **GroupARN** *(string) --* 

              The ARN of the group generated based on the GroupName.

              
            

            - **FilterExpression** *(string) --* 

              The filter expression defining the parameters to include traces.

              
            

            - **InsightsConfiguration** *(dict) --* 

              The structure containing configurations related to insights.

               

              
              * The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
               
              * The NotificationsEnabled boolean can be set to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.
              

              
              

              - **InsightsEnabled** *(boolean) --* 

                Set the InsightsEnabled value to true to enable insights or false to disable insights.

                
              

              - **NotificationsEnabled** *(boolean) --* 

                Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.

                
          
        
      
    