Amazon S3 Setup

Mike Jones
Mike Jones
  • Updated

The Amazon S3 Synapse enables data synchronization between your Amazon S3 bucket and Syncari entities. The primary use case for using Amazon S3 as a Synapse is to read/write data from/to a csv file. This Synapse can be used as both a source and destination in your pipelines.

Using this synapse as a destination in your pipelines will create a new CSV file in your S3 folder for each sync cycle. Each new CSV file will be written to the folder with a unique timestamp.


Amazon S3 Configuration

If your Amazon S3 security requires you to whitelist an IP you can find that here.

Create a User with an Access Key / Secret

The first thing you'll need is an AWS user that has permissions to access your Amazon S3 bucket. You may need help from an Administrator of your AWS account to create this user. The user will need access to read/write data within folders on your Amazon S3 bucket. Syncari will be making API requests to retrieve data from your Amazon S3 bucket so make sure to create an Access Key / Secret Key for the user.

Required Permissions

Grant permissions by using Amazon S3 bucket policies and enable the following policies.

  • GetBucket
  • ListBucket
  • GetObject
  • GetObjectAttributes
  • PutObject
  • DeleteObject

Reference this AWS article on how to add bucket policies:


Create a Root Folder and Sub-folders in your S3 Bucket

The Amazon S3 schema is defined by the folders and the header names of csv files stored in each folder.

  1. Create a root folder in your S3 Bucket. This folder will be used with your Synapse configuration and should be exclusively used with Syncari. We recommend naming the root folder "Syncari".
  2. Create subfolders within the root folder to represent each Entity in your schema.
    Here's an example of what you would have if you named your S3 bucket "syncari" and named your root folder "syncari". Note each folder within the "syncari" folder is represents each entity that will sync into Syncari (accounts, contacts, leads etc.). 
  3. Add a csv file to each subfolder where the first row includes column names that represents the field names the entity.Screen_Shot_2021-03-31_at_3.23.45_PM.png

As an example of the file path, it should look something like this: s3://BUCKETNAME/syncari/ENTITYNAME/schema.csv

Synapse Setup

Step 1: Start by logging in to your Syncari subscription

  1. Navigate to Synapses
  2. Find Amazon S3 in the Synapse Library
  3. Drag the Amazon S3 Synapse to the canvas


Step 2: Configure your Amazon S3 Synapse parameters

  1. Enter [Synapse Name]
  2. Enter [Bucket Name]
  3. Enter [Folder Name] 
    • Add the name of the root folder that was created in your Amazon S3 bucket
  4. Enter [Region] 
    • Add the AWS Region associated with your S3 bucket.
  5. Click Next


Step 3: Define your authentication parameters

  1. Enter [Access Key]
  2. Enter [Secret Key]
  3. Click Authenticate
  4. Click Next


Step 4: Activate the Synapse

  1. Click "Make Synapse Active" then click "Close"


Congratulations! You have completed the setup of the Amazon S3 Synapse.

If you receive any errors message after clicking Authenticate, confirm each of the parameters in the previous steps are configured properly. If the error persists, contact one of our Onboarding and Support team members.


What's Next?

Make sure to check out this article to learn how to designate the Id and Watermark fields for Amazon S3 Entities.


Share this

Was this article helpful?

0 out of 0 found this helpful