Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class DeleteKxUserCommandProtected

Deletes a user in the specified kdb environment.

Example

Use a bare-bones client and the command you need to make an API call.

import { FinspaceClient, DeleteKxUserCommand } from "@aws-sdk/client-finspace"; // ES Modules import
// const { FinspaceClient, DeleteKxUserCommand } = require("@aws-sdk/client-finspace"); // CommonJS import
const client = new FinspaceClient(config);
const input = { // DeleteKxUserRequest
userName: "STRING_VALUE", // required
environmentId: "STRING_VALUE", // required
};
const command = new DeleteKxUserCommand(input);
const response = await client.send(command);
// {};

Param

DeleteKxUserCommandInput

Returns

DeleteKxUserCommandOutput

See

Throws

AccessDeniedException (client fault)

You do not have sufficient access to perform this action.

Throws

InternalServerException (server fault)

The request processing has failed because of an unknown error, exception or failure.

Throws

ResourceNotFoundException (client fault)

One or more resources can't be found.

Throws

ThrottlingException (client fault)

The request was denied due to request throttling.

Throws

ValidationException (client fault)

The input fails to satisfy the constraints specified by an AWS service.

Throws

FinspaceServiceException

Base exception class for all service exceptions from Finspace service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods