Skip to content

Commit 0266f63

Browse files
committed
vale edits, callout about data type
1 parent 83435e5 commit 0266f63

File tree

1 file changed

+15
-12
lines changed
  • src/connections/destinations/catalog/amazon-kinesis

1 file changed

+15
-12
lines changed

src/connections/destinations/catalog/amazon-kinesis/index.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@ id: 57da359580412f644ff33fb9
88
> info "Amazon Kinesis is not compatible with IP Allowlisting"
99
> For more information, see the [IP Allowlisting](/docs/connections/destinations/#ip-allowlisting) documentation.
1010
11-
## Getting Started
12-
13-
11+
## Getting started
1412

1513
To get started:
1614
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:
5351
2. Enter the **Role Address**, **Stream Region**, **Stream Name**, and **Secret ID**.
5452
* **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.
5553

54+
> success ""
55+
> Segment's Amazon Kinesis destination only transmits data in JSON format.
56+
5657
## 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:
5859

5960
```js
6061
analytics.page();
6162
```
6263

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

6667
```js
6768
analytics.identify('97980cfea0085', {
@@ -71,7 +72,7 @@ analytics.identify('97980cfea0085', {
7172
```
7273

7374
## Track
74-
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:
7576

7677
```js
7778
analytics.track("User Registered", {
@@ -80,8 +81,8 @@ analytics.track("User Registered", {
8081
});
8182
```
8283

83-
### Data Model
84-
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:
8586
```json
8687
{
8788
"userId": "user_1",
@@ -106,9 +107,9 @@ const request = kinesis.putRecord(payload)
106107
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.
107108

108109
## 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.
110111

111-
An example group call is shown below:
112+
An example Group call is shown below:
112113
```js
113114
analytics.group("0e8c78ea9d9dsasahjg", {
114115
name: "group_name",
@@ -121,7 +122,9 @@ analytics.group("0e8c78ea9d9dsasahjg", {
121122
## Troubleshooting
122123
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.
123124

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

126129
### Updating IAM role permissions for encryption
127130
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
141144
}
142145
```
143146

144-
### Multiple Sources
147+
### Multiple sources
145148
If you have multiple sources using Kinesis/Firehose, you have two options:
146149

147150
### Attach multiple sources to your IAM role

0 commit comments

Comments
 (0)