Skip to content

delete_kx_user 

delete_kx_user(
    user_name: KxUserNameString,
    environment_id: IdType,
    *,
    config_overrides: Optional[finspaceClientConfig] = None,
    client_token: Optional[ClientToken] = None,
) -> DeleteKxUserResponse

Deletes a user in the specified kdb environment.

Parameters:

  • user_name (KxUserNameString) –

    A unique identifier for the user that you want to delete.

  • environment_id (IdType) –

    A unique identifier for the kdb environment.

  • client_token (Optional[ClientToken], default: None ) –

    A token that ensures idempotency. This token expires in 10 minutes.

Raises:

Source code in docs_src/capo_finspace/_services/finspace.py 
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
def delete_kx_user(
    self,
    user_name: "capo_finspace.types.kx_user_name_string.KxUserNameString",
    environment_id: "capo_finspace.types.id_type.IdType",
    *,
    config_overrides: Optional[finspaceClientConfig] = None,
    client_token: Optional["capo_finspace.types.client_token.ClientToken"] = None,
) -> "capo_finspace.types.delete_kx_user_response.DeleteKxUserResponse":
    """<p>Deletes a user in the specified kdb environment.</p>

    Args:
        user_name: <p>A unique identifier for the user that you want to delete.</p>
        environment_id: <p>A unique identifier for 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.delete_kx_user_request.DeleteKxUserRequest]",
    ) -> OperationResponse[
        "capo_finspace.types.delete_kx_user_response.DeleteKxUserResponse"
    ]:
        import capo_finspace._operations.aws_habanero_management_service.delete_kx_user

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteKxUser")
    )
    input_: capo_finspace.types.delete_kx_user_request.DeleteKxUserRequest = {
        "user_name": user_name,
        "environment_id": environment_id,
    }
    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