UpdateKxClusterDatabases - Amazon FinSpace

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 will not be affected. For more information, review the FAQ or contact AWS Support to assist with your transition.


Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be cached. This API does not allow you to change a database name or add a database if you created a cluster without one.

Using this API you can point a cluster to a different changeset and modify a list of partitions being cached.

Request Syntax

PUT /kx/environments/environmentId/clusters/clusterName/configuration/databases HTTP/1.1 Content-type: application/json { "clientToken": "string", "databases": [ { "cacheConfigurations": [ { "cacheType": "string", "dataviewName": "string", "dbPaths": [ "string" ] } ], "changesetId": "string", "databaseName": "string", "dataviewConfiguration": { "changesetId": "string", "dataviewName": "string", "dataviewVersionId": "string", "segmentConfigurations": [ { "dbPaths": [ "string" ], "onDemand": boolean, "volumeName": "string" } ] }, "dataviewName": "string" } ], "deploymentConfiguration": { "deploymentStrategy": "string" } }

URI Request Parameters

The request uses the following URI parameters.


A unique name for the cluster that you want to modify.

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


The unique identifier of a kdb environment.

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: ^[a-z0-9]+$

Required: Yes

Request Body

The request accepts the following data in JSON format.


The structure of databases mounted on the cluster.

Type: Array of KxDatabaseConfiguration objects

Required: Yes


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: No


The configuration that allows you to choose how you want to update the databases on a cluster.

Type: KxDeploymentConfiguration object

Required: No

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.


For information about the errors that are common to all actions, see Common Errors.


You do not have sufficient access to perform this action.

HTTP Status Code: 403


There was a conflict with this action, and it could not be completed.

HTTP Status Code: 409


The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500


A service limit or quota is exceeded.

HTTP Status Code: 400


One or more resources can't be found.

HTTP Status Code: 404


The request was denied due to request throttling.

HTTP Status Code: 429


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: