From bc87418f6ee84e23cdd496b342370163d99831fd Mon Sep 17 00:00:00 2001 From: Jeremy Pang Date: Mon, 16 Dec 2024 10:14:17 -0800 Subject: [PATCH 1/4] adding new documentation on supported integrations, and mappings --- .../destinations/catalog/actions-s3/index.md | 26 +++++++++++++++---- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/src/connections/destinations/catalog/actions-s3/index.md b/src/connections/destinations/catalog/actions-s3/index.md index 906f2cf0c6..433b914b18 100644 --- a/src/connections/destinations/catalog/actions-s3/index.md +++ b/src/connections/destinations/catalog/actions-s3/index.md @@ -25,6 +25,12 @@ The AWS S3 (Actions) destination enhances this capability by introducing configu * **Enhanced Delivery Controls**. The destination provides advanced options for batch size controls and file naming conventions. These controls can help optimize efficiency and simplify data retrieval workflows. +## Supported Integrations +The AWS S3 (Actions) Destination supports the following Segment features as supported native Destination integration points: +* rETL +* Classic and Linked Audiences +* Connections + ## Getting started Setting up the AWS S3 (Actions) destination is a straightforward process designed to help you configure and deploy standardized event data to your Amazon S3 bucket. Follow these steps to get started: @@ -36,7 +42,7 @@ Ensure you have the following in place before configuring the AWS S3 (Actions) d - IAM Access IDs: Prepare your AWS IAM ARN ID and IAM External ID. These will be needed to authenticate and authorize Segment with your S3 bucket. -### Step 1: Create an IAM role in the AWS console +## Step 1: Create an IAM role in the AWS console To set up the IAM role to properly authorize Segment with the AWS S3 (Actions) destination: 1. Log in to your AWS account. @@ -69,7 +75,7 @@ To set up the IAM role to properly authorize Segment with the AWS S3 (Actions) d "Effect": "Allow", "Principal": { "AWS": - "arn:aws:iam::595280932656:role/customer-s3-prod-action-destination-access" + "arn:aws:iam::595280932656:role/customer-s3-prod-action-destination-access" }, "Action": "sts:AssumeRole", "Condition": { @@ -81,8 +87,9 @@ To set up the IAM role to properly authorize Segment with the AWS S3 (Actions) d ] } ``` + ## Step 2: Add the AWS S3 (Actions) Destination in Segment -To finish the configuration, enable the AWS S3 (Actions) Destination in your workspace. +To finish the setup, enable the AWS S3 (Actions) Destination in your workspace: 1. Add the **AWS S3 (Actions)** destination from the Destinations tab of the catalog. 2. Select the data source you want to connect to the destination. @@ -93,8 +100,17 @@ To finish the configuration, enable the AWS S3 (Actions) Destination in your wor * Enter the ARN of the IAM role you created above. The ARN should follow the format `arn:aws:iam::ACCOUNT_ID:role/ROLE_NAME.` * Enter the IAM External ID, which is a value set in the Trust Relationship under your AWS IAM Role. 5. Enable the destination. -6. Verify the Segment data is stored in the S3 bucket by navigating to the `/` in the AWS console. {% include components/actions-fields.html settings="true"%} - +## Step 3: Configure the AWS S3 (Actions) Destination mappings +To finish the configuration, finalize the mappings of the new AWS S3 (Actions) Destination: + +1. Add a new **Sync to S3** Action into the destination. +2. Define the Event Trigger +3. Configure the Column Mappings that are needed, if any of the default columns are **not** needed, leave the value blank. You can also choose to add new mapping fields to set up any customized columns as needed. +4. Configure the Other Settings as needed: + * Enable Batching, Delimiter and File Extension are all required. + * **Note** If the audience_action or batch_size column names are not needed, these fields can be left blank so they do not output on the S3 file. +5. Enable the Mapping and start sending data! +6. Verify the Segment data is stored in the S3 bucket by navigating to the `/` in the AWS console. \ No newline at end of file From 747b73c7be33d06428ce013ce1453fd6813774bc Mon Sep 17 00:00:00 2001 From: Jeremy Pang Date: Mon, 16 Dec 2024 10:57:42 -0800 Subject: [PATCH 2/4] adding event trigger behavior --- src/connections/destinations/catalog/actions-s3/index.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/src/connections/destinations/catalog/actions-s3/index.md b/src/connections/destinations/catalog/actions-s3/index.md index 433b914b18..3ef4b67d7e 100644 --- a/src/connections/destinations/catalog/actions-s3/index.md +++ b/src/connections/destinations/catalog/actions-s3/index.md @@ -107,10 +107,8 @@ To finish the setup, enable the AWS S3 (Actions) Destination in your workspace: To finish the configuration, finalize the mappings of the new AWS S3 (Actions) Destination: 1. Add a new **Sync to S3** Action into the destination. -2. Define the Event Trigger +2. Define the Event Trigger. If multiple types are accepted in the Event Trigger, the generated files will automatically be split by type in S3 (i.e Track events file and Identifer events file). 3. Configure the Column Mappings that are needed, if any of the default columns are **not** needed, leave the value blank. You can also choose to add new mapping fields to set up any customized columns as needed. -4. Configure the Other Settings as needed: - * Enable Batching, Delimiter and File Extension are all required. - * **Note** If the audience_action or batch_size column names are not needed, these fields can be left blank so they do not output on the S3 file. +4. Configure the Other Settings as needed. 5. Enable the Mapping and start sending data! 6. Verify the Segment data is stored in the S3 bucket by navigating to the `/` in the AWS console. \ No newline at end of file From 7321bbc67f46f5f57eb5f2e716bd76070c426438 Mon Sep 17 00:00:00 2001 From: Jeremy Pang Date: Mon, 16 Dec 2024 14:20:24 -0800 Subject: [PATCH 3/4] adding fixes to suggestions --- .../destinations/catalog/actions-s3/index.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/src/connections/destinations/catalog/actions-s3/index.md b/src/connections/destinations/catalog/actions-s3/index.md index 3ef4b67d7e..5fde2ed21b 100644 --- a/src/connections/destinations/catalog/actions-s3/index.md +++ b/src/connections/destinations/catalog/actions-s3/index.md @@ -27,9 +27,9 @@ The AWS S3 (Actions) destination enhances this capability by introducing configu ## Supported Integrations The AWS S3 (Actions) Destination supports the following Segment features as supported native Destination integration points: -* rETL -* Classic and Linked Audiences -* Connections +* [Reverse ETL](/docs/connections/reverse-etl/) +* [Classic and Linked Audiences](/docs/engage/audiences/) +* [Connections](/docs/connections/) ## Getting started Setting up the AWS S3 (Actions) destination is a straightforward process designed to help you configure and deploy standardized event data to your Amazon S3 bucket. Follow these steps to get started: @@ -42,7 +42,7 @@ Ensure you have the following in place before configuring the AWS S3 (Actions) d - IAM Access IDs: Prepare your AWS IAM ARN ID and IAM External ID. These will be needed to authenticate and authorize Segment with your S3 bucket. -## Step 1: Create an IAM role in the AWS console +### Step 1: Create an IAM role in the AWS console To set up the IAM role to properly authorize Segment with the AWS S3 (Actions) destination: 1. Log in to your AWS account. @@ -88,7 +88,7 @@ To set up the IAM role to properly authorize Segment with the AWS S3 (Actions) d } ``` -## Step 2: Add the AWS S3 (Actions) Destination in Segment +### Step 2: Add the AWS S3 (Actions) Destination in Segment To finish the setup, enable the AWS S3 (Actions) Destination in your workspace: 1. Add the **AWS S3 (Actions)** destination from the Destinations tab of the catalog. @@ -104,11 +104,11 @@ To finish the setup, enable the AWS S3 (Actions) Destination in your workspace: {% include components/actions-fields.html settings="true"%} ## Step 3: Configure the AWS S3 (Actions) Destination mappings -To finish the configuration, finalize the mappings of the new AWS S3 (Actions) Destination: +To finish the configuration, add mappings to your new AWS S3 (Actions) Destination: 1. Add a new **Sync to S3** Action into the destination. -2. Define the Event Trigger. If multiple types are accepted in the Event Trigger, the generated files will automatically be split by type in S3 (i.e Track events file and Identifer events file). -3. Configure the Column Mappings that are needed, if any of the default columns are **not** needed, leave the value blank. You can also choose to add new mapping fields to set up any customized columns as needed. -4. Configure the Other Settings as needed. -5. Enable the Mapping and start sending data! +2. Define the Event Trigger. If multiple types are accepted in the Event Trigger, the generated files will automatically be split by type in S3 (for example, you might have a Track events file and an Identify events file). +3. Configure the Column Mappings. If you don't need any of the default columns, leave the value blank. You can also choose to add new mapping fields to set up customized columns as needed. +4. Configure any additional settings as required. +5. Enable the Mapping. 6. Verify the Segment data is stored in the S3 bucket by navigating to the `/` in the AWS console. \ No newline at end of file From 2a64fe8b2bfe8ca5a6c52dc0f75f2fa84b767b8c Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Mon, 16 Dec 2024 18:37:17 -0500 Subject: [PATCH 4/4] Apply suggestions from code review --- src/connections/destinations/catalog/actions-s3/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/connections/destinations/catalog/actions-s3/index.md b/src/connections/destinations/catalog/actions-s3/index.md index 5fde2ed21b..61acf60c98 100644 --- a/src/connections/destinations/catalog/actions-s3/index.md +++ b/src/connections/destinations/catalog/actions-s3/index.md @@ -103,7 +103,7 @@ To finish the setup, enable the AWS S3 (Actions) Destination in your workspace: {% include components/actions-fields.html settings="true"%} -## Step 3: Configure the AWS S3 (Actions) Destination mappings +### Step 3: Configure the AWS S3 (Actions) Destination mappings To finish the configuration, add mappings to your new AWS S3 (Actions) Destination: 1. Add a new **Sync to S3** Action into the destination. @@ -111,4 +111,4 @@ To finish the configuration, add mappings to your new AWS S3 (Actions) Destinati 3. Configure the Column Mappings. If you don't need any of the default columns, leave the value blank. You can also choose to add new mapping fields to set up customized columns as needed. 4. Configure any additional settings as required. 5. Enable the Mapping. -6. Verify the Segment data is stored in the S3 bucket by navigating to the `/` in the AWS console. \ No newline at end of file +6. Verify that Segment is sending data to your S3 bucket by navigating to `/` in the AWS console. \ No newline at end of file