Skip to content

get_kx_user async

get_kx_user(
    user_name: KxUserNameString,
    environment_id: IdType,
    *,
    config_overrides: Optional[AsyncfinspaceClientConfig] = None,
) -> GetKxUserResponse

Retrieves information about the specified kdb user.

Parameters:

  • user_name (KxUserNameString) –

    A unique identifier for the user.

  • environment_id (IdType) –

    A unique identifier for the kdb environment.

Raises:

Source code in docs_src/capo_finspace/_services/async_finspace.py
async def get_kx_user(
    self,
    user_name: "capo_finspace.types.kx_user_name_string.KxUserNameString",
    environment_id: "capo_finspace.types.id_type.IdType",
    *,
    config_overrides: Optional[AsyncfinspaceClientConfig] = None,
) -> "capo_finspace.types.get_kx_user_response.GetKxUserResponse":
    """<p>Retrieves information about the specified kdb user.</p>

    Args:
        user_name: <p>A unique identifier for the user.</p>
        environment_id: <p>A unique identifier for the kdb environment.</p>

    Raises:
        capo_finspace.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_finspace.types.get_kx_user_request.GetKxUserRequest]",
    ) -> AsyncOperationResponse[
        "capo_finspace.types.get_kx_user_response.GetKxUserResponse"
    ]:
        import capo_finspace._operations.aws_habanero_management_service.get_kx_user

        (
            output,
            http_response,
        ) = await capo_finspace._operations.aws_habanero_management_service.get_kx_user.async_get_kx_user(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetKxUser")
    )
    input_: capo_finspace.types.get_kx_user_request.GetKxUserRequest = {
        "user_name": user_name,
        "environment_id": environment_id,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output