update_kx_cluster_code_configuration
async
¶
update_kx_cluster_code_configuration(
environment_id: KxEnvironmentId,
cluster_name: KxClusterName,
code: CodeConfiguration,
*,
config_overrides: Optional[AsyncfinspaceClientConfig] = None,
client_token: Optional[ClientTokenString] = None,
initialization_script: Optional[InitializationScriptFilePath] = None,
command_line_arguments: Optional[KxCommandLineArguments] = None,
deployment_configuration: Optional[KxClusterCodeDeploymentConfiguration] = None,
) -> UpdateKxClusterCodeConfigurationResponse
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.
Parameters:
-
environment_id(KxEnvironmentId) –A unique identifier of the kdb environment.
-
cluster_name(KxClusterName) –The name of the cluster.
-
client_token(Optional[ClientTokenString], default:None) –A token that ensures idempotency. This token expires in 10 minutes.
-
initialization_script(Optional[InitializationScriptFilePath], default:None) –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_RESTARTdeployment. -
command_line_arguments(Optional[KxCommandLineArguments], default:None) –Specifies the key-value pairs to make them available inside the cluster.
You cannot update this parameter for a
NO_RESTARTdeployment. -
deployment_configuration(Optional[KxClusterCodeDeploymentConfiguration], default:None) –The configuration that allows you to choose how you want to update the code on a cluster.
Raises:
-
AccessDeniedException–You do not have sufficient access to perform this action.
-
ConflictException–There was a conflict with this action, and it could not be completed.
-
InternalServerException–The request processing has failed because of an unknown error, exception or failure.
-
LimitExceededException–A service limit or quota is exceeded.
-
ResourceNotFoundException–One or more resources can't be found.
-
ThrottlingException–The request was denied due to request throttling.
-
ValidationException–The input fails to satisfy the constraints specified by an AWS service.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_finspace/_services/async_finspace.py
3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 | |