finspace / Client / list_kx_databases

list_kx_databases#

finspace.Client.list_kx_databases(**kwargs)#

Returns a list of all the databases in the kdb environment.

Request Syntax

response = client.list_kx_databases(
    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

{
    'kxDatabases': [
        {
            'databaseName': 'string',
            'createdTimestamp': datetime(2015, 1, 1),
            'lastModifiedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- kxDatabases (list) –
  
  A list of databases in the kdb environment.
  - (dict) –
    
    Details about a FinSpace managed kdb database
    - databaseName (string) –
      
      The name of the kdb database.
    - createdTimestamp (datetime) –
      
      The timestamp at which the database was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
    - lastModifiedTimestamp (datetime) –
      
      The last time that the database was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
- nextToken (string) –
  
  A token that indicates where a results page should begin.

Exceptions

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