:doc:`DataZone <../../datazone>` / Client / search_user_profiles

********************
search_user_profiles
********************



.. py:method:: DataZone.Client.search_user_profiles(**kwargs)

  

  Searches user profiles in Amazon DataZone.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/SearchUserProfiles>`_  


  **Request Syntax**
  ::

    response = client.search_user_profiles(
        domainIdentifier='string',
        userType='SSO_USER'|'DATAZONE_USER'|'DATAZONE_SSO_USER'|'DATAZONE_IAM_USER',
        searchText='string',
        maxResults=123,
        nextToken='string'
    )
    
  :type domainIdentifier: string
  :param domainIdentifier: **[REQUIRED]** 

    The identifier of the Amazon DataZone domain in which you want to search user profiles.

    

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

    Specifies the user type for the ``SearchUserProfiles`` action.

    

  
  :type searchText: string
  :param searchText: 

    Specifies the text for which to search.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return in a single call to ``SearchUserProfiles``. When the number of results to be listed is greater than the value of ``MaxResults``, the response contains a ``NextToken`` value that you can use in a subsequent call to ``SearchUserProfiles`` to list the next set of results.

    

  
  :type nextToken: string
  :param nextToken: 

    When the number of results is greater than the default value for the ``MaxResults`` parameter, or if you explicitly specify a value for ``MaxResults`` that is less than the number of results, the response includes a pagination token named ``NextToken``. You can specify this ``NextToken`` value in a subsequent call to ``SearchUserProfiles`` to list the next set of results.

    

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

    
    ::

      {
          'items': [
              {
                  'domainId': 'string',
                  'id': 'string',
                  'type': 'IAM'|'SSO',
                  'status': 'ASSIGNED'|'NOT_ASSIGNED'|'ACTIVATED'|'DEACTIVATED',
                  'details': {
                      'iam': {
                          'arn': 'string',
                          'principalId': 'string'
                      },
                      'sso': {
                          'username': 'string',
                          'firstName': 'string',
                          'lastName': 'string'
                      }
                  }
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **items** *(list) --* 

        The results of the ``SearchUserProfiles`` action.

        
        

        - *(dict) --* 

          The details of the user profile.

          
          

          - **domainId** *(string) --* 

            The ID of the Amazon DataZone domain of the user profile.

            
          

          - **id** *(string) --* 

            The ID of the user profile.

            
          

          - **type** *(string) --* 

            The type of the user profile.

            
          

          - **status** *(string) --* 

            The status of the user profile.

            
          

          - **details** *(dict) --* 

            The details of the user profile.

            .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``iam``, ``sso``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


          
            

            - **iam** *(dict) --* 

              The IAM details of the user profile.

              
              

              - **arn** *(string) --* 

                The ARN of the IAM user.

                
              

              - **principalId** *(string) --* 

                The principal ID as part of the IAM user profile details.

                
          
            

            - **sso** *(dict) --* 

              The SSO details of the user profile.

              
              

              - **username** *(string) --* 

                The username as part of the SSO user profile detail.

                
              

              - **firstName** *(string) --* 

                The first name as part of the SSO user profile detail.

                
              

              - **lastName** *(string) --* 

                The last name as part of the SSO user profile detail.

                
          
        
      
    
      

      - **nextToken** *(string) --* 

        When the number of results is greater than the default value for the ``MaxResults`` parameter, or if you explicitly specify a value for ``MaxResults`` that is less than the number of results, the response includes a pagination token named ``NextToken``. You can specify this ``NextToken`` value in a subsequent call to ``SearchUserProfiles`` to list the next set of results.

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

  
  *   :py:class:`DataZone.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`DataZone.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`DataZone.Client.exceptions.ThrottlingException`

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

  
  *   :py:class:`DataZone.Client.exceptions.UnauthorizedException`

  