List FTP File

List FTP File returns the entries in a remote directory through an FTP Connection resource.

Two filters narrow the result: Pattern matches file names as a glob or regular expression, and Prefix matches names that start with a given string. Max Results bounds how many entries come back.

The activity has four tabs: Configuration, Advanced, Input, and Output.

Configuration

Field	Required	Description
Name	Required	Name of the step, unique within this workflow.
Description	Optional	Describe the purpose of this step.
FTP Connection	Optional	Resource to connect to the FTP or FTPS server.
FTP Auth Context	Optional	Authorization context used for the FTP connection.
Directory	Optional	Remote directory to list.
File Path	Optional	Path within the working directory.
Pattern	Optional	Glob or regular expression filter on file names.
Prefix	Optional	Only names starting with this prefix.

Advanced

Field	Required	Description
Sort By	Optional	Name, Size, or Last Modified.
Max Results	Optional	Maximum number of entries returned. Defaults to 10.
Descending	Optional	Reverse the sort order.
Recursive	Optional	Include entries in subdirectories.
Retry	Optional	Retry the operation on failure.
Retry Policy	Optional	The retry policy resource to apply.

Input

Field	Required	Description
Inputs	Optional	Runtime overrides of the path and filter fields.

Output

The activity returns a listFileOutput object.

Field	Data Type	Description
files	Array	The directory entries returned.
totalFiles	Integer	Number of entries returned.
filePath	String	Path that was listed.