AWS Transfer Family
Transfer Family offers fully managed support for the transfer of files over SFTP, AS2, FTPS, FTP, and web browser-based transfers directly into and out of…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Transfer Family offers fully managed support for the transfer of files over SFTP, AS2, FTPS, FTP, and web browser-based transfers directly into and out of Amazon Web Services storage services. File transfer protocols are used in data exchange workflows across different industries such as financial services, healthcare, advertising, and retail, among others. Transfer Family simplifies the migration of file transfer workflows to Amazon Web Services. To use the Transfer Family service, you instantiate a server in the Amazon Web Services Region of your choice. You can create the server, list available servers, and update and delete servers. The server is the entity that requests file operations from Transfer Family. Servers have a number of important properties. The server is a named instance as identified by a system assigned ServerId identifier. You can optionally assign a hostname, or even a custom hostname to a server. The service bills for any instantiated servers (even ones OFFLINE ), and for the amount of data transferred. Users must be known to the server that requests file operations. A user as identified by their username is assigned to a server. Usernames are used to authenticate requests. A server can have only one authentication method: AWS_DIRECTORY_SERVICE , SERVICE_MANAGED , AWS_LAMBDA , or API_GATEWAY . Transfer Family also supports web applications that provide browser-based file transfer capabilities. Web applications can be configured with VPC endpoints to enable secure, private connectivity within your Virtual Private Cloud (VPC). This allows you to control network access and route traffic through your VPC infrastructure while maintaining the managed benefits of Transfer Family. This API interface reference for Transfer Family contains documentation for a programming interface that you can use to manage Transfer Family. The reference structure is as follows: For the alphabetical list of API actions, see . For the alphabetical list of data types, see . For a list of common query parameters, see CommonParameters . For descriptions of the error codes, see CommonErrors . Rather than actually running a command, you can use the --generate-cli-skeleton parameter with any API call to generate and display a parameter template. You can then use the generated template to customize and use as input on a later command. For details, see Generate and use a parameter skeleton file .
Endpoints 71
Agreement
- POSTCreate agreement
/#X-Amz-Target=TransferService.CreateAgreementCreates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an Transfer Family server and an AS2 process. The… - POSTDelete agreement
/#X-Amz-Target=TransferService.DeleteAgreementDelete the agreement that's specified in the provided AgreementId . - POSTDescribe agreement
/#X-Amz-Target=TransferService.DescribeAgreementDescribes the agreement that's identified by the AgreementId . - POSTList agreements
/#X-Amz-Target=TransferService.ListAgreementsReturns a list of the agreements for the server that's identified by the ServerId that you supply. If you want to limit the results to a certain number,… - POSTUpdate agreement
/#X-Amz-Target=TransferService.UpdateAgreementUpdates some of the parameters for an existing agreement. Provide the AgreementId and the ServerId for the agreement that you want to update, along with the…
Connector
- POSTCreate connector
/#X-Amz-Target=TransferService.CreateConnectorCreates 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… - POSTDelete connector
/#X-Amz-Target=TransferService.DeleteConnectorDeletes the connector that's specified in the provided ConnectorId . - POSTDescribe connector
/#X-Amz-Target=TransferService.DescribeConnectorDescribes the connector that's identified by the ConnectorId. - POSTList connectors
/#X-Amz-Target=TransferService.ListConnectorsLists the connectors for the specified Region. - POSTUpdate connector
/#X-Amz-Target=TransferService.UpdateConnectorUpdates some of the parameters for an existing connector. Provide the ConnectorId for the connector that you want to update, along with the new values for the…
Profile
- POSTCreate profile
/#X-Amz-Target=TransferService.CreateProfileCreates the local or partner profile to use for AS2 transfers. - POSTDelete profile
/#X-Amz-Target=TransferService.DeleteProfileDeletes the profile that's specified in the ProfileId parameter. - POSTDescribe profile
/#X-Amz-Target=TransferService.DescribeProfileReturns the details of the profile that's specified by the ProfileId . - POSTList profiles
/#X-Amz-Target=TransferService.ListProfilesReturns a list of the profiles for your system. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran… - POSTUpdate profile
/#X-Amz-Target=TransferService.UpdateProfileUpdates some of the parameters for an existing profile. Provide the ProfileId for the profile that you want to update, along with the new values for the…
Server
- POSTCreate server
/#X-Amz-Target=TransferService.CreateServerInstantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services. When you make updates to your file transfer… - POSTDelete server
/#X-Amz-Target=TransferService.DeleteServerDeletes the file transfer protocol-enabled server that you specify. No response returns from this operation. - POSTDescribe server
/#X-Amz-Target=TransferService.DescribeServerDescribes a file transfer protocol-enabled server that you specify by passing the ServerId parameter. The response contains a description of a server's… - POSTList servers
/#X-Amz-Target=TransferService.ListServersLists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account. - POSTUpdate server
/#X-Amz-Target=TransferService.UpdateServerUpdates the file transfer protocol-enabled server's properties after that server has been created. The UpdateServer call returns the ServerId of the server…
User
- POSTCreate user
/#X-Amz-Target=TransferService.CreateUserCreates 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… - POSTDelete user
/#X-Amz-Target=TransferService.DeleteUserDeletes 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… - POSTDescribe user
/#X-Amz-Target=TransferService.DescribeUserDescribes the user assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property. The response from this call returns… - POSTList users
/#X-Amz-Target=TransferService.ListUsersLists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter. - POSTUpdate user
/#X-Amz-Target=TransferService.UpdateUserAssigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName and ServerId…
Web app
- POSTCreate web app
/#X-Amz-Target=TransferService.CreateWebAppCreates a web app based on specified parameters, and returns the ID for the new web app. You can configure the web app to be publicly accessible or hosted… - POSTDelete web app
/#X-Amz-Target=TransferService.DeleteWebAppDeletes the specified web app. - POSTDescribe web app
/#X-Amz-Target=TransferService.DescribeWebAppDescribes the web app that's identified by WebAppId . The response includes endpoint configuration details such as whether the web app is publicly accessible… - POSTList web apps
/#X-Amz-Target=TransferService.ListWebAppsLists all web apps associated with your Amazon Web Services account for your current region. The response includes the endpoint type for each web app, showing… - POSTUpdate web app
/#X-Amz-Target=TransferService.UpdateWebAppAssigns new properties to a web app. You can modify the access point, identity provider details, endpoint configuration, and the web app units. For more…
Workflow
- POSTCreate workflow
/#X-Amz-Target=TransferService.CreateWorkflowAllows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes. After creating a workflow, you can… - POSTDelete workflow
/#X-Amz-Target=TransferService.DeleteWorkflowDeletes the specified workflow. - POSTDescribe workflow
/#X-Amz-Target=TransferService.DescribeWorkflowDescribes the specified workflow. - POSTList workflows
/#X-Amz-Target=TransferService.ListWorkflowsLists all workflows associated with your Amazon Web Services account for your current region.
Certificate
- POSTDelete certificate
/#X-Amz-Target=TransferService.DeleteCertificateDeletes the certificate that's specified in the CertificateId parameter. - POSTDescribe certificate
/#X-Amz-Target=TransferService.DescribeCertificateDescribes the certificate that's identified by the CertificateId . Transfer Family automatically publishes a Amazon CloudWatch metric called DaysUntilExpiry… - POSTImport certificate
/#X-Amz-Target=TransferService.ImportCertificateImports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles. You can import both the certificate and its… - POSTList certificates
/#X-Amz-Target=TransferService.ListCertificatesReturns 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… - POSTUpdate certificate
/#X-Amz-Target=TransferService.UpdateCertificateUpdates the active and inactive dates for a certificate.
Web app customization
- POSTDelete web app customization
/#X-Amz-Target=TransferService.DeleteWebAppCustomizationDeletes the WebAppCustomization object that corresponds to the web app ID specified. - POSTDescribe web app customization
/#X-Amz-Target=TransferService.DescribeWebAppCustomizationDescribes the web app customization object that's identified by WebAppId . - POSTUpdate web app customization
/#X-Amz-Target=TransferService.UpdateWebAppCustomizationAssigns new customization properties to a web app. You can modify the icon file, logo file, and title.
- POSTCreate access
/#X-Amz-Target=TransferService.CreateAccessUsed by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Transfer… - POSTDelete access
/#X-Amz-Target=TransferService.DeleteAccessAllows you to delete the access specified in the ServerID and ExternalID parameters. - POSTDelete host key
/#X-Amz-Target=TransferService.DeleteHostKeyDeletes the host key that's specified in the HostKeyId parameter. - POSTDelete ssh public key
/#X-Amz-Target=TransferService.DeleteSshPublicKeyDeletes a user's Secure Shell (SSH) public key. - POSTDescribe access
/#X-Amz-Target=TransferService.DescribeAccessDescribes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property and its ExternalId . The… - POSTDescribe execution
/#X-Amz-Target=TransferService.DescribeExecutionYou can use DescribeExecution to check the details of the execution of the specified workflow. This API call only returns details for in-progress workflows.… - POSTDescribe host key
/#X-Amz-Target=TransferService.DescribeHostKeyReturns the details of the host key that's specified by the HostKeyId and ServerId . - POSTDescribe security policy
/#X-Amz-Target=TransferService.DescribeSecurityPolicyDescribes the security policy that is attached to your server or SFTP connector. The response contains a description of the security policy's properties. For… - POSTImport host key
/#X-Amz-Target=TransferService.ImportHostKeyAdds a host key to the server that's specified by the ServerId parameter. - POSTImport ssh public key
/#X-Amz-Target=TransferService.ImportSshPublicKeyAdds a Secure Shell (SSH) public key to a Transfer Family user identified by a UserName value assigned to the specific file transfer protocol-enabled server,… - POSTList accesses
/#X-Amz-Target=TransferService.ListAccessesLists the details for all the accesses you have on your server. - POSTList executions
/#X-Amz-Target=TransferService.ListExecutionsLists all in-progress executions for the specified workflow. If the specified workflow ID cannot be found, ListExecutions returns a ResourceNotFound exception. - POSTList file transfer results
/#X-Amz-Target=TransferService.ListFileTransferResultsReturns real-time updates and detailed information on the status of each individual file being transferred in a specific file transfer operation. You specify… - POSTList host keys
/#X-Amz-Target=TransferService.ListHostKeysReturns a list of host keys for the server that's specified by the ServerId parameter. - POSTList security policies
/#X-Amz-Target=TransferService.ListSecurityPoliciesLists the security policies that are attached to your servers and SFTP connectors. For more information about security policies, see Working with security… - POSTList tags for resource
/#X-Amz-Target=TransferService.ListTagsForResourceLists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role. - POSTSend workflow step state
/#X-Amz-Target=TransferService.SendWorkflowStepStateSends a callback for asynchronous custom steps. The ExecutionId , WorkflowId , and Token are passed to the target resource during execution of a custom step… - POSTStart directory listing
/#X-Amz-Target=TransferService.StartDirectoryListingRetrieves 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… - POSTStart file transfer
/#X-Amz-Target=TransferService.StartFileTransferBegins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server. For an AS2 connector, you specify the ConnectorId and one or… - POSTStart remote delete
/#X-Amz-Target=TransferService.StartRemoteDeleteDeletes a file or directory on the remote SFTP server. - POSTStart remote move
/#X-Amz-Target=TransferService.StartRemoteMoveMoves or renames a file or directory on the remote SFTP server. - POSTStart server
/#X-Amz-Target=TransferService.StartServerChanges the state of a file transfer protocol-enabled server from OFFLINE to ONLINE . It has no impact on a server that is already ONLINE . An ONLINE server… - POSTStop server
/#X-Amz-Target=TransferService.StopServerChanges the state of a file transfer protocol-enabled server from ONLINE to OFFLINE . An OFFLINE server cannot accept and process file transfer jobs.… - POSTTag resource
/#X-Amz-Target=TransferService.TagResourceAttaches 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… - POSTTest connection
/#X-Amz-Target=TransferService.TestConnectionTests whether your SFTP connector is set up successfully. We highly recommend that you call this operation to test your ability to transfer files between… - POSTTest identity provider
/#X-Amz-Target=TransferService.TestIdentityProviderIf the IdentityProviderType of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE or API_Gateway , tests whether your identity provider is set… - POSTUntag resource
/#X-Amz-Target=TransferService.UntagResourceDetaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities. No… - POSTUpdate access
/#X-Amz-Target=TransferService.UpdateAccessAllows you to update parameters for the access specified in the ServerID and ExternalID parameters. - POSTUpdate host key
/#X-Amz-Target=TransferService.UpdateHostKeyUpdates the host key that's specified by the ServerId and HostKeyId parameters. You can update the description of the host key, change where the host key is…
API details
- Base URL
https://transfer.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 71 operations on 71 pathsPOST 71
- Main resources
- Agreement 5Certificate 5Connector 5Profile 5Server 5User 5Web app 5Workflow 4Web app customization 3
- Description format
- AWS Smithy model, API version
2018-11-05 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS Transfer Family in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Transfer Family collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Create agreement” (POST /#X-Amz-Target=TransferService.CreateAgreement), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS Transfer Family?
Transfer Family offers fully managed support for the transfer of files over SFTP, AS2, FTPS, FTP, and web browser-based transfers directly into and out of… It is listed under Developer tools and has 71 endpoints.
Who publishes the AWS Transfer Family?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS Transfer Family?
Requests go to https://transfer.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS Transfer Family?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS Transfer Family have?
71 operations on 71 paths (71 POST). The largest groups are Agreement, Certificate, Connector, Profile.
Is forking the AWS Transfer Family free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.