finspace / Client / get_kx_connection_string

get_kx_connection_string#

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

Request Syntax

response = client.get_kx_connection_string(
    userArn='string',
    environmentId='string',
    clusterName='string'
)
Parameters:

  • userArn (string) –

    [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 in the IAM User Guide.

  • environmentId (string) –

    [REQUIRED]

    A unique identifier for the kdb environment.

  • clusterName (string) –

    [REQUIRED]

    A name of the kdb cluster.

Return type:

dict

Returns:

Response Syntax

{
    'signedConnectionString': 'string'
}

Response Structure

  • (dict) –

    • signedConnectionString (string) –

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

Exceptions

  • finspace.Client.exceptions.InternalServerException

  • finspace.Client.exceptions.ThrottlingException

  • finspace.Client.exceptions.AccessDeniedException

  • finspace.Client.exceptions.ResourceNotFoundException

  • finspace.Client.exceptions.ValidationException