Performing file-based operations on an S3 bucket with Orchestrator


Aspera transfer servers can transfer files to and from Amazon’s S3 object storage. With transfer servers’ Node API functionality, you can also perform file operations on your S3 bucket such as search, delete, rename and move.

Orchestrator has a Node API plugin that allows you to incorporate file operations on S3 buckets into your workflows.

What you need

  • A licensed Aspera transfer server (Enterprise Server/Connect Server/P2P)
  • Your S3 credentials (access ID and secret key)
  • Orchestrator Node API plugin


1. On your transfer server, create a transfer user with the S3 bucket as its docroot. Refer to your transfer server’s documentation for more information on this process.

If you have an existing transfer user, you may use the following asconfigurator command to set the S3 bucket docroot:

asconfigurator -x "set_user_data;user_name,transfer_user;absolute,s3://"

2. Create a node user for the transfer user with the S3 bucket docroot

Run the following command to create a node user and password:

/opt/aspera/bin/asnodeadmin -a -x transfer_user -u node_user -p node_password

Windows asnodeadmin.exe -a -x transfer_user -u node_user -p node_password
Mac /Library/Aspera/bin/asnodeadmin -a -x transfer_user -u node_user -p node_password

3. In Orchestrator, you can now use your Node API username and password with the Node API plugin in order to perform file operations on S3.

For example, you could use the Node API plugin to retrieve a list of the current files in your S3 bucket. From there you can filter out files that were already processed, and trigger an action on the remaining files.

Powered by Zendesk