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

************************
get_kx_connection_string
************************



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

  

  Retrieves a connection string for a user to connect to a kdb cluster. You must call this API using the same role that you have defined while creating a user.

  

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


  **Request Syntax**
  ::

    response = client.get_kx_connection_string(
        userArn='string',
        environmentId='string',
        clusterName='string'
    )
    
  :type userArn: string
  :param userArn: **[REQUIRED]** 

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

    

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

    A unique identifier for the kdb environment.

    

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

    A name of the kdb cluster.

    

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

    
    ::

      {
          'signedConnectionString': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **signedConnectionString** *(string) --* 

        The signed connection string that you can use to connect to clusters.

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

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

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

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

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

  