finspace / Client / list_kx_users

list_kx_users#

finspace.Client.list_kx_users(**kwargs)#

Lists all the users in a kdb environment.

Request Syntax

response = client.list_kx_users(
    environmentId='string',
    nextToken='string',
    maxResults=123
)

Parameters:

environmentId (string) –
[REQUIRED]

A unique identifier for the kdb environment.
nextToken (string) – A token that indicates where a results page should begin.
maxResults (integer) – The maximum number of results to return in this request.

Return type:

dict

Returns:

Response Syntax

{
    'users': [
        {
            'userArn': 'string',
            'userName': 'string',
            'iamRole': 'string',
            'createTimestamp': datetime(2015, 1, 1),
            'updateTimestamp': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- users (list) –
  
  A list of users in a kdb environment.
  - (dict) –
    
    A structure that stores metadata for a kdb 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.
    - userName (string) –
      
      A unique identifier for the user.
    - iamRole (string) –
      
      The IAM role ARN that is associated with the user.
    - createTimestamp (datetime) –
      
      The timestamp at which the kdb user was created.
    - updateTimestamp (datetime) –
      
      The timestamp at which the kdb user was updated.
- nextToken (string) –
  
  A token that indicates where a results page should begin.

Exceptions

finspace.Client.exceptions.ResourceNotFoundException
finspace.Client.exceptions.InternalServerException
finspace.Client.exceptions.ThrottlingException
finspace.Client.exceptions.AccessDeniedException
finspace.Client.exceptions.ValidationException