Learn how to set up data deliveries straight to your AWS account's S3 bucket.
New to Outbound Connectors? Learn about the concept more generally: What are Narrative Outbound Connectors
AWS S3 is a popular way for Narrative users to store their datasets. The S3 App and Checkout Settings allow Narrative buyers to push data subscriptions directly to their AWS's S3 bucket in a fast and intuitive manner. Once a bucket is set up, buyers may access it for any Data Stream Marketplace or Buyer Studio subscription.
Please create an AWS account if you have not already done so before continuing.
Installing S3 Connector App
The S3 Connect App is located within the apps tab on Narrative's website. Users may install the app by logging into their Narrative profile and clicking the install button on the app's tile card. If the install feature does not appear or the install request times out please contact firstname.lastname@example.org.
Setting Up Bucket Profiles
Once you've entered into Narrative's S3 Connector App, select the Connector Settings tab located on the left side. Your screen should have no profiles set up and have a blue New Profile button in the upper right.
Click the New Profile button to begin setting up your S3 Connector profile.
New AWS Profile
This screen asks you to set up your profile name, description, and bucket name. Please have a separate screen up with the bucket you intend to use for Narrative's S3 Connector.
Profile Name: The name you will use to identify your bucket during profile management and subscription checkout. Please include a descriptive name to cutdown on confusion between profiles. For example, "North American Location Data" provides enough information to distinguish this bucket's use case while still leaving the name open ended enough to include multiple datasets.
Description: Information to describe why you use this bucket. These indicators will help you distinguish between different use cases for different buckets.
Bucket Name: The location of the bucket you would like to send data to within your S3 account. The bucket name can be pulled directly from your AWS S3 account. For example, a Narrative S3 bucket would look like s3://narrative-testing-bucket. You would copy and paste "narrative-testing-bucket" into the Bucket Name text box. Sub directories for each data delivery can be created during a subscription's checkout process.
Configure S3 Bucket
You are now ready to add a Bucket Policy and a Bucket Tag to your S3 bucket. Narrative requires you to add a policy to your AWS bucket to ensure that Narrative can successfully deliver data.
To add the policy, copy the policy Narrative provides you on the Configure S3 Bucket Page, then navigate to your bucket in the AWS console.
Click on Permissions and under the Bucket Policy section click Edit. Delete the bucket's current policy and paste the policy you just copied above. Your policy should now look very close to the image below.
Click Save and return to the Configure S3 Bucket page. Narrative also requires you to add a tag to your AWS bucket. This ensures that you are the owner of the bucket. Copy the Tag Key that Narrative provides you on the Configure S3 Bucket Page.
To add the tag, navigate to your bucket in the AWS console. Click on Properties and under the Tags section, click Edit. If your bucket already has a tag, make sure to select Add tag and do not replace the tag you already have. Paste the Tag Key in the Key text box. Now repeat the same copy and paste process for the Key Value. Both are required for Narrative to ensure the connector is set up properly.
Click Save and return to the Configure S3 Bucket page. The final step is to test your bucket's connection. Click the Test Connection button and you should receive a green message letting you know that the bucket was set up correctly. If you get a red error message, repeat the bucket policy and bucket tag steps and test again. If the issue persists please reach out to email@example.com for assistance.
Once you save your profile, you are ready to use it as a destination for future subscriptions.
Adding Checkout Settings
You are ready to use a S3 Connector profile in your Buyer Studio or Data Streams Marketplace subscription. During the destination step, toggle on the S3 connector and select the profile that will receive the subscription's data deliveries.
You may also create a subdirectory within your bucket to better organize your data deliveries. For example, this subscription delivers location data so I made a "LocationData" subdirectory within my bucket specifically for this subscription. Bucket Prefixes may not have spaces in the name.
Narrative will automatically create the subdirectory with the name you input for Bucket Prefix. There is no need to match the subdirectory's name with one you have already created.
You may want to deliver this subscription to multiple buckets. It is easy to do so by selecting "Add An Additional Profile" and choosing the second location's profile. The same Bucket Prefix option is available for each additional profile.
Click Save and Continue to finish the checkout process. You will now receive data deliveries in your specified S3 bucket!