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

**************
create_kx_user
**************



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

  

  Creates a user in FinSpace kdb environment with an associated IAM role.

  

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


  **Request Syntax**
  ::

    response = client.create_kx_user(
        environmentId='string',
        userName='string',
        iamRole='string',
        tags={
            'string': 'string'
        },
        clientToken='string'
    )
    
  :type environmentId: string
  :param environmentId: **[REQUIRED]** 

    A unique identifier for the kdb environment where you want to create a user.

    

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

    A unique identifier for the user.

    

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

    The IAM role ARN that will be associated with the user.

    

  
  :type tags: dict
  :param tags: 

    A list of key-value pairs to label the user. You can add up to 50 tags to a user.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


  :type clientToken: string
  :param clientToken: 

    A token that ensures idempotency. This token expires in 10 minutes.

    This field is autopopulated if not provided.

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

    
    ::

      {
          'userName': 'string',
          'userArn': 'string',
          'environmentId': 'string',
          'iamRole': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        A unique identifier for the 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*.

        
      

      - **environmentId** *(string) --* 

        A unique identifier for the kdb environment.

        
      

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

        The IAM role ARN that will be associated with the user.

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

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

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

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

  