Skip to content

Commit fbc536e

Browse files
committed
DOC-469 First pass of validation section
1 parent df27ae7 commit fbc536e

File tree

1 file changed

+25
-1
lines changed
  • src/connections/storage/catalog/aws-s3

1 file changed

+25
-1
lines changed

src/connections/storage/catalog/aws-s3/index.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ redirect_from:
55
hide-personas-partial: true
66
---
77

8-
98
## Differences between the Amazon S3 destination and the AWS S3 destination
109

1110
The AWS S3 destination provides a more secure method of connecting to your S3 buckets. It uses AWS's own IAM Roles to define access to the specified buckets. For more information about IAM Roles, see Amazon's [IAM role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html){:target="_blank"} documentation.
@@ -245,6 +244,31 @@ For example:
245244

246245
For each source in the scenario, complete the steps described in [Migrate an existing destination](#migrate-an-existing-destination), and ensure that you have separate IAM Roles and Permissions set for staging and production use.
247246

247+
### Test your migrated source
248+
You can validate that your configured your migrated source correctly using a button in the Settings section of the AWS S3 destination.
249+
250+
To verify that you migrated your source correctly:
251+
1. Open the Segment app and select the AWS S3 destination.
252+
2. On the Settings page, verify that your Region, Bucket Name, and IAM Role ARN are all correct.
253+
3. Click **Validate.**
254+
4. A success/failure code appears.
255+
256+
> note "`dummy-object.txt`"
257+
> In order to test your bucket, Segment will upload a text file, `dummy-object.txt`, to your `segment-logs` folder. After you've completed the validation process, feel free to delete this file.
258+
259+
#### Troubleshooting
260+
261+
The following table outlines some of the error codes the validation tool may display, as well as possible reasons for the error.
262+
263+
| Frontend error message | Backend error message | Likely cause of the error |
264+
| ---------------------- | --------------------- | ------------------------- |
265+
| Unknown Error. Please try again. If the problem persists, please contact [Segment support](mailto:[email protected]) | failed to assume intermediate role | Fail to assume intermediate role |
266+
| Access Denied. Please configure External ID in the AWS IAM Console. [Learn more](#create-an-iam-role-in-the-aws-console). | role not configured with external id | Successfully assumed customer's role, role doesn't have external ID |
267+
| Unknown Error. Please follow [instructions](#create-an-iam-role-in-the-aws-console) to set up the AWS S3 destination. If the problem persists, please contact [Segment support](mailto:[email protected]). | failed to assume role | Fail to assume customer’s role without external ID & returned an error code that is not error 403 |
268+
| Access Denied. Please configure External ID in the AWS IAM Console. [Learn more](#create-an-iam-role-in-the-aws-console). | assume role failed with Access Denied | Fail to assume customer’s role without external ID & returned error 403 |
269+
| Access Denied. Please add PutObject permissions to the IAM role in the AWS IAM Console. [Learn more](). | upload dummy object failed with Access Denied | Fail to upload the dummy object to customer's S3 bucket & an error code that is not error 403. |
270+
| Unknown Error. Please follow [instructions](#create-an-iam-role-in-the-aws-console) to set up the AWS s3 destination. If the problem persists, please contact [Segment support](mailto:[email protected]). | failed to upload dummy object | Fail to upload the dummy object to customer's S3 bucket & an error code that is not error 403. |
271+
248272

249273
## Data format
250274

0 commit comments

Comments
 (0)