UpdateKxClusterCodeConfiguration - 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.


Allows you to update code configuration on a running cluster. By using this API you can update the code, the initialization script path, and the command line arguments for a specific cluster. The configuration that you want to update will override any existing configurations on the cluster.

Request Syntax

PUT /kx/environments/environmentId/clusters/clusterName/configuration/code HTTP/1.1 Content-type: application/json { "clientToken": "string", "code": { "s3Bucket": "string", "s3Key": "string", "s3ObjectVersion": "string" }, "commandLineArguments": [ { "key": "string", "value": "string" } ], "deploymentConfiguration": { "deploymentStrategy": "string" }, "initializationScript": "string" }

URI Request Parameters

The request uses the following URI parameters.


The name of the cluster.

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


A unique identifier of the 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 the customer code available within the running cluster.

Type: CodeConfiguration object

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


Specifies the key-value pairs to make them available inside the cluster.

You cannot update this parameter for a NO_RESTART deployment.

Type: Array of KxCommandLineArgument objects

Required: No


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

Type: KxClusterCodeDeploymentConfiguration object

Required: No


Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, somedir/init.q.

You cannot update this parameter for a NO_RESTART deployment.

Type: String

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

Pattern: ^[a-zA-Z0-9\_\-\.\/\\]+$

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: