AWS S3 Actions - Adding new documentation on supported integrations, and mappings #7330
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jpang007
requested review from
forstisabella and
tcgilbert
and removed request for
forstisabella
| @@ -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 | |||
There was a problem hiding this comment.
Suggested change
| * rETL | |
| * [Reverse ETL](/docs/connections/reverse-etl/) |
| ## Supported Integrations | ||
| The AWS S3 (Actions) Destination supports the following Segment features as supported native Destination integration points: | ||
| * rETL | ||
| * Classic and Linked Audiences |
There was a problem hiding this comment.
Suggested change
| * Classic and Linked Audiences | |
| * [Classic and Linked Audiences](/docs/engage/audiences/) |
| The AWS S3 (Actions) Destination supports the following Segment features as supported native Destination integration points: | ||
| * rETL | ||
| * Classic and Linked Audiences | ||
| * Connections |
There was a problem hiding this comment.
Suggested change
| * Connections | |
| * [Connections](/docs/connections/) |
| @@ -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 | |||
There was a problem hiding this comment.
I would prefer to keep all of the setup steps one heading level under the Getting started header to keep a consistent pattern across other integrations!
Suggested change
| ## Step 1: Create an IAM role in the AWS console | |
| ### Step 1: Create an IAM role in the AWS console |
| @@ -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 | |||
There was a problem hiding this comment.
Suggested change
| ## Step 2: Add the AWS S3 (Actions) Destination in Segment | |
| ### Step 2: Add the AWS S3 (Actions) Destination in Segment |
There was a problem hiding this comment.
@forstisabella one of the reasons @jpang007 submitted this was to get all the steps in the side-nav:
I think we should either show all in side-nav or none. That said, I will defer to @forstisabella on what we should use as the standard
There was a problem hiding this comment.
That makes sense! I think we shouldn't have the steps in the side nav to stay consistent with other destinations' docs!
| 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! |
There was a problem hiding this comment.
Suggested change
| 5. Enable the Mapping and start sending data! | |
| 5. Enable the Mapping. |
| 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. |
There was a problem hiding this comment.
Suggested change
| 4. Configure the Other Settings as needed. | |
| 4. Configure any additional settings as required. |
|
|
||
| 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. |
There was a problem hiding this comment.
Suggested change
| 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. | |
| 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. |
|
|
||
| 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). |
There was a problem hiding this comment.
Suggested change
| 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). | |
| 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). |
|
|
||
| {% 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: |
There was a problem hiding this comment.
Suggested change
| 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: |
tcgilbert
previously approved these changes
Dec 16, 2024
forstisabella
approved these changes
Dec 16, 2024
tcgilbert
approved these changes
Dec 17, 2024
|
Thank you for your contribution! Your pull request is merged, but may take a day or two to appear on the site. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Added in extra documentation on mapping functionality as well as the supported Segment Feature Integrations
Merge timing
ASAP once approved
Related issues (optional)
N/A