:doc:`DataZone <../../datazone>` / Paginator / SearchUserProfiles

******************
SearchUserProfiles
******************



.. py:class:: DataZone.Paginator.SearchUserProfiles

  ::

    
    paginator = client.get_paginator('search_user_profiles')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`DataZone.Client.search_user_profiles`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          domainIdentifier='string',
          userType='SSO_USER'|'DATAZONE_USER'|'DATAZONE_SSO_USER'|'DATAZONE_IAM_USER',
          searchText='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': '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 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**

      
      ::

        {
            '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) --* 

          A token to resume pagination.

          
    