finspace / Client / create_kx_user

create_kx_user#

finspace.Client.create_kx_user(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.create_kx_user(
    environmentId='string',
    userName='string',
    iamRole='string',
    tags={
        'string': 'string'
    },
    clientToken='string'
)
Parameters:

  • environmentId (string) –

    [REQUIRED]

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

  • userName (string) –

    [REQUIRED]

    A unique identifier for the user.

  • iamRole (string) –

    [REQUIRED]

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

  • tags (dict) –

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

    • (string) –

      • (string) –

  • clientToken (string) – A token that ensures idempotency. This token expires in 10 minutes.

Return type:

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

  • finspace.Client.exceptions.ResourceNotFoundException

  • finspace.Client.exceptions.InternalServerException

  • finspace.Client.exceptions.ThrottlingException

  • finspace.Client.exceptions.AccessDeniedException

  • finspace.Client.exceptions.ValidationException

  • finspace.Client.exceptions.ResourceAlreadyExistsException

  • finspace.Client.exceptions.LimitExceededException

  • finspace.Client.exceptions.ConflictException