Skip to content

AWS S3 Actions - Adding new documentation on supported integrations, and mappings #7330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 18, 2024
Merged

AWS S3 Actions - Adding new documentation on supported integrations, and mappings #7330

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bc87418
adding new documentation on supported integrations, and mappings
jpang007 Dec 16, 2024
747b73c
adding event trigger behavior
jpang007 Dec 16, 2024
7321bbc
adding fixes to suggestions
jpang007 Dec 16, 2024
2a64fe8
Apply suggestions from code review
forstisabella Dec 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions src/connections/destinations/catalog/actions-s3/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* rETL
* [Reverse ETL](/docs/connections/reverse-etl/)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

* Classic and Linked Audiences
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Classic and Linked Audiences
* [Classic and Linked Audiences](/docs/engage/audiences/)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

* Connections
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Connections
* [Connections](/docs/connections/)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done


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

Expand All @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

To set up the IAM role to properly authorize Segment with the AWS S3 (Actions) destination:

1. Log in to your AWS account.
Expand Down Expand Up @@ -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": {
Expand All @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Step 2: Add the AWS S3 (Actions) Destination in Segment
### Step 2: Add the AWS S3 (Actions) Destination in Segment

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@forstisabella one of the reasons @jpang007 submitted this was to get all the steps in the side-nav:
Screenshot 2024-12-16 at 3 47 15 PM

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That makes sense! I think we shouldn't have the steps in the side nav to stay consistent with other destinations' docs!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

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.
Expand All @@ -93,8 +100,15 @@ 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 `<your_S3_bucket>/` 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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done


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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

4. Configure the Other Settings as needed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
4. Configure the Other Settings as needed.
4. Configure any additional settings as required.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

5. Enable the Mapping and start sending data!
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
5. Enable the Mapping and start sending data!
5. Enable the Mapping.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

6. Verify the Segment data is stored in the S3 bucket by navigating to the `<your_S3_bucket>/` in the AWS console.