Amazon S3 Connector Setup Guide | Server-Side Connectors

Batch Limits

This connector 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: 100,000
Maximum time since oldest request: 60 minutes
Maximum size of requests: 100 MB

Configuration

Go 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:

Authentication Type
- Select the authentication type. Available options are: STS and Access Key.
  - STS: Requires Assume Role: ARN and Assume Role: Session Name fields.
  - Access Key: Requires AWS Access Key and AWS Secret Access Key fields.
Region
- Required. Select a region.
STS - Assume Role: ARN
- Required for STS authentication. Provide the Amazon Resource Name (ARN) of the role to assume.
- For example, arn:aws:iam:222222222222:role/myrole.
- For more information, see AWS Identity and Access Management: Switch to an IAM role (AWS API).
STS - Assume Role: Session Name
- The name of the session for the role to assume.
- Must be between 2 and 64 characters.
STS - Assume Role: External ID
- Provide a third-party external identifier.
- For more information, see AWS Identity and Access Management: Access to AWS accounts owned by third parties.
Access Key - AWS Access Key
- Required for Access Key authentication. Provide the AWS access key.
Access Key - AWS Secret Access Key
- Required for Access Key authentication. Provide the AWS secret access key.

Actions

Action Name	AudienceStream	EventStream
Send Entire Event Data	✗	✓
Send Custom Event Data	✗	✓
Send Entire Visitor Data	✓	✗
Send Custom Visitor Data	✓	✗

Enter a name for the action and select the action type from the drop-down menu.

The following section describes how to set up parameters and options for each action.

Send Entire Event Data

Parameters

Parameter	Description
Bucket	Select the Amazon S3 bucket or provide a custom value.
File Path	Specify the path to the S3 object where you want the data to be appended.
File Path Suffix	If you want to dynamically add a suffix to the file path, for example, an attribute with the current timestamp, select it here. If multiple suffix values are provided, they will be separated by an underscore character.
Record Suffix	A suffix to add on the end of each record as a delimiter. The default is `Newline`. Available options are `Newline` and `No Delimiter`.
Overwrite Existing File	If selected, replaces the existing S3 object with the current data. If not selected, appends the data instead.
Print Attribute Names	By default, the attribute keys are used. If you want to use the attribute names as keys instead, enable this checkbox. Consider that the payload names will reflect the update if the attribute names are updated.
Batch Time To Live	The time-to-live (TTL) in minutes. Must be between `1` and `60`. The default is `60` minutes.

Send Custom Event Data

Parameters

Parameter	Description
Bucket	Select the Amazon S3 bucket or provide a custom value.
File Path	Specify the path to the S3 object where you want the data to be appended.

Message Data

Parameter	Description
File Path Suffix	If you want to dynamically add a suffix to the file path, for example, an attribute with the current timestamp, select it here. If multiple suffix values are provided, they will be separated by an underscore character.
Record Suffix	A suffix to add on the end of each record as a delimiter. The default is `Newline`. Available options are `Newline` and `No Delimiter`.
Overwrite Existing File	If selected, replaces the existing S3 object with the current data. If not selected, appends the data instead.
Batch Time To Live	The time-to-live (TTL) in minutes. Must be between `1` and `60`. The default is `60` minutes.
Template Variables	Provide template variables as data input for Templates. See Template Variables Guide documentation for usage examples. Name nested template variables with the dot notation. Example: `items.name.` Nested template variables are typically built from data layer list attributes.
Templates	Provide templates to be referenced in Event Parameters. For more information, see Templates Guide. Templates are injected by name with double curly braces into supported fields, for example: `{{SomeTemplateName}}`.

Send Entire Visitor Data

Parameters

Parameter	Description
Bucket	Select the Amazon S3 bucket or provide a custom value.
File Path	Specify the path to the S3 object where you want the data to be appended.
File Path Suffix	If you want to dynamically add a suffix to the file path, for example, an attribute with the current timestamp, select it here. If multiple suffix values are provided, they will be separated by an underscore character.
Record Suffix	A suffix to add on the end of each record as a delimiter. The default is `Newline`. Available options are `Newline` and `No Delimiter`.
Overwrite Existing File	If selected, replaces the existing S3 object with the current data. If not selected, appends the data instead.
Print Attribute Names	By default, the attribute keys are used. If you want to use the attribute names as keys instead, enable this checkbox. Consider that the payload names will reflect the update if the attribute names are updated.
Batch Time To Live	The time-to-live (TTL) in minutes. Must be between `1` and `60`. The default is `60` minutes.
Include All Visitor Events	Select to include current visit data with visitor data.

Send Custom Visitor Data

Parameters

Parameter	Description
Bucket	Select the Amazon S3 bucket or provide a custom value.
File Path	Specify the path to the S3 object where you want the data to be appended.

Message Data

Parameter	Description
File Path Suffix	If you want to dynamically add a suffix to the file path, for example, an attribute with the current timestamp, select it here. If multiple suffix values are provided, they will be separated by an underscore character.
Record Suffix	A suffix to add on the end of each record as a delimiter. The default is `Newline`. Available options are `Newline` and `No Delimiter`.
Overwrite Existing File	If selected, replaces the existing S3 object with the current data. If not selected, appends the data instead.
Batch Time To Live	The time-to-live (TTL) in minutes. Must be between `1` and `60`. The default is `60` minutes.
Template Variables	Provide template variables as data input for Templates. See Template Variables Guide documentation for usage examples. Name nested template variables with the dot notation. Example: `items.name.` Nested template variables are typically built from data layer list attributes.
Templates	Provide templates to be referenced in Event Parameters. For more information, see Templates Guide. Templates are injected by name with double curly braces into supported fields, for example: `{{SomeTemplateName}}`.