StartFileTransferRequest Class | AWS SDK for .NET V3

Container for the parameters to the StartFileTransfer operation. Begins 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 more SendFilePaths to identify the files you want to transfer.
For an SFTP connector, the file transfer can be either outbound or inbound. In both cases, you specify the ConnectorId. Depending on the direction of the transfer, you also specify the following items:
- If you are transferring file from a partner's SFTP server to Amazon Web Services storage, you specify one or more RetrieveFilePaths to identify the files you want to transfer, and a LocalDirectoryPath to specify the destination folder.
- If you are transferring file to a partner's SFTP server from Amazon Web Services storage, you specify one or more SendFilePaths to identify the files you want to transfer, and a RemoteDirectoryPath to specify the destination folder.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Transfer.AmazonTransferRequest
      Amazon.Transfer.Model.StartFileTransferRequest

Namespace: Amazon.Transfer.Model
Assembly: AWSSDK.Transfer.dll
Version: 3.x.y.z

Syntax

public class StartFileTransferRequest : AmazonTransferRequest
         IAmazonWebServiceRequest

The StartFileTransferRequest type exposes the following members

Constructors

	Name	Description
	StartFileTransferRequest()

Properties

Name	Type	Description
ConnectorId	System.String	Gets and sets the property ConnectorId. The unique identifier for the connector.
LocalDirectoryPath	System.String	Gets and sets the property LocalDirectoryPath. For an inbound transfer, the `LocaDirectoryPath` specifies the destination for one or more files that are transferred from the partner's SFTP server.
RemoteDirectoryPath	System.String	Gets and sets the property RemoteDirectoryPath. For an outbound transfer, the `RemoteDirectoryPath` specifies the destination for one or more files that are transferred to the partner's SFTP server. If you don't specify a `RemoteDirectoryPath`, the destination for transferred files is the SFTP user's home directory.
RetrieveFilePaths	System.Collections.Generic.List<System.String>	Gets and sets the property RetrieveFilePaths. One or more source paths for the partner's SFTP server. Each string represents a source file path for one inbound file transfer.
SendFilePaths	System.Collections.Generic.List<System.String>	Gets and sets the property SendFilePaths. One or more source paths for the Amazon S3 storage. Each string represents a source file path for one outbound file transfer. For example, `amzn-s3-demo-bucket/myfile.txt`. Replace `amzn-s3-demo-bucket` with one of your actual buckets.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5