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

*************
search_groups
*************



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

  

  Use the ``SearchGroups`` operation to search groups in a specified Quick Sight namespace using the supplied filters.

  

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


  **Request Syntax**
  ::

    response = client.search_groups(
        AwsAccountId='string',
        NextToken='string',
        MaxResults=123,
        Namespace='string',
        Filters=[
            {
                'Operator': 'StartsWith',
                'Name': 'GROUP_NAME',
                'Value': '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 from this request.

    

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

        

      
    

  
  :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) --* 

        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.

            
      
    
      

      - **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`

  