This article is part of the Tool Mastery Series, a compilation of Knowledge Base contributions to introduce diverse working examples forDesigner Tools. Here we’ll delve into uses of the Amazon S3 Tools on our way to mastering the Alteryx Designer:
The Amazon S3 Upload Tool and Amazon S3 Download Tool and are connectors that allow you to upload and download files to/from your Amazon S3 account with Alteryx Designer. You do not need to install an ODBC driver to use these tools, and they come with the default installation of Alteryx Designer or Server. You can find them conveniently placed under the Connectors tool category. This Tool Mastery Article is here to help you learn how to connect to your Amazon S3 account with Alteryx like a pro!
To upload data to Amazon S3 using Amazon S3 Upload Tool:
- First, you need to make sure you already have an AWS account and credentials.
- If you have step one covered, simply drag the Amazon S3 Upload Tool onto your designer canvas. The configuration window for the tool will load on the left-hand side of the canvas.
- To configure the tool, fill out the options in the configuration window as detailed below:
1 - an AWS Access Key is required to connect to your S3 account with these tools. You will need to reach out to your AWS admin if you don't know what your access key is.
2 - an AWS Secret Key is also required to use this tool. Check with your AWS admin if you don't have the secret key.
3 - Expanding the drop down will give you 3 options for you to select from:
a. Hide (Default) - will hide the provided password using minimal encryption.
b. Encrypt for Machine - Allows any user on the computer to fully use the connection.
c. Encrypt for User - Allows the logged in user can use the connection on any computer.
4 - Select Default from this drop-down menu to allow Amazon to determine the endpoint automatically based on the bucket you select. To specify an endpoint for private S3 deployments, or if you know a specific bucket region, you can alternatively select an endpoint (S3 region), enter a custom endpoint, or select from one of ten previously-entered custom endpoints.
5 - You can select this option to use Signature Version 4 instead of the default Signature Version 2. Selecting Signature Version 4 will increase the connection's security but may cause the connection to be slower.
6 - Type a Bucket name to upload your data to a new bucket, or select one from the list of available Buckets.
7 - Specify the Object name (data file) to be stored in the above-specified Bucket. You can either type an Object name or select one from the list.
8 - Server-Side Encryption is a drop-down option where you can select an encryption method for uploading to an encrypted Amazon S3 bucket
9 - The final configuration option allows to specify the File type you want to upload your data to S3 as.
4. Run the workflow. If the workflow runs successfully, you will see the message below in the results window.
To download data from Amazon S3 using Amazon S3 Download Tool:
- Drag the Amazon S3 Download Tool to the designer canvas.
- You will notice the configuration is identical to the configuration of the Amazon S3 Upload Tool (detailed above). If you need help with the configuration, please refer to the screenshot above or the Amazon S3 Download Tool Help page.
- After you have configured the tool to access your intended file, run the workflow.
- When the workflow is finished running, you will notice data from the Object has been imported into Designer
There is also a great video that provides an overview of this information available here.
Some of the common errors (or special request) you will run into with this tool:
Issue: S3 – Error from AWS: The HTTP version specified is not supported
Answer: Make sure any files you are downloading, or uploading do not contain whitespaces or colons.
Issue: Cannot read in more than one object at a time
Answer: The Community Knowledge Base Article Amazon S3 Download – Use Wildcards to Select a Single or Multiple Objects goes over how you can utilize a batch macro to read in the list of objects in a bucket and allow you to filter for the file(s) you want using wildcards.
Issue: To utilize Amazon S3 Tool to access a subfolder within a private External Bucket in S3.
Answer: Refer to this community thread.
If you'd like some additional tips and tricks on connecting to Amazon S3, please take a look at the following resources:
Download a Zipped Excel File from an Amazon S3 Bucket
Extending Integration with AWS
By now, you should have expert-level proficiency with the Amazon S3 Download/Upload tools! If you can think of a use case we left out, feel free to use the comments section below! Consider yourself a Tool Master already? Let us know at email@example.com if you’d like your creative tool uses to be featured in the Tool Mastery Series.
Stay tuned with our latest posts every Tool Tuesday by following Alteryx on Twitter! If you want to master all the Designer tools, consider subscribing for email notifications.