Configure the Amazon S3 target
- Last UpdatedJun 25, 2025
- 4 minute read
Complete the procedure below to configure the Amazon S3 target and verify that you can write to the Amazon S3 database.
-
Ensure that the AWS Access Key you enter in the PI Integrator for Business Analytics target configuration is for an AWS user who has the following permissions on the Amazon S3 target: s3:ListBucket, s3:PutObject, s3:GetObject, s3:DeleteObject, and s3:GetBucketLocation.
-
If you are using the Amazon Athena database, then 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 database: Athena – Read and Write. The user must be granted all read-related and write-related permissions.
Server
Actions
Resources
Request conditions
Athena
* (all actions)
Any resource of type = workgroup
None
Glue
* (all actions)
All Resources
None
-
Athena – Read and Write. The user must be granted all read-related and write-related permissions.Read and Write. The user must be granted all read-related and write-related permissions.
-
Glue – Read and Write. The user must be granted all read-related and write-related permissions.
Note: In order to write to an Amazon Athena database, the database must be in the same region as the Amazon S3 bucket. Writing to an Amazon Athena database is only supported when using the Parquet data storage type.
-
-
Create the Amazon S3 target before you configure it. For more information, see Add a publish target.
Complete the procedure below to configure the Amazon S3 target and verify that you can write to the Amazon S3 bucket.
-
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
Data Storage Format
File format in which data is stored. The default is Parquet. Other options are: JSON, JSON Indent, and Text.
Compression
Compression type on message sets. The default is None. Other options are gzip and Snappy.
Note: Choose a compression setting to get better performance.
AWS Access Key ID
Used in combination with Secret Access Key to authenticate requests to the bucket.
AWS Secret Access Key
Used in combination with Amazon Access Key ID to authenticate requests to the bucket.
Include Header
When selected, column names are added to the beginning of the file.
Field Delimiter
Character(s) that separate the data fields in the row. By default, a tab (\t), separates the fields.
Region
Listed below are the geographic area this client communicates with; 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-2
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.
Row Delimiter
Character(s) that separate the data rows. By default, a new line separates the data rows. The characters that specify a new line are platform specific. The default automatically provides the correct characters for the environment.
Bucket Name
S3 bucket that data is uploaded to.
Folder Path
(Optional) Specify with key name prefixes and forward slashes (/) to organize views in S3. The key name prefixes must exist in S3 before you configure the target. For more information about creating a logical hierarchy in S3, see Object Key and Metadata.
Allows Nulls
When selected, null values are valid.
Maximum Rows/Objects
(Optional) Maximum number of objects in a file. Default: 100,000 rows. See the Note below.
Maximum File Size (KB)
(Optional) Maximum file size in kilobytes. Default: 10,000 KB. See the Note below.
Maximum Update Time (sec)
(Optional) Maximum time to update the database, in seconds, before the writer times out. Default: 86,400 seconds (1 day). See the Note below.
Amazon Athena Database
(Optional) Name of the Amazon Athena database that data is written to.
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.
Note: Specify one of the three optional parameters: Maximum Rows/Objects, Maximum File Size, or Maximum Update Time. If none are specified, then views will always be published to the same file and a new file will never be created.
The three parameters have default values and all defaults are enforced. The first parameter reached will trigger the creation of a new file. To standardize on one parameter for new file creation, enter very large values that are impossible to reach for the remaining parameters.
-
Click Verify Writer.
-
Click Save Changes.
-
Give users access to the Amazon S3 target. For more information, see Grant access to targets.