AWS S3

Integrating AWS S3 with Suite

Below is a step-by-step guide to integrating your AWS S3 storage with the Superb AI Suite.

Why should I Integrate AWS S3 to Suite?

1. Easier, Faster Data Upload

Once AWS S3 is integrated with Suite, you can access your data stored on a S3 bucket on Suite, without having to manually download and upload them.

2. Enhanced Data Security

You may add another layer of data security by only allowing read-only access to your buckets and data assets. When you turn this option on, the data remains within your storage and we don't create any copy of your data.

How to Create AWS S3 Integration

The following steps are required to add S3 integration to Suite.

  1. Create an IAM user and attach a policy with permission to access your bucket.

  2. Attach a CORS policy to the bucket so that data can be displayed in your browser.

  3. Enter the bucket and the IAM user information.

We’ll go through each step of the setup process below.

  • Go to My Account → Integrations menu, and click on Amazon S3.

v1.7.0 - Integrations
  • Click on the Add button.

v1.7.0 - Amazon S3

Enter in information about your Amazon S3

Here are the information you will need to enter:

  • Integration Name

    • This is a nickname for your integration as you can add multiple S3 integrations for different buckets. Later when you access data in your integrated bucket, you'll use this name to choose the appropriate integration.

v1.7.1 - Integration Name
  • S3 Bucket Settings S3 Bucket Name Enter in the name of the S3 bucket you would like to integrate. Clicking on the bucket link will redirect you to the S3 console, where you can see the list of buckets within your S3. (Note: the bucket name is case sensitive so make sure you enter it exactly!) ** Folder (Optional) If you’d like to create an integration with a specific folder within your bucket, enter the name of the folder.

    • If you enter a folder name, only the files within this folder will be accessible via integration.

    • You can skip this step to access every folder within the bucket.

v1.7.1 - S3 Bucket Settings
  • CORS(Cross-origin resource sharing) Policy The CORS Policy must be configured to display the accessed data correctly on the browser.

    • First, in the S3 Integration menu on [Suite], click on the Show CORS Policy button, and copy the CORS policy to your clipboard.

    • Then, go to the [AWS] Amazon S3 > Buckets (Click the bucket) > Permissions > CORS edit page and paste in the CORS policy you copied in the step above. You can refer to the below documents from AWS.

v1.7.1 - edit CORS Policy
  • IAM Settings

    • Generate an IAM Policy You will first need to generate an IAM Policy.

      • On [Suite], click on the Generate IAM Policy button, and copy the policy to the clipboard.

      • On [AWS], go to the IAM > Access management > Policies menu, and click on the Create Policy button. Within the JSON editor, paste the policy you copied, enter in the name of the policy, and create policy. ​ You can refer to the below documents from AWS.

    • Create a User with an IAM Policy

      • On [AWS], go to the Users > Add User page and create a user.

      • On [AWS], click on Access type - choose Programmatic access.

      • On [AWS], add to the user the IAM Policy you generated above. You can refer to the below documents from AWS.

      • On [AWS], you will see the Access Key and Secret Key for the newly created IAM user.

      • On [Suite], copy and paste the Access Key and Secret Key.

v1.7.1 - Create IAM Policy

v1.7.1 - Add User

v1.7.1 - Check Access Key, Secret Key

v1.7.1 - Save Integration

After entering in all information, click on the Save Integration button at the bottom.

Troubleshooting Steps

  • Please check that you have correctly entered in the bucket name.

  • Please check the IAM Policy and that it has access to the correct bucket.

  • Please check that you have correctly attached the CORS Policy to the bucket.

Integration Complete!

A successful integration should look something like below:

v1.7.1 - Integration Complete

Q&A

  • How many buckets can I integrate with my account? Each S3 integration can only have one S3 bucket, but you may have as many S3 integrations as you wish.

  • I finished configuring the integration, but the integration status shows up as Failed. Why is that?

    There may be some errors in the configuration. Please refer to the troubleshooting steps above and check the following are correctly configured.

    • CORS Policy

    • IAM Policy

    • Access Key and Secret Key