finspace / Client / update_kx_user

update_kx_user#

finspace.Client.update_kx_user(**kwargs)#

Updates the user details. You can only update the IAM role associated with a user.

See also: AWS API Documentation

Request Syntax

response = client.update_kx_user(
    environmentId='string',
    userName='string',
    iamRole='string',
    clientToken='string'
)
Parameters:

  • environmentId (string) –

    [REQUIRED]

    A unique identifier for the kdb environment.

  • userName (string) –

    [REQUIRED]

    A unique identifier for the user.

  • iamRole (string) –

    [REQUIRED]

    The IAM role ARN that is associated with the user.

  • clientToken (string) –

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

    This field is autopopulated if not provided.

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 is associated with the user.

Exceptions