Class ListUsersCommandProtected

Retrieve a list of users.

Example

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

import { SftpClient, ListUsersCommand } from "@stedi/sdk-client-sftp"; // ES Modules import
// const { SftpClient, ListUsersCommand } = require("@stedi/sdk-client-sftp"); // CommonJS import
const client = new SftpClient(config);
const input = { // ListUsersInput
  pageSize: Number("int"),
  pageToken: "STRING_VALUE",
};
const command = new ListUsersCommand(input);
const response = await client.send(command);
// { // ListUsersOutput
//   items: [ // UserList // required
//     { // UserOutput
//       username: "STRING_VALUE", // required
//       homeDirectory: "STRING_VALUE", // required
//       description: "STRING_VALUE", // required
//       bucketName: "STRING_VALUE", // required
//       endpoint: "STRING_VALUE", // required
//       lastConnectedDate: "STRING_VALUE",
//     },
//   ],
//   nextPageToken: "STRING_VALUE",
// };

Param

ListUsersCommandInput

Returns

ListUsersCommandOutput

See

• ListUsersCommandInput for command's input shape.
• ListUsersCommandOutput 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.