@aws-sdk/client-transfer

Description

AWS SDK for JavaScript Transfer Client for Node.js, Browser and React Native.

Transfer Family is a fully managed service that enables the transfer of files over the File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3) or Amazon EFS. Additionally, you can use Applicability Statement 2 (AS2) to transfer files into and out of Amazon S3. Amazon Web Services helps you seamlessly migrate your file transfer workflows to Transfer Family 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 Amazon S3, you can use it with Amazon Web Services services for processing, analytics, machine learning, and archiving. Getting started with Transfer Family is easy since there is no infrastructure to buy and set up.

Installing

To install this package, simply type add or install @aws-sdk/client-transfer
using your favorite package manager:
- npm install @aws-sdk/client-transfer
- yarn add @aws-sdk/client-transfer
- pnpm add @aws-sdk/client-transfer

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the TransferClient and
the commands you need, for example ListServersCommand:

``js
// ES5 example
const { TransferClient, ListServersCommand } = require("@aws-sdk/client-transfer");
`

`ts
// ES6+ example
import { TransferClient, ListServersCommand } from "@aws-sdk/client-transfer";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- 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.

`js
// a client can be shared by different commands.
const client = new TransferClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListServersCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

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

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-transfer";
const client = new AWS.Transfer({ region: "REGION" });

// async/await.
try {
const data = await client.listServers(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listServers(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listServers(params, (err, data) => {
// process err and data.
});
`

$3

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

`js
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 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, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-transfer` package is updated.
To contribute to client you can check our generate clients scripts.

License

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

Client Commands (Operations List)

CreateAccess

Command API Reference / Input / Output

CreateAgreement

Command API Reference / Input / Output

CreateConnector

Command API Reference / Input / Output

CreateProfile

Command API Reference / Input / Output

CreateServer

Command API Reference / Input / Output

CreateUser

Command API Reference / Input / Output

CreateWebApp

Command API Reference / Input / Output

CreateWorkflow

Command API Reference / Input / Output

DeleteAccess

Command API Reference / Input / Output

DeleteAgreement

Command API Reference / Input / Output

DeleteCertificate

Command API Reference / Input / Output

DeleteConnector

Command API Reference / Input / Output

DeleteHostKey

Command API Reference / Input / Output

DeleteProfile

Command API Reference / Input / Output

DeleteServer

Command API Reference / Input / Output

DeleteSshPublicKey

Command API Reference / Input / Output

DeleteUser

Command API Reference / Input / Output

DeleteWebApp

Command API Reference / Input / Output

DeleteWebAppCustomization

Command API Reference / Input / Output

DeleteWorkflow

Command API Reference / Input / Output

DescribeAccess

Command API Reference / Input / Output

DescribeAgreement

Command API Reference / Input / Output

DescribeCertificate

Command API Reference / Input / Output

DescribeConnector

Command API Reference / Input / Output

DescribeExecution

Command API Reference / Input / Output

DescribeHostKey

Command API Reference / Input / Output

DescribeProfile

Command API Reference / Input / Output

DescribeSecurityPolicy

Command API Reference / Input / Output

DescribeServer

Command API Reference / Input / Output

DescribeUser

Command API Reference / Input / Output

DescribeWebApp

Command API Reference / Input / Output

DescribeWebAppCustomization

Command API Reference / Input / Output

DescribeWorkflow

Command API Reference / Input / Output

ImportCertificate

Command API Reference / Input / Output

ImportHostKey

Command API Reference / Input / Output

ImportSshPublicKey

Command API Reference / Input / Output

ListAccesses

Command API Reference / Input / Output

ListAgreements

Command API Reference / Input / Output

ListCertificates

Command API Reference / Input / Output

ListConnectors

Command API Reference / Input / Output

ListExecutions

Command API Reference / Input / Output

ListFileTransferResults

Command API Reference / Input / Output

ListHostKeys

Command API Reference / Input / Output

ListProfiles

Command API Reference / Input / Output

ListSecurityPolicies

Command API Reference / Input / Output

ListServers

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListUsers

Command API Reference / Input / Output

ListWebApps

Command API Reference / Input / Output

ListWorkflows

Command API Reference / Input / Output

SendWorkflowStepState

Command API Reference / Input / Output

StartDirectoryListing

Command API Reference / Input / Output

StartFileTransfer

Command API Reference / Input / Output

StartRemoteDelete

Command API Reference / Input / Output

StartRemoteMove

Command API Reference / Input / Output

StartServer

Command API Reference / Input / Output

StopServer

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

TestConnection

Command API Reference / Input / Output

TestIdentityProvider

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateAccess

Command API Reference / Input / Output

UpdateAgreement

Command API Reference / Input / Output

UpdateCertificate

Command API Reference / Input / Output

UpdateConnector

Command API Reference / Input / Output

UpdateHostKey

Command API Reference / Input / Output

UpdateProfile

Command API Reference / Input / Output

UpdateServer

Command API Reference / Input / Output

UpdateUser

Command API Reference / Input / Output

UpdateWebApp

Command API Reference / Input / Output

UpdateWebAppCustomization

Command API Reference / Input / Output