This Flux action is used to connect to an S3 server and download object(s) from a Bucket with the specified variables. Any S3 action in Flux will use the global S3 credentials file. Before using any S3 action, the credentials file must be created and populated.
This can be done by following the tutorial provided by Amazon here https://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/setup-credentials.html
This needs to be done on every machine that is going to connect to S3.
A bucket is where files or "S3 Objects" are stored on an S3 server. Each Bucket is created from a Region. When interacting with a bucket in anyway, you must be calling the action with the correct region.
A global runtime variable is default for the Region field in all S3 actions. This variable is "s3region", and can be edited in your runtime variables file or Settings tab.
This action accepts wildcards from within the Object Name. This means you can select multiple Objects to be downloaded by providing a wildcard character in the name (ex: "*.ffc", "Output-*.txt").
This does not apply to the Bucket Name, this operation will execute within the 1 Bucket specified.
This action will fail to execute if:
- The Bucket does not exist
- You are trying to connect to a Bucket with a different Region than specified
This action can complete if not finding any Objects to download.
A list of downloaded Objects is included in the Return from this action.