Class ReadUserCommandProtected

Retrieve a user.

Example

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

import { SftpClient, ReadUserCommand } from "@stedi/sdk-client-sftp"; // ES Modules import
// const { SftpClient, ReadUserCommand } = require("@stedi/sdk-client-sftp"); // CommonJS import
const client = new SftpClient(config);
const input = { // ReadUserInput
  username: "STRING_VALUE", // required
};
const command = new ReadUserCommand(input);
const response = await client.send(command);
// { // UserOutput
//   username: "STRING_VALUE", // required
//   homeDirectory: "STRING_VALUE", // required
//   description: "STRING_VALUE", // required
//   bucketName: "STRING_VALUE", // required
//   endpoint: "STRING_VALUE", // required
//   lastConnectedDate: "STRING_VALUE",
// };

Param

ReadUserCommandInput

Returns

ReadUserCommandOutput

See

• ReadUserCommandInput for command's input shape.
• ReadUserCommandOutput for command's response shape.
• config for SftpClient's config shape.

Throws

ValidationException (client fault) A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

Throws

SftpServiceException

Base exception class for all service exceptions from Sftp service.