You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/connections/storage/catalog/aws-s3/index.md
+17-18Lines changed: 17 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -242,21 +242,20 @@ For example:
242
242
243
243
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.
244
244
245
-
## Migrate an existing destination using public-api
246
-
This procedure uses Segment's public-api to migrate your existing Amazon S3 destination to the new AWS S3 destination. For more information about the public-api, please see the [public-api Getting Started](https://api.segmentapis.com/docs/guides/#getting-started) guide.
245
+
## Migrate an existing destination using Public API
246
+
This procedure uses Segment's Public API to migrate your existing Amazon S3 destination to the new AWS S3 destination. For more information about the Public API, see the [Public API Getting Started Guide](https://api.segmentapis.com/docs/guides/#getting-started).
247
247
248
248
> warning "Avoid overwriting data"
249
249
> Sending data to the same S3 location from both the existing Amazon S3 destination and the AWS S3 destinations will overwrite data in your instance of S3. To avoid this, disable your Amazon S3 destination after you create your AWS S3 destination.
250
250
251
-
To migrate to the AWS S3 destination using the public-api:
251
+
To migrate to the AWS S3 destination using the Public API:
252
252
253
-
1. Create a new S3 bucket and IAM role using either the [AWS console](#create-an-iam-role-in-the-aws-console) or the [AWS CLI](#create-an-iam-role-using-the-aws-cli).
254
-
2. Open the Segment app and add the **AWS S3** destination from the Storage Destinations tab of the catalog.
255
-
3. Configure your AWS S3 destination. For the bucket name, enter `<YOUR_BUCKET_NAME>/segment-logs/test`.
256
-
4. Enable the destination, and verify data is received at `<YOUR_BUCKET_NAME>/segment-logs/test/segment-logs`. If the folder receives data, continue to the next step. If you don't see log entries, check the trust relationship document and IAM policy attached to the role.
257
-
5. Update the bucket name in the Segment app to `<YOUR_BUCKET_NAME>`.
258
-
6. After an hour, disable your original Amazon S3 destination.
259
-
7. Create the new AWS S3 destination using the `create destination` call. Below is an example of the parameters: <br/>
253
+
1. Open the Segment app, select the Connections tab and then select Catalog.
254
+
2. From the Catalog, select the Storage Destinations tab, and select the **AWS S3** destination.
255
+
3. On the AWS S3 destination page, click the **Configure AWS S3** button.
256
+
4. Configure your AWS S3 destination. When asked for the bucket name, enter `<YOUR_BUCKET_NAME>/segment-logs/test`.
257
+
5. Enable the destination, and verify data is received at `<YOUR_BUCKET_NAME>/segment-logs/test/segment-logs`. <br/>**Note:** If the folder receives data, continue to the next step. If you don't see log entries, check the trust relationship document and IAM policy attached to the role.
258
+
6. Create the new AWS S3 destination using the [`create destination`](https://api.segmentapis.com/docs/connections/destinations/#create-destination) call. The `sourceId`, `metadataId`, and `settings` parameters are required. An example of the parameters is below: <br/>
8. Identify the source IDs for your old Amazon S3 destination(s). You can use the public-api to return information about a list of your Amazon S3 destinations or an individual destination. <br/>
287
-
To return a list of all of your Amazon S3 destinations, use the `list desintations` call and filter the results using metadata id `54f418c3db31d978f14aa925` or slug `amazon-s3`: <br/>
286
+
To return a list of all of your Amazon S3 destinations, use the [`list destinations`](https://api.segmentapis.com/docs/connections/destinations/#list-destinations) call and filter the results using metadata id `54f418c3db31d978f14aa925` or slug `amazon-s3`: <br/>
288
287
```shell
289
288
curl -vvv --location --request GET https://api.segmentapis.com/destinations?pagination.count=1 \
290
289
--header 'Content-Type: application/json' \
291
290
--header 'Authorization: Bearer ...' \
292
291
--data-raw '
293
292
```
294
-
<br/> To return the information for an individual Amazon S3 destination, use the `get destination` call, using the destination ID for your individual Amazon S3 destination (**Note:** Destination IDs are visible in the Segment app, in the settings for the source.) <br/>
293
+
<br/> To return the information for an individual Amazon S3 destination, use the [`get destination`](https://api.segmentapis.com/docs/connections/destinations/#get-destination) call, using the destination ID for your individual Amazon S3 destination (**Note:** The destination ID for your Amazon S3 source is visible in the Segment app, on the destination's settings page) <br/>
295
294
```shell
296
295
curl -vvv --location --request GET https://api.segmentapis.com/destinations/$DESTINATION_ID \
You can validate that your configured your migrated source correctly in the Settings section of the AWS S3 destination page in the Segment app.
321
320
322
-
> success "Source editing permissions required"
323
-
> In-app source validation is restricted to users with source editing permissions (for example, users with Workspace Owner, Source Admin, or Workspace Admin roles). For more information about roles in the Segment app, please see the [Roles documentation](/docs/segment-app/iam/roles/).
321
+
> note "Source editing permissions required"
322
+
> In-app source validation is restricted to users with source editing permissions (for example, users with Workspace Owner, Source Admin, or Workspace Admin roles). For more information about roles in the Segment app, see the [Roles documentation](/docs/segment-app/iam/roles/).
324
323
325
324
To verify that you migrated your source correctly:
326
325
1. Open the Segment app and select the AWS S3 destination.
327
326
2. On the Settings page, verify that your Region, Bucket Name, and IAM Role ARN are all correct.
328
327
3. Click **Validate.**
329
-
4. A success/failure code appears.
328
+
4. A code indicating if the validation was successful or failed appears. To troubleshoot failed validation codes, see the [Troubleshooting](#troubleshooting) section.
330
329
331
-
> note "`dummy-object.txt`"
332
-
> 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.
330
+
> info "dummy-object.txt"
331
+
> In order to test your bucket, Segment will upload a text file, `dummy-object.txt`, to the `segment-logs` folder in your S3 bucket. After you've completed the validation process, feel free to delete this file.
333
332
334
333
### Troubleshooting
335
334
336
-
The following table outlines some of the error codes the validation tool may display and possible reasons for the error.
335
+
The following table outlines some of the error codes the validation tool may display and possible reasons for the error. For assistance with correcting any of these error codes, contact [Segment support](mailto:[email protected]).
0 commit comments