/AWS1/CL_TRN=>STARTFILETRANSFER()
¶
About StartFileTransfer¶
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 moreSendFilePaths
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 aLocalDirectoryPath
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 aRemoteDirectoryPath
to specify the destination folder.
-
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_CONNECTORID
TYPE /AWS1/TRNCONNECTORID
/AWS1/TRNCONNECTORID
¶
The unique identifier for the connector.
Optional arguments:¶
IT_SENDFILEPATHS
TYPE /AWS1/CL_TRNFILEPATHS_W=>TT_FILEPATHS
TT_FILEPATHS
¶
One or more source paths for the Amazon S3 storage. Each string represents a source file path for one outbound file transfer. For example,
DOC-EXAMPLE-BUCKET/myfile.txt
.Replace
DOC-EXAMPLE-BUCKET
with one of your actual buckets.
IT_RETRIEVEFILEPATHS
TYPE /AWS1/CL_TRNFILEPATHS_W=>TT_FILEPATHS
TT_FILEPATHS
¶
One or more source paths for the partner's SFTP server. Each string represents a source file path for one inbound file transfer.
IV_LOCALDIRECTORYPATH
TYPE /AWS1/TRNFILEPATH
/AWS1/TRNFILEPATH
¶
For an inbound transfer, the
LocaDirectoryPath
specifies the destination for one or more files that are transferred from the partner's SFTP server.
IV_REMOTEDIRECTORYPATH
TYPE /AWS1/TRNFILEPATH
/AWS1/TRNFILEPATH
¶
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 aRemoteDirectoryPath
, the destination for transferred files is the SFTP user's home directory.