:doc:`QuickSight <../../quicksight>` / Paginator / SearchGroups

************
SearchGroups
************



.. py:class:: QuickSight.Paginator.SearchGroups

  ::

    
    paginator = client.get_paginator('search_groups')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`QuickSight.Client.search_groups`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          AwsAccountId='string',
          Namespace='string',
          Filters=[
              {
                  'Operator': 'StartsWith',
                  'Name': 'GROUP_NAME',
                  'Value': 'string'
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': '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 Namespace: string
    :param Namespace: **[REQUIRED]** 

      The namespace that you want to search.

      

    
    :type Filters: list
    :param Filters: **[REQUIRED]** 

      The structure for the search filters that you want to apply to your search.

      

    
      - *(dict) --* 

        A ``GroupSearchFilter`` object that you want to apply to your search.

        

      
        - **Operator** *(string) --* **[REQUIRED]** 

          The comparison operator that you want to use as a filter, for example ``"Operator": "StartsWith"``. Currently, the only supported operator is ``StartsWith``.

          

        
        - **Name** *(string) --* **[REQUIRED]** 

          The name of the value that you want to use as a filter, for example ``"Name": "GROUP_NAME"``. Currently, the only supported name is ``GROUP_NAME``.

          

        
        - **Value** *(string) --* **[REQUIRED]** 

          The value of the named item, in this case ``GROUP_NAME``, that you want to use as a filter.

          

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

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

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

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

        

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

      
      ::

        {
            'GroupList': [
                {
                    'Arn': 'string',
                    'GroupName': 'string',
                    'Description': 'string',
                    'PrincipalId': 'string'
                },
            ],
            'RequestId': 'string',
            'Status': 123
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **GroupList** *(list) --* 

          A list of groups in a specified namespace that match the filters you set in your ``SearchGroups`` request.

          
          

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

              
        
      
        

        - **RequestId** *(string) --* 

          The Amazon Web Services request ID for this operation.

          
        

        - **Status** *(integer) --* 

          The HTTP status of the request.

          
    