:doc:`finspace <../../finspace>` / Client / list_kx_users

*************
list_kx_users
*************



.. py:method:: finspace.Client.list_kx_users(**kwargs)

  

  Lists all the users in a kdb environment.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxUsers>`_  


  **Request Syntax**
  ::

    response = client.list_kx_users(
        environmentId='string',
        nextToken='string',
        maxResults=123
    )
    
  :type environmentId: string
  :param environmentId: **[REQUIRED]** 

    A unique identifier for the kdb environment.

    

  
  :type nextToken: string
  :param nextToken: 

    A token that indicates where a results page should begin.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return in this request.

    

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

    
    ::

      {
          'users': [
              {
                  'userArn': 'string',
                  'userName': 'string',
                  'iamRole': 'string',
                  'createTimestamp': datetime(2015, 1, 1),
                  'updateTimestamp': datetime(2015, 1, 1)
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **users** *(list) --* 

        A list of users in a kdb environment.

        
        

        - *(dict) --* 

          A structure that stores metadata for a kdb user.

          
          

          - **userArn** *(string) --* 

            The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see `IAM Identifiers <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html>`__ in the *IAM User Guide*.

            
          

          - **userName** *(string) --* 

            A unique identifier for the user.

            
          

          - **iamRole** *(string) --* 

            The IAM role ARN that is associated with the user.

            
          

          - **createTimestamp** *(datetime) --* 

            The timestamp at which the kdb user was created.

            
          

          - **updateTimestamp** *(datetime) --* 

            The timestamp at which the kdb user was updated.

            
      
    
      

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

        A token that indicates where a results page should begin.

        
  
  **Exceptions**
  
  *   :py:class:`finspace.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`finspace.Client.exceptions.InternalServerException`

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

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

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

  