Amazon AWS SQS Connector Setup Guide
This article describes how to set up the AWS SQS connector in your Customer Data Hub account.
Amazon SQS provides fully-managed message queues for micro-services, distributed systems, and server-less applications.
Requirements
- AWS Account
- Required:
sqs:SendMessagepermission - Optional:
sqs:ListQueuespermission - Queue to send data to
Connector actions
| Action Name | AudienceStream | EventStream |
|---|---|---|
| Send Event Data to Queue | ✗ | ✓ |
| Send Event Data to Queue (Batch) | ✗ | ✓ |
| Send Visitor Data to Queue | ✓ | ✗ |
| Send Visitor Data to Queue (Batch) | ✓ | ✗ |
| Send Customized Data to Queue (Advanced) | ✓ | ✓ |
| Send Customized Data to Queue (Advanced Batch) | ✓ | ✓ |
Configure settings
Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see About Connectors.
After adding the connector, configure the following settings:
-
Access Key
- Required. Provide your IAM User’s access key. Associated IAM policy (for either IAM User or Assumed Role) must grant
sqs:SendMessagepermission. - For more information, see Access Control for Amazon SQS.
- Required. Provide your IAM User’s access key. Associated IAM policy (for either IAM User or Assumed Role) must grant
-
Secret Key
- Required. Provide your IAM User’s secret key
-
Region
- Required. Select the region.
-
Assume Role: ARN
- Optional: Provide Amazon Resource Name (ARN) of role to assume.
For example:arn:aws:iam::222222222222:role/myrole - For more information, see Switching to an IAM Role.
- Optional: Provide Amazon Resource Name (ARN) of role to assume.
-
Assume Role: Session Name
- Optional: Provide identifier for assumed role session.
-
Assume Role: External ID
- Optional: Provide external identifier.
- For more information, see How to Use an External ID.
Action settings - parameters and options
Click Next or go to the Actions tab. This is where you configure connector actions.
The following sections describe how to set up parameters and options for each action.
Action - Send Event Data to Queue and Send Event Data to Queue (Batch)
Batch Limits
This action uses batched requests to support high-volume data transfers to the vendor. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:
- Maximum number of requests: 10
- Maximum time since oldest request: 5 minutes
- Maximum size of requests: 1 MB
Parameters
| Parameter | Description |
|---|---|
| Queue |
|
| MessageGroupId | Specifies that a message belongs to a specific message group (FIFO Queues only). |
| DelaySeconds | The length of time (in seconds) to delay a specific message (0 to 900). |
| Print Attribute Names | If attribute names are updated, the names in the payload reflect the update. |
See Using Amazon SQS Message Attributes.
Action - Send Visitor Data to Queue and Send Visitor Data to Queue (Batch)
Batch Limits
The Send Visitor Data to Queue (Batch) action uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following thresholds is met:
- Maximum number of requests: 10
- Maximum time since oldest request: 5 minutes
- Maximum size of requests: 1 MB
Parameters
| Parameter | Description |
|---|---|
| Queue |
|
| MessageGroupId | Specifies that a message belongs to a specific message group (FIFO Queues only). |
| DelaySeconds | The length of time (in seconds) to delay a specific message (0 to 900). |
| Include Current Visit Data | |
| Print Attribute Names | If attribute names are updated, the names in the payload reflect the update. |
Action - Send Customized Data to Queue (Advanced) and Send Customized Data to Queue (Advanced Batch)
Batch Limits
The Send Customized Data to Queue (Advanced Batch) action uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following thresholds is met:
- Maximum number of requests: 10
- Maximum time since oldest request: 5 minutes
- Maximum size of requests: 1 MB
Parameters
| Parameter | Description |
|---|---|
| Queue |
|
| MessageGroupId | Specifies that a message belongs to a specific message group (FIFO Queues only). |
| DelaySeconds | The length of time (in seconds) to delay a specific message (0 to 900). |
| Custom Message Definition | |
| Message Template Variables |
|
| Message Templates |
|
See Using Amazon SQS Message Attributes.
Vendor Documentation
This page was last updated: January 23, 2020