:doc:`SageMaker <../../sagemaker>` / Client / list_user_profiles

******************
list_user_profiles
******************



.. py:method:: SageMaker.Client.list_user_profiles(**kwargs)

  

  Lists user profiles.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListUserProfiles>`_  


  **Request Syntax**
  ::

    response = client.list_user_profiles(
        NextToken='string',
        MaxResults=123,
        SortOrder='Ascending'|'Descending',
        SortBy='CreationTime'|'LastModifiedTime',
        DomainIdEquals='string',
        UserProfileNameContains='string'
    )
    
  :type NextToken: string
  :param NextToken: 

    If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    This parameter defines the maximum number of results that can be return in a single response. The ``MaxResults`` parameter is an upper bound, not a target. If there are more results available than the value specified, a ``NextToken`` is provided in the response. The ``NextToken`` indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for ``MaxResults`` is 10.

    

  
  :type SortOrder: string
  :param SortOrder: 

    The sort order for the results. The default is Ascending.

    

  
  :type SortBy: string
  :param SortBy: 

    The parameter by which to sort the results. The default is CreationTime.

    

  
  :type DomainIdEquals: string
  :param DomainIdEquals: 

    A parameter by which to filter the results.

    

  
  :type UserProfileNameContains: string
  :param UserProfileNameContains: 

    A parameter by which to filter the results.

    

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

    
    ::

      {
          'UserProfiles': [
              {
                  'DomainId': 'string',
                  'UserProfileName': 'string',
                  'Status': 'Deleting'|'Failed'|'InService'|'Pending'|'Updating'|'Update_Failed'|'Delete_Failed',
                  'CreationTime': datetime(2015, 1, 1),
                  'LastModifiedTime': datetime(2015, 1, 1)
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **UserProfiles** *(list) --* 

        The list of user profiles.

        
        

        - *(dict) --* 

          The user profile details.

          
          

          - **DomainId** *(string) --* 

            The domain ID.

            
          

          - **UserProfileName** *(string) --* 

            The user profile name.

            
          

          - **Status** *(string) --* 

            The status.

            
          

          - **CreationTime** *(datetime) --* 

            The creation time.

            
          

          - **LastModifiedTime** *(datetime) --* 

            The last modified time.

            
      
    
      

      - **NextToken** *(string) --* 

        If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

        
  