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/destinations/catalog/amazon-kinesis/index.md
+15-12Lines changed: 15 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,9 +8,7 @@ id: 57da359580412f644ff33fb9
8
8
> info "Amazon Kinesis is not compatible with IP Allowlisting"
9
9
> For more information, see the [IP Allowlisting](/docs/connections/destinations/#ip-allowlisting) documentation.
10
10
11
-
## Getting Started
12
-
13
-
11
+
## Getting started
14
12
15
13
To get started:
16
14
1. Create a Kinesis stream. Follow these [instructions](http://docs.aws.amazon.com/streams/latest/dev/learning-kinesis-module-one-create-stream.html){:target="_blank"} in order to create a new AWS Kinesis Stream.
@@ -53,15 +51,18 @@ To get started:
53
51
2. Enter the **Role Address**, **Stream Region**, **Stream Name**, and **Secret ID**.
54
52
* **NOTE:** For security purposes, Segment sets your Workspace ID as your Secret ID. If you're using a Secret ID different from your Workspace ID, reach out to our support team so they can change it to make your account more secure.
55
53
54
+
> success ""
55
+
> Segment's Amazon Kinesis destination only transmits data in JSON format.
56
+
56
57
## Page
57
-
If you're not familiar with the Segment Specs, take a look to understand what the [Page method](/docs/connections/spec/page/) does. An example call would look like:
58
+
If you're not familiar with the Segment Spec, take a look to understand what the [Page method](/docs/connections/spec/page/) does. An example call would look like:
58
59
59
60
```js
60
61
analytics.page();
61
62
```
62
63
63
64
## Identify
64
-
If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](/docs/connections/spec/identify/) does. An example call would look like:
65
+
If you're not familiar with the Segment Spec, take a look to understand what the [Identify method](/docs/connections/spec/identify/) does. An example call would look like:
If you're not familiar with the Segment Specs, take a look to understand what the [Track method](/docs/connections/spec/track/) does. An example call would look like:
75
+
If you're not familiar with the Segment Spec, take a look to understand what the [Track method](/docs/connections/spec/track/) does. An example call would look like:
Let's say you're connecting your Segment customer data stream to Kinesis Stream `arn:aws:kinesis:{region}:{account-id}:stream/{stream-name}`. If you send Segment the following in a `track` call:
84
+
### Data model
85
+
Let's say you're connecting your Segment customer data stream to Kinesis Stream `arn:aws:kinesis:{region}:{account-id}:stream/{stream-name}`. If you send Segment the following in a Track call:
Segment uses the `messageId` or the `userId || anonymousId` as the `PartitionKey`. The partition key is used by Amazon Kinesis to distribute data across shards. Amazon Kinesis segregates the data records that belong to a stream into multiple shards, using the partition key associated with each data record to determine which shard a given data record belongs to.
107
108
108
109
## Group
109
-
If you're not familiar with the Segment Specs, take a look to understand what the [Group method](/docs/connections/spec/group/) does.
110
+
If you're not familiar with the Segment Spec, take a look to understand what the [Group method](/docs/connections/spec/group/) does.
When you get started, Segment recommends using any of the open source [Kinesis tailing utility](https://github.com/search?utf8=%E2%9C%93&q=kinesis-tail){:target="_blank"} to validate that data is flowing correctly.
123
124
124
-
## Best Practices
125
+
## Best practices
126
+
127
+
The following best practices help you implement additional Amazon Kinesis functionality like encryption, the use of multiple data sources, and more efficient data transmission.
125
128
126
129
### Updating IAM role permissions for encryption
127
130
Extra permissions need to be added to the IAM role if using at-rest encryption on the Kinesis stream. An updated role policy like below resolves issues when submitting PutRecords into Kinesis stream using encryption:
@@ -141,7 +144,7 @@ Extra permissions need to be added to the IAM role if using at-rest encryption o
141
144
}
142
145
```
143
146
144
-
### Multiple Sources
147
+
### Multiple sources
145
148
If you have multiple sources using Kinesis/Firehose, you have two options:
0 commit comments