update_kx_environment ¶

def update_kx_environment(
    self,
    environment_id: "capo_finspace.types.id_type.IdType",
    *,
    config_overrides: Optional[finspaceClientConfig] = None,
    name: Optional[
        "capo_finspace.types.kx_environment_name.KxEnvironmentName"
    ] = None,
    description: Optional["capo_finspace.types.description.Description"] = None,
    client_token: Optional["capo_finspace.types.client_token.ClientToken"] = None,
) -> (
    "capo_finspace.types.update_kx_environment_response.UpdateKxEnvironmentResponse"
):
    """<p>Updates information for the given kdb environment.</p>

    Args:
        environment_id: <p>A unique identifier for the kdb environment.</p>
        name: <p>The name of the kdb environment.</p>
        description: <p>A description of the kdb environment.</p>
        client_token: <p>A token that ensures idempotency. This token expires in 10 minutes.</p>

    Raises:
        capo_finspace.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_finspace.errors.conflict_exception.ConflictException: <p>There was a conflict with this action, and it could not be completed.</p>
        capo_finspace.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_finspace.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_finspace.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_finspace.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an AWS service.</p>
        capo_finspace.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_finspace.types.update_kx_environment_request.UpdateKxEnvironmentRequest]",
    ) -> OperationResponse[
        "capo_finspace.types.update_kx_environment_response.UpdateKxEnvironmentResponse"
    ]:
        import capo_finspace._operations.aws_habanero_management_service.update_kx_environment

        output, http_response = (
            capo_finspace._operations.aws_habanero_management_service.update_kx_environment.update_kx_environment(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateKxEnvironment")
    )
    input_: capo_finspace.types.update_kx_environment_request.UpdateKxEnvironmentRequest = {
        "environment_id": environment_id
    }
    if name is not None:
        input_["name"] = name
    if description is not None:
        input_["description"] = description
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output