AWS transfer documentation change
Summary
Restructured SFTP connector documentation to focus on supported operations and topic organization. Removed detailed API command examples and moved operational guidance to subtopics. Added bullet-point list of capabilities and consolidated connector limitations note.
Security assessment
Changes are organizational/structural improvements without introducing new security controls or addressing vulnerabilities. The note about requiring internet-accessible endpoints remains unchanged. No evidence of patching vulnerabilities or adding security features.
Diff
diff --git a/transfer/latest/userguide/transfer-sftp-connectors.md b/transfer/latest/userguide/transfer-sftp-connectors.md index 76c2c0710..d1d16d1e0 100644 --- a//transfer/latest/userguide/transfer-sftp-connectors.md +++ b//transfer/latest/userguide/transfer-sftp-connectors.md @@ -5 +5 @@ -Send and retrieve files by using an SFTP connectorMove or rename files or directories on the remote SFTP serverDelete files or directories on the remote SFTP serverTrack the progress of your file transfer requests +# Using SFTP connectors @@ -7 +7 @@ Send and retrieve files by using an SFTP connectorMove or rename files or direct -# Using SFTP connectors and tracking their progress +This topic describes how to perform the supported file operations using your SFTP connector. You can also find example commands to perform these operations by selecting your connector's details on the AWS Transfer Family console at [https://console.aws.amazon.com/transfer/](https://console.aws.amazon.com/transfer/). @@ -9 +9 @@ Send and retrieve files by using an SFTP connectorMove or rename files or direct -SFTP connectors extend the capabilities of AWS Transfer Family to communicate with remote servers both in the cloud and on-premises. You can integrate data that's generated and stored in remote sources with your AWS hosted data warehouses for analytics, business applications, reporting, and auditing. To initiate a file transfer to a remote SFTP server, you use the [StartFileTransfer](https://docs.aws.amazon.com/transfer/latest/APIReference/API_StartFileTransfer.html) API operation, which uses SFTP connectors to perform the transfer. +After you have created an SFTP connector, you can use it to perform the following file operations on the remote SFTP server that it's associated with. @@ -11 +11 @@ SFTP connectors extend the capabilities of AWS Transfer Family to communicate wi -You can monitor your file transfers by running the [ListFileTransferResults](https://docs.aws.amazon.com/transfer/latest/APIReference/API_ListFileTransferResults.html) API operation, or by checking your server logs. Connector activity is logged to log streams that have the format of `aws/transfer/`connector-id``, for example, `aws/transfer/c-1234567890abcdef0`. If you don't see any logs for your connector, make sure that you have specified a logging role with the correct permissions for your connector. + * Send files from Amazon S3 to the remote SFTP server. @@ -13 +13 @@ You can monitor your file transfers by running the [ListFileTransferResults](htt -For details on creating connectors, see [Configure SFTP connectors](./configure-sftp-connector.html). + * Retrieve files from the remote SFTP server to Amazon S3. @@ -15,42 +15 @@ For details on creating connectors, see [Configure SFTP connectors](./configure- -###### Note - -Currently, SFTP connectors can only be used to connect to remote SFTP servers that offer an internet-accessible endpoint. - -## Send and retrieve files by using an SFTP connector - -To send and retrieve files by using an SFTP connector, you use the [StartFileTransfer](https://docs.aws.amazon.com/transfer/latest/APIReference/API_StartFileTransfer.html) API operation and specify the following parameters, depending on whether you're _sending files_ (outbound transfers) or _receiving files_ (inbound transfers). Note that each `StartFileTransfer` request can contain 10 distinct paths. - -###### 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. - - * **Outbound transfers** - - * `send-file-paths` contains from one to ten source file paths, for files to transfer to the partner's SFTP server. - - * `remote-directory-path` is the remote path to send a file to on the customer's SFTP server. - - * **Inbound transfers** - - * `retrieve-file-paths` contains from one to ten remote paths. Each path specifies a location for transferring files from the partner's SFTP server to your Transfer Family server. - - * `local-directory-path` is the Amazon S3 location (bucket and optional prefix) where your files are stored. - - - - -To send files, you specify the `send-file-paths` and `remote-directory-path` parameters. You can specify up to 10 files for the `send-file-paths` parameter. The following example command sends the files named `/amzn-s3-demo-source-bucket/file1.txt` and `/amzn-s3-demo-source-bucket/file2.txt`, located in Amazon S3 storage, to the `/tmp` directory on your partner's SFTP server. To use this example command, replace the ``amzn-s3-demo-source-bucket`` with your own bucket. - - - aws transfer start-file-transfer --send-file-paths /amzn-s3-demo-source-bucket/file1.txt /amzn-s3-demo-source-bucket/file2.txt \ - --remote-directory-path /tmp --connector-id c-1111AAAA2222BBBB3 --region us-east-2 - -To retrieve files, you specify the `retrieve-file-paths` and `local-directory-path` parameters. The following example retrieves the files `/my/remote/file1.txt` and `/my/remote/file2.txt` on the partner's SFTP server, and places it in the Amazon S3 location /amzn-s3-demo-bucket/`prefix`. To use this example command, replace the ``user input placeholders`` with your own information. - - - aws transfer start-file-transfer --retrieve-file-paths /my/remote/file1.txt /my/remote/file2.txt \ - --local-directory-path /amzn-s3-demo-bucket/prefix --connector-id c-2222BBBB3333CCCC4 --region us-east-2 - -The previous examples specify absolute paths on the SFTP server. You can also use relative paths: that is, paths that are relative to the SFTP user's home directory. For example, if the SFTP user is `marymajor` and their home directory on the SFTP server is `/users/marymajor/`, the following command sends `/amzn-s3-demo-source-bucket/file1.txt` to `/users/marymajor/test-connectors/file1.txt` + * List files and sub-folders from a directory on the remote SFTP server. @@ -57,0 +17 @@ The previous examples specify absolute paths on the SFTP server. You can also us + * Delete, rename or move files and directories on the remote SFTP server. @@ -59,2 +18,0 @@ The previous examples specify absolute paths on the SFTP server. You can also us - aws transfer start-file-transfer --send-file-paths /amzn-s3-demo-source-bucket/file1.txt \ - --remote-directory-path test-connectors --connector-id c-2222BBBB3333CCCC4 --region us-east-2 @@ -62 +19,0 @@ The previous examples specify absolute paths on the SFTP server. You can also us -## Move or rename files or directories on the remote SFTP server @@ -64,18 +20,0 @@ The previous examples specify absolute paths on the SFTP server. You can also us -You can use an SFTP connector to move or rename files and directories on a remote SFTP server. - -Some common use cases are as follows. - - * A remote server generates or receives a new file every hour, with the same filename but a different timestamp. To keep the main folder up to date (so that it contains only the latest file), you can use a connector to move older files to an archived folder. - - * You use a connector to list all of the files in a remote directory, then transfer all of the files to your local storage. You can then use a connector to move the files to an archived folder on the remote server. - - - - -You must use a `StartRemoteMove` call for each file or directory you want to process, as the command takes a single source and destination file or directory as arguments. However, you can accelerate performance by having your connectors create concurrent sessions with remote servers that support concurrent sessions from the same user, and move/rename up to 5 files in parallel. - -The following example moves a file on the remote SFTP server from `/source/folder/sourceFile` to `/destination/targetFile`, and returns a unique identifier for the operation. - - - aws transfer --connector-id c-AAAA1111BBBB2222C start-remote-move \ - --source-path /source/folder/sourceFile --target-path /destination/targetFile @@ -85,22 +24 @@ The following example moves a file on the remote SFTP server from `/source/folde -For the move/rename operations, Transfer Family uses the standard `SFTP SSH_FXP_RENAME` command to do the move/rename operation. - -## Delete files or directories on the remote SFTP server - -You can use an SFTP connector to delete files or directories on a remote SFTP server. - -Some common use cases are as follows. - - * You use a connector to retrieve a file from a remote SFTP server, store it in your Amazon S3 bucket, then encrypt it. Finally, you can use a connector to delete the unencrypted file on the remote server. - - * You use a connector to list all of the files in a remote directory, then transfer all of the files to your local storage. You can then use a connector to delete all of the files that you transferred. You could also delete the remote directory if you prefer. - - - - -You must use a `StartRemoteDelete` call for each file or directory you want to delete, as the command takes a single file or directory as an argument. However, you can accelerate performance by having your connectors create concurrent sessions with remote servers that support concurrent sessions from the same user, and delete up to 5 files/directories in parallel. - -The following example deletes a file on the remote SFTP server in the path `/delete/folder/deleteFile`, and returns a unique identifier for the operation. - - - aws transfer start-remote-delete --connector-id c-AAAA1111BBBB2222C \ - --delete-path /delete/folder/deleteFile +Currently, SFTP connectors can only be used to connect to remote SFTP servers that offer an internet-accessible endpoint. @@ -108 +26 @@ The following example deletes a file on the remote SFTP server in the path `/del -###### Note +For details on creating connectors, see [Creating SFTP connectors](./configure-sftp-connector.html). @@ -110 +28 @@ The following example deletes a file on the remote SFTP server in the path `/del -For the delete operation, Transfer Family uses the standard `SSH_FXP_REMOVE` command to delete a file, and `SSH_FXP_RMDIR` to delete a directory. +###### Topics @@ -112 +30 @@ For the delete operation, Transfer Family uses the standard `SSH_FXP_REMOVE` com -## Track the progress of your file transfer requests + * [Transfer files](./transfer-files-and-track.html) @@ -114 +32 @@ For the delete operation, Transfer Family uses the standard `SSH_FXP_REMOVE` com -To track the progress of a file transfer operation, you use the [ListFileTransferResults](https://docs.aws.amazon.com/transfer/latest/APIReference/API_ListFileTransferResults.html) API operation, which 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 Connector ID and its Transfer ID. The following example returns a list of files for connector ID `a-11112222333344444` and transfer-ID `aa1b2c3d4-5678-90ab-cdef-EXAMPLE11111`. + * [List contents of a remote directory](./sftp-connector-list-dir.html) @@ -115,0 +34 @@ To track the progress of a file transfer operation, you use the [ListFileTransfe + * [Move, rename, or delete files or directories on the remote server](./move-delete-remote-files.html) @@ -117 +35,0 @@ To track the progress of a file transfer operation, you use the [ListFileTransfe - aws transfer list-file-transfer-results --connector-id a-11112222333344444 --transfer-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 @@ -119 +36,0 @@ To track the progress of a file transfer operation, you use the [ListFileTransfe -###### Note @@ -121 +37,0 @@ To track the progress of a file transfer operation, you use the [ListFileTransfe -File transfer results are available up to 7 days after you call the `ListFileTransferResults` API operation. @@ -131 +47 @@ Test an SFTP connector -List contents of remote directory +Transfer files