- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
TransferClient
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.
Installation
npm install @aws-sdk/client-transfer
yarn add @aws-sdk/client-transfer
pnpm add @aws-sdk/client-transfer
TransferClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
CreateAccessCommand | Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Transfer Family. For example, a Microsoft Active Directory might contain 50,000 users, but only a small fraction might need the ability to transfer files to the server. An administrator can use |
CreateAgreementCommand | Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an Transfer Family server and an AS2 process. The agreement defines the file and message transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner profile, certificate, and other attributes. The partner is identified with the |
CreateConnectorCommand | Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol. For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server. For more details about connectors, see Configure AS2 connectors and Create SFTP connectors . You must specify exactly one configuration object: either for AS2 ( |
CreateProfileCommand | Creates the local or partner profile to use for AS2 transfers. |
CreateServerCommand | Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated |
CreateUserCommand | Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the |
CreateWebAppCommand | Creates a web app based on specified parameters, and returns the ID for the new web app. |
CreateWorkflowCommand | Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes. After creating a workflow, you can associate the workflow created with any transfer servers by specifying the |
DeleteAccessCommand | Allows you to delete the access specified in the |
DeleteAgreementCommand | Delete the agreement that's specified in the provided |
DeleteCertificateCommand | Deletes the certificate that's specified in the |
DeleteConnectorCommand | Deletes the connector that's specified in the provided |
DeleteHostKeyCommand | Deletes the host key that's specified in the |
DeleteProfileCommand | Deletes the profile that's specified in the |
DeleteServerCommand | Deletes the file transfer protocol-enabled server that you specify. No response returns from this operation. |
DeleteSshPublicKeyCommand | Deletes a user's Secure Shell (SSH) public key. |
DeleteUserCommand | Deletes the user belonging to a file transfer protocol-enabled server you specify. No response returns from this operation. When you delete a user from a server, the user's information is lost. |
DeleteWebAppCommand | Deletes the specified web app. |
DeleteWebAppCustomizationCommand | Deletes the |
DeleteWorkflowCommand | Deletes the specified workflow. |
DescribeAccessCommand | Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its The response from this call returns the properties of the access that is associated with the |
DescribeAgreementCommand | Describes the agreement that's identified by the |
DescribeCertificateCommand | Describes the certificate that's identified by the |
DescribeConnectorCommand | Describes the connector that's identified by the |
DescribeExecutionCommand | You can use This API call only returns details for in-progress workflows. If you provide an ID for an execution that is not in progress, or if the execution doesn't match the specified workflow ID, you receive a |
DescribeHostKeyCommand | Returns the details of the host key that's specified by the |
DescribeProfileCommand | Returns the details of the profile that's specified by the |
DescribeSecurityPolicyCommand | Describes the security policy that is attached to your server or SFTP connector. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors . |
DescribeServerCommand | Describes a file transfer protocol-enabled server that you specify by passing the The response contains a description of a server's properties. When you set |
DescribeUserCommand | Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its The response from this call returns the properties of the user associated with the |
DescribeWebAppCommand | Describes the web app that's identified by |
DescribeWebAppCustomizationCommand | Describes the web app customization object that's identified by |
DescribeWorkflowCommand | Describes the specified workflow. |
ImportCertificateCommand | Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles. |
ImportHostKeyCommand | Adds a host key to the server that's specified by the |
ImportSshPublicKeyCommand | Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a The response returns the |
ListAccessesCommand | Lists the details for all the accesses you have on your server. |
ListAgreementsCommand | Returns a list of the agreements for the server that's identified by the |
ListCertificatesCommand | Returns a list of the current certificates that have been imported into Transfer Family. If you want to limit the results to a certain number, supply a value for the |
ListConnectorsCommand | Lists the connectors for the specified Region. |
ListExecutionsCommand | Lists all in-progress executions for the specified workflow. If the specified workflow ID cannot be found, |
ListFileTransferResultsCommand | Returns real-time updates and detailed information on the status of each individual file being transferred in a specific file transfer operation. You specify the file transfer by providing its File transfer results are available up to 7 days after an operation has been requested. |
ListHostKeysCommand | Returns a list of host keys for the server that's specified by the |
ListProfilesCommand | Returns a list of the profiles for your system. If you want to limit the results to a certain number, supply a value for the |
ListSecurityPoliciesCommand | Lists the security policies that are attached to your servers and SFTP connectors. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors . |
ListServersCommand | Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account. |
ListTagsForResourceCommand | Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role. |
ListUsersCommand | Lists the users for a file transfer protocol-enabled server that you specify by passing the |
ListWebAppsCommand | Lists all web apps associated with your Amazon Web Services account for your current region. |
ListWorkflowsCommand | Lists all workflows associated with your Amazon Web Services account for your current region. |
SendWorkflowStepStateCommand | Sends a callback for asynchronous custom steps. The |
StartDirectoryListingCommand | Retrieves a list of the contents of a directory from a remote SFTP server. You specify the connector ID, the output path, and the remote directory path. You can also specify the optional After you receive the listing file, you can provide the files that you want to transfer to the The naming convention for the output file is
|
StartFileTransferCommand | Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.
|
StartServerCommand | Changes the state of a file transfer protocol-enabled server from The state of No response is returned from this call. |
StopServerCommand | Changes the state of a file transfer protocol-enabled server from Stopping the server does not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed. The state of No response is returned from this call. |
TagResourceCommand | Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities. There is no response returned from this call. |
TestConnectionCommand | Tests whether your SFTP connector is set up successfully. We highly recommend that you call this operation to test your ability to transfer files between local Amazon Web Services storage and a trading partner's SFTP server. |
TestIdentityProviderCommand | If the The Note the following:
|
UntagResourceCommand | Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities. No response is returned from this call. |
UpdateAccessCommand | Allows you to update parameters for the access specified in the |
UpdateAgreementCommand | Updates some of the parameters for an existing agreement. Provide the |
UpdateCertificateCommand | Updates the active and inactive dates for a certificate. |
UpdateConnectorCommand | Updates some of the parameters for an existing connector. Provide the |
UpdateHostKeyCommand | Updates the description for the host key that's specified by the |
UpdateProfileCommand | Updates some of the parameters for an existing profile. Provide the |
UpdateServerCommand | Updates the file transfer protocol-enabled server's properties after that server has been created. The |
UpdateUserCommand | Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the The response returns the In the console, you can select Restricted when you create or update a user. This ensures that the user can't access anything outside of their home directory. The programmatic way to configure this behavior is to update the user. Set their For example, if the user's home directory is |
UpdateWebAppCommand | Assigns new properties to a web app. You can modify the access point, identity provider details, and the web app units. |
UpdateWebAppCustomizationCommand | Assigns new customization properties to a web app. You can modify the icon file, logo file, and title. |
TransferClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: TransferClientConfig