AWS integration

Create an AWS integration with SuperAnnotate to add items (images, videos, documents) from your AWS S3 bucket(s) to SuperAnnotate. SuperAnnotate will have read-only access to your data; your items are stored in your AWS S3 buckets and are only displayed in SuperAnnotate.

Create an AWS integration

🚧

Enable CORS for Text Projects

You’ll need to enable CORS in your storage to add items in your Text Projects. Learn more.

Step 1: Go to the integrations page

720720
  1. In Integrations, click New Integration.
  2. On the setup page, type the name of your integration under Integration Name.
  3. You can add the integration to a selected team or multiple teams. The integration will be available in the selected team(s) only. Note that this step is optional. If you don’t select a team, then the integration won’t be added to any team. You can always add the integration to a team from the Integrations list.

❗️

Adding or removing a team allows or restricts access to the data related to this integration.

Step 2: Create a policy JSON in SuperAnnotate

720720
  1. On the setup page, type the name of your S3 bucket under Bucket Name in the Create Policy section. The bucket name will be automatically added to the policy JSON below the input field.

  2. Use the policy JSON to create an IAM policy, as demonstrated in Step 3. This policy gives SuperAnnotate read-only access to your bucket.

Step 3: Create an IAM policy

720720
  1. Go to your IAM console.
  2. Click Policies under Access management in the left panel.
  3. In the Policies tab, click Create Policy.
  4. Go to the JSON tab and enter the policy JSON mentioned in the second bullet point of Step 2.
  5. Click Next: Tags > Next: Review.
  6. On the Review policy page, type the name of your policy.
  7. Click Create policy.

Now that you’ve created an IAM policy, it’s time to create an AWS role so stay in your IAM console. See how to do that in Step 4.

Step 4: Create an AWS role

720720
  1. In your IAM console, click Roles under Access management.
  2. In the Roles tab, click Create role.
  3. Click Another AWS account. Here you have to enter the Account ID. You can find it in SuperAnnotate’s integration popup, under SuperAnnotate’s AWS Account ID.
  4. Next to Options, check the Require external ID box and enter the external ID. You can find it in SuperAnnotate’s integration popup, under External ID.
  5. Click Next:Permissions.
  6. Under Attach permission policies, select the policy you created.
  7. Click Next:Tags.
  8. Click Next:Review.
  9. In the Review tab, type a role name.
  10. Click Create role.

Step 5: Edit trust relationship

720720
  1. After clicking Create role, you’ll be redirected to a page with all your roles. Select the role you just created.
  2. Select the Trust relationships tab.
  3. Click Edit trust relationship.
  4. Delete the policy document in the JSON tab and replace it with the policy JSON in SuperAnnotate’s AWS integration setup in the Edit Trust Relationship section.
  5. Click Update Trust Policy.

Step 6: Add the role ARN

720720
  1. After clicking Update Trust Policy, you’ll be redirected to a page called Summary. Copy the Role ARN from that page.
  2. Enter the Role ARN in SuperAnnotate’s AWS integration setup.
  3. In SuperAnnotate’s AWS integration setup, click Create.

📘

Messages

  • If the integration is created successfully, you'll see this message: You've successfully created the integration.
  • If the integration couldn't be created, you'll see this message: Oh no! The integration couldn’t be created.

📘

Who can create and use integrations?

  • Only Team Owners can create integrations.
  • Only Team Owners, Team Admins, and Project Admins (with permission) can use integrations.

To allow Project Admins to use integrations, check the Upload box under Project Admin Permissions in Settings.

🚧

Limitations

  • You can't upload more than 50,000 items to the root or a folder. The remaining items will be skipped.
  • A project can't contain more than 500,000 items.
  • A folder name can't exceed 120 characters and can't contain the following characters: / \ : * ? " < > |

Validate integration

To validate your AWS integration:

  1. In Integrations, find your integration.
  2. Click the three dots button.
  3. Select Check connection.
    • If the integration is valid, you’ll see a success message that says: “The connection of the integration “[your integration name]” is valid.”
    • If the integration is invalid, you’ll see an error message that says: “The connection of the integration “[your integration name]” is invalid.”

📘

Messages

  • If the connection is valid, you'll see this message: The connection is valid.
  • If the connection isn't valid, you'll see this message: The connection is not valid.

Edit team

To add or remove an integration to a team or multiple teams:

  1. In Integrations, find your integration.
  2. Click the three dots button.
  3. Select Edit team.
  4. Add or remove teams.
  5. Click Save.

Delete integration

To delete an integration:

  1. In Integrations, find your integration.
  2. Click the three dots button.
  3. Select Delete Integration.
  4. In the popup, click Delete.

📘

Message

If the integration is successfully deleted, you'll see this message: You've successfully deleted the integration.

📘

Who can delete integrations?

Only Team Owners can delete integrations.

Add items with AWS integration

You can add items from your AWS S3 bucket(s) to Image Projects, Video Projects, and Text Projects.

  1. In Data, click Add.
  2. Select Upload Images, Upload Video (with frames), Upload Videos, or Upload Documents (depending on your project type).
  3. Go to External Storage.
  4. In Integrations, choose an integration (mandatory) and type a folder path (optional).
  5. Click Upload.

When the upload is in progress, you'll see this message: Your upload is in progress. This might take a while. Click Refresh to see your uploaded items. When you see that, refresh the page.

📘

Message

  • If the items failed to upload, you'll see this message: Oh no! Your items failed to upload.

When you add items from an integrated AWS bucket to SuperAnnotate, you can’t:

  • Run Smart Segmentation
  • Run Smart Prediction
  • Create models and run trainings
  • Export in the COCO format
  • Set the upload quality in Settings

Did this page help you?