finspace / Client / create_kx_database
create_kx_database#
- finspace.Client.create_kx_database(**kwargs)#
Creates a new kdb database in the environment.
See also: AWS API Documentation
Request Syntax
response = client.create_kx_database( environmentId='string', databaseName='string', description='string', tags={ 'string': 'string' }, clientToken='string' )
- Parameters:
environmentId (string) –
[REQUIRED]
A unique identifier for the kdb environment.
databaseName (string) –
[REQUIRED]
The name of the kdb database.
description (string) – A description of the database.
tags (dict) –
A list of key-value pairs to label the kdb database. You can add up to 50 tags to your kdb database
(string) –
(string) –
clientToken (string) –
[REQUIRED]
A token that ensures idempotency. This token expires in 10 minutes.
This field is autopopulated if not provided.
- Return type:
dict
- Returns:
Response Syntax
{ 'databaseName': 'string', 'databaseArn': 'string', 'environmentId': 'string', 'description': 'string', 'createdTimestamp': datetime(2015, 1, 1), 'lastModifiedTimestamp': datetime(2015, 1, 1) }
Response Structure
(dict) –
databaseName (string) –
The name of the kdb database.
databaseArn (string) –
The ARN identifier of the database.
environmentId (string) –
A unique identifier for the kdb environment.
description (string) –
A description of the database.
createdTimestamp (datetime) –
The timestamp at which the database is 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 updated 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.
Exceptions
finspace.Client.exceptions.InternalServerException
finspace.Client.exceptions.ValidationException
finspace.Client.exceptions.ThrottlingException
finspace.Client.exceptions.AccessDeniedException
finspace.Client.exceptions.ConflictException
finspace.Client.exceptions.ResourceAlreadyExistsException
finspace.Client.exceptions.ResourceNotFoundException
finspace.Client.exceptions.LimitExceededException