StartFileTransferRequest ¶

class StartFileTransferRequest(TypedDict, closed=True):
    connector_id: "capo_transfer.types.connector_id.ConnectorId"
    """<p>The unique identifier for the connector.</p>"""
    send_file_paths: NotRequired["capo_transfer.types.file_paths.FilePaths"]
    """<p>One or more source paths for the Amazon S3 storage. Each string represents a source file path for one outbound file transfer. For example, <code> <i>amzn-s3-demo-bucket</i>/<i>myfile.txt</i> </code>.</p> <note> <p>Replace <code> <i>amzn-s3-demo-bucket</i> </code> with one of your actual buckets.</p> </note>"""
    retrieve_file_paths: NotRequired["capo_transfer.types.file_paths.FilePaths"]
    """<p>One or more source paths for the partner's SFTP server. Each string represents a source file path for one inbound file transfer.</p>"""
    local_directory_path: NotRequired["capo_transfer.types.file_path.FilePath"]
    """<p>For an inbound transfer, the <code>LocaDirectoryPath</code> specifies the destination for one or more files that are transferred from the partner's SFTP server.</p>"""
    remote_directory_path: NotRequired["capo_transfer.types.file_path.FilePath"]
    """<p>For an outbound transfer, the <code>RemoteDirectoryPath</code> specifies the destination for one or more files that are transferred to the partner's SFTP server. If you don't specify a <code>RemoteDirectoryPath</code>, the destination for transferred files is the SFTP user's home directory.</p>"""
    custom_http_headers: NotRequired[
        "capo_transfer.types.custom_http_headers.CustomHttpHeaders"
    ]
    """<p>An array of key-value pairs that represent custom HTTP headers to include in AS2 messages. These headers are added to the AS2 message when sending files to your trading partner.</p>"""