Class GetKxUserCommandProtected

Retrieves information about the specified kdb user.

Example

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

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

Param

GetKxUserCommandInput

Returns

GetKxUserCommandOutput

See

• GetKxUserCommandInput for command's input shape.
• GetKxUserCommandOutput for command's response shape.
• config for FinspaceClient's config shape.

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.