AWS transfer documentation change
Summary
Restructured SFTP connector documentation by removing detailed sections about quotas, scaling, and usage examples, replacing them with links to dedicated pages. Updated overview description to include additional capabilities like file management operations.
Security assessment
The changes primarily reorganize existing content and remove implementation details to external pages. No security vulnerabilities, credential handling changes, or access control modifications are mentioned. The removed quota details about Secrets Manager secret lengths are operational limits rather than security controls.
Diff
diff --git a/transfer/latest/userguide/creating-connectors.md b/transfer/latest/userguide/creating-connectors.md index 2f7d1d6b3..c6b80e36d 100644 --- a//transfer/latest/userguide/creating-connectors.md +++ b//transfer/latest/userguide/creating-connectors.md @@ -5,2 +4,0 @@ -Quotas for SFTP connectorsScaling your SFTP connectorsUsing your connector - @@ -9 +7 @@ Quotas for SFTP connectorsScaling your SFTP connectorsUsing your connector -AWS Transfer Family SFTP connectors establish a relationship for sending files and messages between Amazon storage and an external partner, using the SFTP protocol. You can send files from Amazon S3 to an external, partner-owned destination. You can also use an SFTP connector to retrieve files from a partner's SFTP server. +An AWS Transfer Family SFTP connector establishes a connection with a remote SFTP server to transfer files between Amazon storage and a remote server, using the SFTP protocol. You can send files from Amazon S3 to an external, partner-owned SFTP server, retrieve files from a partner's SFTP server to Amazon S3 or list, delete, rename or move files on the remote server. Using SFTP connectors, you can build automated, event-driven file transfer workflows in AWS . @@ -19,122 +17 @@ The following video provides a brief introduction to Transfer Family SFTP connec - * [Configure SFTP connectors](./configure-sftp-connector.html) - - * [Using SFTP connectors and tracking their progress](./transfer-sftp-connectors.html) - - * [List contents of a remote directory](./sftp-connector-list-dir.html) - - * [Manage SFTP connectors](./manage-sftp-connectors.html) - - * [Reference architectures](./reference-architectures.html) - - * Quotas for SFTP connectors - - * Scaling your SFTP connectors - - * Using your connector - - - - -## Quotas for SFTP connectors - -The following quotas are in place for SFTP connectors. - -###### Note - -More service quotas for SFTP connectors are listed in [AWS Transfer Family endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/transfer-service.html) in the _Amazon Web Services General Reference_. - -SFTP connector quotas Name | Default | Adjustable ----|---|--- -Maximum test connection transactions per second (TPS) | 1 request per second, per account | No -Maximum queue size for pending file transfers | 1000 | No -Maximum file size | 150 gibibytes (GiB) | No -Maximum transfer time per file | 12 hours | No -Maximum request wait time per file | 12 hours | No -Maximum bandwidth for connectors per account (both SFTP and AS2 connectors contribute to this value) | 50 MBps | No -Maximum number of items for directory listing operations | 10,000 | No -Maximum number of files per `StartFileTransfer` request | 10 | No - -###### Note - -By default, SFTP connectors process one file at a time, transferring files sequentially. You have an option to accelerate transfer performance by having your connectors create concurrent sessions with remote servers that support concurrent sessions from the same user, and process up to 5 files in parallel. - -To enable concurrent connections for any connector, contact AWS Support at [Contact AWS](https://aws.amazon.com/contact-us) to submit a quota increase request to the AWS Transfer Family service team. - -For storing the credentials for SFTP connectors, there are quotas associated with each Secrets Manager secret. If you use the same secret to store multiple types of keys, for multiple purposes, you may encounter these quotas. - - * Total length for a single secret: 12,000 characters - - * Maximum length of the `Password` string: 1024 characters - - * Maximum length of the `PrivateKey` string: 8192 characters - - * Maximum length of the `Username` string: 100 characters - - - - -## Scaling your SFTP connectors - -This section describes considerations for how to scale your AWS Transfer Family SFTP connector workloads. You need to take into account the following three quotas that apply when you want to scale your workloads with SFTP connectors. - - * **The maximum queue size.** This refers to the maximum number of pending operations in a connector’s queue that have been requested. A pending operation refers to any previously submitted transfer request that has not yet completed, either successfully or unsuccessfully. - -The maximum queue depth for pending requests is currently set at 1,000 per connector (as defined in [AWS Transfer Family service quotas](https://docs.aws.amazon.com/general/latest/gr/transfer-service.html)). Your workloads may exceed this service limit when you request thousands of transfer operations over a short duration, and you will receive a `ThrottlingException` with the message **`Exceeded maximum pending requests.`** If your workloads are subject to this quota, contact the Transfer Family service team via AWS Support or your account team to discuss your scalability requirements. - -You can also take either or both of the following actions. - - * Distribute your file volumes across multiple connectors. - - * Have your connectors create concurrent sessions with the remote server to process multiple requests from the queue in parallel. - - * **The number of concurrent sessions.** By default, an SFTP connector transfers one file at a time, transferring files sequentially from its queue. - -You have an option to accelerate transfer performance by having your connectors transfer multiple files in parallel. You can create concurrent sessions with remote servers that support concurrent sessions from the same user, and process up to 5 files in parallel. When you create an SFTP connector, choose a value up to 5 for the **Maximum concurrent connections** setting when you create or update the connector. For details, see [Create an SFTP connector](./configure-sftp-connector.html#create-sftp-connector-procedure). - - * **The rate of`StartFileTransfer` requests.** You can request up to 100 file paths per second for transfer with each SFTP connector. The requested file paths are added to your connectors’ queue for processing. You can use the `StartFileTransfer` command recursively to request up to 100 file paths per second per connector, irrespective of the number of files provided in an individual `StartFileTransfer` command. - - - - -## Using your connector - -On the page where you can view the details for a connector, Transfer Family displays some useful example commands. - -###### To view connector details - - 1. Open the AWS Transfer Family console at [https://console.aws.amazon.com/transfer/](https://console.aws.amazon.com/transfer/). - - 2. In the left navigation pane, choose **Connectors**. - - 3. Choose the identifier in the **Connector ID** column to see the details page for the selected connector. - - - - -The following example commands are listed. - - * Command to test connectivity - - aws transfer test-connection --region us-east-1 --connector-id c-1111aaaa2222bbbb3 - - * Command to list files from a remote SFTP server - - aws transfer start-directory-listing --region us-east-1 --connector-id c-1111aaaa2222bbbb3 --remote-directory-path /RemoteDir \ - --output-directory-path /amzn-s3-demo-destination-bucket/prefix - - * Command to retrieve files from a remote SFTP server - - aws transfer start-file-transfer --region us-east-1 --connector-id c-1111aaaa2222bbbb3 --retrieve-file-paths /RemoteDir/file1.txt \ - --local-directory-path /amzn-s3-demo-destination-bucket/prefix - - * Command to send a file from Amazon S3 to a remote SFTP server - - aws transfer start-file-transfer --region us-east-1 --connector-id c-1111aaaa2222bbbb3 \ - --send-file-paths /amzn-s3-demo-source-bucket/file1.txt --remote-directory-path /RemoteDir - - * Command to delete a file on the remote server - - aws transfer start-remote-delete --connector-id c-AAAA1111BBBB2222C \ - --delete-path /RemoteDir/file1.txt - - * Command to move and rename a file on the remote server + * [Creating SFTP connectors](./configure-sftp-connector.html) @@ -142,2 +19 @@ The following example commands are listed. - aws transfer --connector-id c-AAAA1111BBBB2222C start-remote-move \ - --source-path /RemoteSourceDir/file1.txt --target-path /RemoteTargetDir/file2.txt + * [Using SFTP connectors](./transfer-sftp-connectors.html) @@ -145 +21 @@ The following example commands are listed. - * Command to query the real-time status of a file transfer operation using the specified connector + * [Monitoring SFTP connectors](./track-connector-progress.html) @@ -147,2 +23 @@ The following example commands are listed. - aws transfer list-file-transfer-results --region us-east-1 --connector-id c-1111aaaa2222bbbb3 \ - --transfer-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 + * [Managing SFTP connectors](./manage-sftp-connectors.html) @@ -149,0 +25 @@ The following example commands are listed. + * [Scaling and quotas for SFTP connectors](./scale-and-limits-sftp-connector.html) @@ -150,0 +27 @@ The following example commands are listed. + * [Reference architectures using SFTP connectors](./reference-architectures.html) @@ -153 +29,0 @@ The following example commands are listed. -Note that you can easily copy the example commands to the clipboard, by selecting the corresponding **Copy to clipboard** button. @@ -155 +30,0 @@ Note that you can easily copy the example commands to the clipboard, by selectin - @@ -165 +40 @@ End user instructions -Configure SFTP connectors +Creating SFTP connectors