update_kx_cluster_databases
¶
update_kx_cluster_databases(
environment_id: KxEnvironmentId,
cluster_name: KxClusterName,
databases: KxDatabaseConfigurations,
*,
config_overrides: Optional[finspaceClientConfig] = None,
client_token: Optional[ClientTokenString] = None,
deployment_configuration: Optional[KxDeploymentConfiguration] = None,
) -> UpdateKxClusterDatabasesResponse
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.
Parameters:
-
environment_id(KxEnvironmentId) –The unique identifier of a kdb environment.
-
cluster_name(KxClusterName) –A unique name for the cluster that you want to modify.
-
client_token(Optional[ClientTokenString], default:None) –A token that ensures idempotency. This token expires in 10 minutes.
-
databases(KxDatabaseConfigurations) –The structure of databases mounted on the cluster.
-
deployment_configuration(Optional[KxDeploymentConfiguration], default:None) –The configuration that allows you to choose how you want to update the databases 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/finspace.py
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 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 | |