We currently only support S3 buckets as blob stores for streaming events.
Prerequisites
- AWS account permissions to create policies and S3 buckets
- A Relevance AI account on the Enterprise plan
Instructions
1. Create an S3 bucket
Create an S3 bucket in the same region where your Relevance data is stored. Use the following region mapping:- Australia:
ap-southeast-2
(Sydney) - Europe:
eu-west-2
(London) - US:
us-east-1
(N. Virginia)
Ensure the bucket is created in the correct region.
2. Add Bucket policy
Add the following policy statement to your bucket policy. You’ll need to customize the placeholders:YOUR_BUCKET_NAME
: Replace with your actual S3 bucket name in both the Resource ARNsRELEVANCE_EVENT_CONSUMER_ROLE_ARN
: Replace with Relevance’s IAM role ARN for your region
The IAM role ARN is region-specific. Contact your Relevance team for this.
3. Provide Configuration Information
Once your S3 bucket is configured, provide your Account Manager or our support team with the following information:- Bucket Name: The name of your S3 bucket
- Region: The AWS region where your bucket is located
- Prefix: The S3 prefix where you want events to be stored (e.g.,
relevance-events/
)
Event Structure
Once configured, events will start flowing into your bucket under the specified prefix. The folder structure follows this pattern:Example Structure
Event Types
billing_events
: Usage and billing-related eventsexecution_event
: Execution and performance eventsi_a_m_event
: Identity and access management eventsasset_event
: Asset creation, modification, and deletion events
File Format
- All event files are stored as gzip-compressed json objects
- The
dt=
parameter uses UTC date format (YYYY-MM-DD) - File names follow the pattern:
event-consumer-{event-type}-{environment}-{instance}-{timestamp}-{uuid}.gz
- Each file contains a unique identifier (UUID) to prevent conflicts