Configure the Amazon Kinesis Data Streams target
- Last UpdatedJun 25, 2025
- 2 minute read
Complete the procedure below to configure the Amazon Kinesis Data Streams target and verify that you can write to the Amazon Kinesis Data Streams.
-
Ensure that the AWS Access Key that you enter in the PI Integrator for Business Analytics target configuration is for an AWS user who has the following permissions on the Amazon Kinesis Data Streams target: ListStreams, DescribeStream, PutRecord/PutRecords actions.
-
Create the Amazon Kinesis Data Streams target before you configure it. For more information, see Add a publish target.
-
On the Administration page, click the Targets tab. Then select the target in the Publish Targets list.
Note: If you have already selected your target, skip to the next step.
-
Refer to the following table and enter the required information. Click the buttons as they become enabled.
Parameter
Description
AWS Access Key ID
Used in combination with Secret Access Key to authenticate requests to the stream.
AWS Secret Access Key
Used in combination with AWS Access Key ID to authenticate requests to the stream.
Kinesis Data Stream
Name of the Amazon Kinesis Data Stream to which data is written.
Region
If the desired region is not included in the dropdown list, try typing it manually in the input field.
Verify that the format is a valid Amazon region code, and not the region name. The format should match the format of the supported regions below:
Default: us-east-1
Supported:
af-south-1
ap-east-1
ap-northeast-1
ap-northeast-2
ap-northeast-3
ap-south-1
ap-south-2
ap-southeast-1
ap-southeast-2
ap-southeast-3
ap-southeast-4
ca-central-1
ca-west-1
cn-north-1
cn-northwest-1
eu-central-1
eu-central-2
eu-north-1
eu-south-1
eu-south-2
eu-west-1
eu-west-2
eu-west-3
il-central-1
me-central-1
me-south-1
sa-east-1
us-east-1
us-east-2
us-west-1
us-west-2
Unsupported Regions
Geographic areas this client cannot communicate with:
AWS GovCloud (US-East)
AWS GovCloud (US-West)
US ISOB East Ohio
US ISO East Virginia
US ISO West Colorado
AWS Local Zones are not supported
Data Storage Format
(Optional) File format in which data is stored. The default is Parquet. Other options are JSON and JSON Indent.
Compression
(Optional) Compression type on message sets. The default is None. Other options are gzip and Snappy.
Allow Nulls
(Optional) When selected, null values are valid.
-
Click Verify Writer.
-
Click Save Changes.
-
Give users access to the Amazon Kinesis Data Streams target. For more information, see Grant access to targets.
Note: Any region not specifically listed in the supported regions list above is considered an unsupported region (the region is not guaranteed to be supported.) AVEVA supports these supported regions at the time of this release and cannot guarantee support for newly added regions.