Skip to content

Commit e8261d1

Browse files
committed
DOC-469 Adding additional context to instructions
1 parent 0c7ac60 commit e8261d1

File tree

1 file changed

+27
-21
lines changed
  • src/connections/storage/catalog/aws-s3

1 file changed

+27
-21
lines changed

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

Lines changed: 27 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -246,27 +246,17 @@ For each source in the scenario, complete the steps described in [Migrate an exi
246246

247247

248248
## Migrate an existing destination using public-api
249-
This procedure uses Segment's public-api to migrate your destinations from Amazon S3 to the AWS S3 destination. For more information about the public-api, please see the [Getting Started](https://api.segmentapis.com/docs/guides/#getting-started) guide.
249+
This procedure uses Segment's public-api to migrate your destinations to the 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.
250250

251-
To migrate from the Amazon S3 destination to the AWS S3 destination using the public-api:
251+
To migrate to the AWS S3 destination using the public-api:
252252

253-
1. Add the **AWS S3** destination and add the AWS Region and IAM role ARN. For the bucket name, enter `<YOUR_BUCKET_NAME>/segment-logs/test`. 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.
254-
2. Get a list of destinations or an individual destination. 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/>
255-
```shell
256-
curl -vvv --location --request GET https://api.segmentapis.com/destinations?pagination.count=1 \
257-
--header 'Content-Type: application/json' \
258-
--header 'Authorization: Bearer ...' \
259-
--data-raw '
260-
```
261-
<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/>
262-
```shell
263-
curl -vvv --location --request GET https://api.segmentapis.com/destinations/$DESTINATION_ID \
264-
--header 'Content-Type: application/json' \
265-
--header 'Authorization: Bearer ...' \
266-
--data-raw '
267-
```
268-
269-
3. Create the new AWS S3 destination using the `create destination` call. Below is an example of the parameters: <br/>
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/>
270260
```json
271261
{
272262
"sourceId": "rh5BDZp6QDHvXFCkibm1pR",
@@ -288,12 +278,28 @@ curl -vvv --location --request PATCH https://api.segmentapis.com/destinations/$D
288278
--data-raw '
289279
{
290280
"destinationId": "$DESTINATION_ID",
291-
"enabled": true
281+
"enabled": false
292282
}
293283
' | jq
294284
```
295285
<br/>
296-
4. After creating your new AWS S3 destination, delete the Amazon S3 sources using the following command (replacing `$DESTINATION_ID` with the ID of your Amazon S3 destination):
286+
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/>
288+
```shell
289+
curl -vvv --location --request GET https://api.segmentapis.com/destinations?pagination.count=1 \
290+
--header 'Content-Type: application/json' \
291+
--header 'Authorization: Bearer ...' \
292+
--data-raw '
293+
```
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/>
295+
```shell
296+
curl -vvv --location --request GET https://api.segmentapis.com/destinations/$DESTINATION_ID \
297+
--header 'Content-Type: application/json' \
298+
--header 'Authorization: Bearer ...' \
299+
--data-raw '
300+
```
301+
302+
9. Disable the Amazon S3 destinations using the following command (replacing `$DESTINATION_ID` with the ID of your Amazon S3 destination you found in step ):
297303

298304
```shell
299305
curl -vvv --location --request PATCH https://api.segmentapis.com/destinations/$DESTINATION_ID \

0 commit comments

Comments
 (0)