@aws-sdk/client-transfer-browser
Description
AWS Transfer for SFTP is a fully managed service that enables the transfer of files directly into and out of Amazon S3 using the Secure File Transfer Protocol (SFTP)—also known as Secure Shell (SSH) File Transfer Protocol. AWS helps you seamlessly migrate your file transfer workflows to AWS Transfer for SFTP—by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53—so nothing changes for your customers and partners, or their applications. With your data in S3, you can use it with AWS services for processing, analytics, machine learning, and archiving. Getting started with AWS Transfer for SFTP (AWS SFTP) is easy; there is no infrastructure to buy and setup.
Installing
To install the this package using NPM, simply type the following into a terminal window:
npm install @aws-sdk/client-transfer-browser
Getting Started
Import
The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(TransferClient
) and the commands you need, for example CreateServerCommand
:
//JavaScript
const {
TransferClient
} = require("@aws-sdk/client-transfer-browser/TransferClient");
const {
CreateServerCommand
} = require("@aws-sdk/client-transfer-browser/commands/CreateServerCommand");
//TypeScript
import { TransferClient } from "@aws-sdk/client-transfer-browser/TransferClient";
import { CreateServerCommand } from "@aws-sdk/client-transfer-browser/commands/CreateServerCommand";
Usage
To send a request, you:
- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the API reference.
- Initiate command with input parameters.
- Call
send
operation on client with command object as input. - If you are using a custom http handler, you may call
destroy()
to close open connections.
const transfer = new TransferClient({ region: "region" });
//clients can be shared by different commands
const params = {};
const createServerCommand = new CreateServerCommand(params);
transfer
.send(createServerCommand)
.then(data => {
// do something
})
.catch(error => {
// error handling
});
In addition to using promises, there are 2 other ways to send a request:
// async/await
try {
const data = await transfer.send(createServerCommand);
// do something
} catch (error) {
// error handling
}
// callback
transfer.send(createServerCommand, (err, data) => {
//do something
});
The SDK can also send requests using the simplified callback style from version 2 of the SDK.
import * as AWS from "@aws-sdk/@aws-sdk/client-transfer-browser/Transfer";
const transfer = new AWS.Transfer({ region: "region" });
transfer.createServer(params, (err, data) => {
//do something
});
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 transfer.send(createServerCommand);
// do something
} catch (error) {
const metadata = error.$metadata;
console.log(
`requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.extendedRequestId}`
);
/*
The keys within exceptions are also parsed. You can access them by specifying exception names:
if(error.name === 'SomeServiceException') {
const value = error.specialKeyInException;
}
*/
}
Getting Help
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.
- Ask a question on StackOverflow and tag it with
aws-sdk-js
- Come join the AWS JavaScript community on gitter
- If it turns out that you may have found a bug, please open an issue
Contributing
This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-transfer-browser' package is updated. To contribute to SDK you can checkout our code generator package.
License
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.