Amazon FinSpace Dataset Browser will be discontinued on November 29,
2024
. Starting November 29, 2023
, FinSpace will no longer accept the creation of new Dataset Browser
environments. Customers using Amazon FinSpace with Managed Kdb Insights
CreateKxDatabase
Creates a new kdb database in the environment.
Request Syntax
POST /kx/environments/environmentId
/databases HTTP/1.1
Content-type: application/json
{
"clientToken": "string
",
"databaseName": "string
",
"description": "string
",
"tags": {
"string
" : "string
"
}
}
URI Request Parameters
The request uses the following URI parameters.
- environmentId
-
A unique identifier for the kdb environment.
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
.*\S.*
Required: Yes
Request Body
The request accepts the following data in JSON format.
- clientToken
-
A token that ensures idempotency. This token expires in 10 minutes.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9-]+$
Required: Yes
- databaseName
-
The name of the kdb database.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$
Required: Yes
- description
-
A description of the database.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern:
^[a-zA-Z0-9. ]{1,1000}$
Required: No
-
A list of key-value pairs to label the kdb database. You can add up to 50 tags to your kdb database
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[a-zA-Z+-=._:/]+$
Value Length Constraints: Minimum length of 1. Maximum length of 256.
Value Pattern:
^[a-zA-Z0-9+-=._:@ ]+$
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"createdTimestamp": number,
"databaseArn": "string",
"databaseName": "string",
"description": "string",
"environmentId": "string",
"lastModifiedTimestamp": number
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- createdTimestamp
-
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.
Type: Timestamp
- databaseArn
-
The ARN identifier of the database.
Type: String
- databaseName
-
The name of the kdb database.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$
- description
-
A description of the database.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern:
^[a-zA-Z0-9. ]{1,1000}$
- environmentId
-
A unique identifier for the kdb environment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
.*\S.*
- lastModifiedTimestamp
-
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.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- ConflictException
-
There was a conflict with this action, and it could not be completed.
HTTP Status Code: 409
- InternalServerException
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- LimitExceededException
-
A service limit or quota is exceeded.
HTTP Status Code: 400
- ResourceAlreadyExistsException
-
The specified resource group already exists.
HTTP Status Code: 409
- ResourceNotFoundException
-
One or more resources can't be found.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: