Expand description
AWS Transfer Family is a fully managed service that enables the transfer of files over the 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). AWS helps you seamlessly migrate your file transfer workflows to AWS 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 AWS services for processing, analytics, machine learning, and archiving. Getting started with AWS Transfer Family is easy since there is no infrastructure to buy and set up.
If you’re using the service, you’re probably looking for TransferClient and Transfer.
Structs§
- Create
Server Request - Create
Server Response - Create
User Request - Create
User Response - Delete
Server Request - Delete
SshPublic KeyRequest - Delete
User Request - Describe
Server Request - Describe
Server Response - Describe
User Request - Describe
User Response - Described
Server Describes the properties of a file transfer protocol-enabled server that was specified. Information returned includes the following: the server Amazon Resource Name (ARN), the certificate ARN (if the FTPS protocol was selected), the endpoint type and details, the authentication configuration and type, the logging role, the file transfer protocol or protocols, the server ID and state, and assigned tags or metadata.
- Described
User Returns properties of the user that you want to describe.
- Endpoint
Details The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server and resources only within your VPC. To control incoming internet traffic, invoke the
UpdateServerAPI and attach an Elastic IP to your server's endpoint.- Home
Directory MapEntry Represents an object that contains entries and a targets for
HomeDirectoryMappings.- Identity
Provider Details Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled server's users. A server can have only one method of authentication.
- Import
SshPublic KeyRequest - Import
SshPublic KeyResponse Identifies the user, the file transfer protocol-enabled server they belong to, and the identifier of the SSH public key associated with that user. A user can have more than one key on each server that they are associated with.
- List
Servers Request - List
Servers Response - List
Tags ForResource Request - List
Tags ForResource Response - List
Users Request - List
Users Response - Listed
Server Returns properties of a file transfer protocol-enabled server that was specified.
- Listed
User Returns properties of the user that you specify.
- SshPublic
Key Provides information about the public Secure Shell (SSH) key that is associated with a user account for the specific file transfer protocol-enabled server (as identified by
ServerId). The information returned includes the date the key was imported, the public key contents, and the public key ID. A user can store more than one SSH public key associated with their user name on a specific server.- Start
Server Request - Stop
Server Request - Tag
Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called
Groupand assign the valuesResearchandAccountingto that group.- TagResource
Request - Test
Identity Provider Request - Test
Identity Provider Response - Transfer
Client - A client for the AWS Transfer API.
- Untag
Resource Request - Update
Server Request - Update
Server Response - Update
User Request - Update
User Response UpdateUserResponsereturns the user name and file transfer protocol-enabled server identifier for the request to update a user's properties.
Enums§
- Create
Server Error - Errors returned by CreateServer
- Create
User Error - Errors returned by CreateUser
- Delete
Server Error - Errors returned by DeleteServer
- Delete
SshPublic KeyError - Errors returned by DeleteSshPublicKey
- Delete
User Error - Errors returned by DeleteUser
- Describe
Server Error - Errors returned by DescribeServer
- Describe
User Error - Errors returned by DescribeUser
- Import
SshPublic KeyError - Errors returned by ImportSshPublicKey
- List
Servers Error - Errors returned by ListServers
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- List
Users Error - Errors returned by ListUsers
- Start
Server Error - Errors returned by StartServer
- Stop
Server Error - Errors returned by StopServer
- TagResource
Error - Errors returned by TagResource
- Test
Identity Provider Error - Errors returned by TestIdentityProvider
- Untag
Resource Error - Errors returned by UntagResource
- Update
Server Error - Errors returned by UpdateServer
- Update
User Error - Errors returned by UpdateUser
Traits§
- Transfer
- Trait representing the capabilities of the AWS Transfer API. AWS Transfer clients implement this trait.