@stedi/sdk-client-sftp

@stedi/sdk-client-sftp

Description

Stedi Sftp SDK for JavaScript.

Stedi SFTP provides a fully managed, serverless SFTP infrastructure. You can use the SFTP API to manage SFTP users.

For accessing files programmatically, you should use the Stedi Buckets SDK.

Installing

To install the this package, simply type add or install @stedi/sdk-client-sftp using your favorite package manager:

• npm install @stedi/sdk-client-sftp
• yarn add @stedi/sdk-client-sftp
• pnpm add @stedi/sdk-client-sftp

Getting Started

Initialize the client

First, create a new SftpClient.

import { SftpClient, CreateUserCommand } from "@stedi/sdk-client-sftp";

const client = new SftpClient({
  region: "us",
  apiKey: "my-api-key",
});

Usage

Once the client is initiated, you may use it to send multiple commands. If you are using a custom http handler, you may call destroy() to close open connections.

Create a command by creating a new CreateUserCommand.

import { SftpClient, CreateUserCommand } from "@stedi/sdk-client-sftp";

const client = new SftpClient({
  region: "us",
  apiKey: "my-api-key",
});

const params = {
  /** input parameters */
};

const command = new CreateUserCommand(params);

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by checking if it is a certain instance of exception:
   * if (error instanceof SomeServiceException) {
   *     const value = error.specialKeyInException;
   * }
   */
}

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

CreateUser

Command API Reference / Input / Output

DeleteUser

Command API Reference / Input / Output

ListUsers

Command API Reference / Input / Output

ReadUser

Command API Reference / Input / Output

UpdateUser

Command API Reference / Input / Output