Amazon Beacon S3 Destination
The Amazon Beacon S3 Destination allows activation queries performed on an AWS Beacon Dataset to be exported to a predetermined S3 Bucket located in the same AWS account where the Beacon App was installed.
| Important note |
| This destination can only be created if you have a live Amazon Beacon S3 deployment and data can only be exported from an AWS hosted Dataset. |
Table of contents
Amazon Beacon Destination pre-requisites
Configure the Amazon Beacon S3 Destination in the Platform
Activating data to a Amazon Beacon S3
Amazon Beacon Destination pre-requisites
- You must have a AWS Beacons App installed on your Amazon account
- You need to configure the App to grant the pusher role created when installing the Amazon InfoSum Beacon product write access to the S3 bucket defined in this destination. This is because this Destination can only write to your data storage, not to any third parties.
- You must have a Dataset published from your AWS Beacon that contains export columns (owned or permissioned in the Collaboration)
- Your activation query must export data from the AWS Dataset
- You must define an S3 Bucket on your AWS account
Please use the follow script to grant the required bucket policy:
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "AllowBeaconPushes",
"Effect": "Allow",
"Principal": {
"AWS": "{pusher-role-arn}"
},
"Action": [
"s3:PutObject",
"s3:DeleteObject",
"s3:ListBucket"
],
"Resource": [
"{arn-of-bucket-to-push-to}/*",
"{arn-of-bucket-to-push-to}"
]
}
]
}- pusher-role-arn returns during app install.
- arn-of-bucket-to-push-to is the ARN of the S3 bucket where you want to enable pushes - this can be copied from the AWS web console or fetched via the AWS CLI.
-
The permissions are required for:
- PutObject - writing to the bucket
- DeleteObject - being able to overwrite objects
- ListBucket - required pusher compute to perform HeadBucket which confirms the region of the bucket for our pre-push validation.
-
Resources relate to:
- {arn-of-bucket-to-push-to}/*: Needed by PutObject and DeleteObject. The * can be more specific if you optionally want to restrict the object keys (files) that can be pushed to.
- {arn-of-bucket-to-push-to}: Needed by ListBucket
- Sid is a human-readable ID for the policy statement.
If you have multiple Datasets with different data formats, you can create multiple destinations that point to different S3 Buckets. Please name each destination accordingly to help you manage exports to the right location.
Activation Keys
The connector does not have a predetermined set of keys. The Destination will write a file per export with the schema that you defined in your activation query.
Configure the Amazon Beacon S3 Destination in the Platform
Navigate to Activations > Destinations.
Click Create a new destination, then select the Amazon Beacon S3 from the list of options.
Give your Destination a name and click next.
The following form will appear. You must fill in all required fields.
- Bucket: Name of the S3 bucket to push to.
- Bucket Region: The AWS region of the S3 bucket to push to. This doesn’t have to be the same region where the AWS Beacon was installed. Please adhere to your company’s data policy when selecting the region for this destination.
-
Object key: This will be the name of the export file in the S3 Bucket.
- This destination will overwrite files with the same name; we recommend keeping this setting to ‘editable during export’ so you can modify the filename to export multiple different segments to the same destination.
Click Submit. Your Destination is now ready to use.
Please note we don’t verify the connection details until you export a query, if this is your first time creating this type of destination, we recommend doing a test push to verify the setup.
Activating data to a Amazon Beacon S3
You can create an activation segment using either Segment Builder or the Query Tool.
Please ensure that your activation query exports data from your AWS hosted Dataset or you won’t be able to select the Amazon Beacon S3 Destination.
- Navigate to Activation Segments & start an export
Once you’ve created the activation segment, go to the Activation Segments tab under Activate, where you can find all of the historic segments that have been created by your team for that collaboration. Please ensure you are in the correct Collaboration view at the top for the Activation you're looking for.
A ‘ready’ status shows that the query has been successful and is ready to be sent to a Destination. Activation segments are only ‘Ready’ for 36 hours, this is to ensure that you are always exporting the freshest data. You can easily refresh a segment by clicking ‘refresh’ in the details panel of each segment.
When you select an Activation segment, an information panel appears on the side of the page allowing you to view the segment and export it to a Destination with the correct permissions for that Collaboration.
You can click ‘Export’ to start a new export, or click ‘View’ / double-click on the activation segment name to view all exports associated with this segment.
- Select your destination
After you click Export, a new pane will appear with a list of the destinations available for this segment. You will be able to see all the Destinations that your company owns or has permission to use for that Collaboration.
- Configure the export
When you select the correct Destination, the pop up will show additional options and the fields that were left editable at push time here.
There are no additional options for the AWS Beacon S3 Destination.
- Click Export Activation Segment to initiate the export to your chosen destination.