Skip to navigation
ExtensibilityWorkflowCreate and manage workflow definitionsWorkflow referenceWorkflow task referenceDownload: Amazon S3

Download: Amazon S3 - Task Settings

View as Markdown

Use this reference to understand the required S3 bucket information, path pattern, and post-download options of the Download: Amazon S3 task.

The Download: Amazon S3 task downloads a file from a specified S3 bucket. After the file is downloaded, you can optionally move or rename the S3 object, depending on the post-download options you configure.

Specify the required S3 bucket information

On the Setup tab, select Amazon S3 as the connection type. The task uses credentials from the credential store instead of storing secrets directly in the task configuration.

Amazon S3 connection

You must select an available S3 credential from the credential store when configuring the task. If no suitable credential exists, you can add it at configuration time and then select it. The AWS Access Key and Secret Key in the credential must be permitted to access the specified region and bucket.

S3 Bucket Name: Name of the S3 bucket (e.g., my-data-bucket).

Click Test Connection to validate the S3 connection from the task configuration.

S3 Bucket Name

Specify the name of the S3 bucket, for example: my-data-bucket.

Click Test Connection to validate the S3 connection from the task configuration.

S3 path pattern

For Amazon S3 connections, use the S3 Path Pattern field to specify the object key or pattern for the file to download. The S3 path pattern supports wildcards and regular expressions so that you can match one or more objects in the bucket.

Post-download actions

When you configure Amazon S3 as the connection type, additional post-download options are available for the downloaded object:

  • Move to path – After the file is downloaded, move the S3 object to a different folder.

  • New filename – After the file is downloaded, rename the file, append a prefix and/or suffix to the filename as part of the move/rename operation.

    These options apply only to Amazon S3 connections. The existing Delete File and Move/Rename File post-processing actions continue to apply to SFTP connections and are not used for S3.

Concurrency Mode

Concurrency Mode: Controls whether Workflow processes tasks in a single or multi-threaded manner for this task type. Select Sequential to single-thread, or Parallel to allow multi-threaded processing.

If you select Parallel, the Max Concurrency setting controls the maximum number of threads for this task type that can be utilized. You can specify a value from 1 up to the allowed maximum for this task type. A value of 1 behaves the same as Sequential processing.