Amazon S3

Amazon Simple Storage Service (S3) is a durable, efficient, secure, and scalable cloud storage service provided by Amazon Web Services (AWS) that can be accessed from anywhere. S3 uses the concept of buckets to store data such as images, videos, and documents, in multiple formats, organize that data, and retrieve it at any time from the cloud. It also provides you access control, versioning, and integration with other AWS services.

Hevo supports the replication of S3 data in the AVRO, CSV, JSON, TSV, and XML file formats. While ingesting data, Hevo automatically unzips any Gzipped files. Further, if any file is updated in the Source, Hevo re-ingests its entire contents as it is not possible to identify individual changes.

For all Pipelines created from Release 1.66 onwards, Hevo uploads the __hevo_source_modified_at column to the Destination as a metadata field in order to ascertain the currency of data during replication. As a result, this field is not visible or available for mapping via the Schema Mapper. However, for older Pipelines:

• If this field is displayed in the Source Event Type, you must ignore it and not try to map it to a Destination table column, else the Pipeline displays an error.

• If this field is already present in the Destination table, Hevo automatically loads the metadata to it.

You can continue to use the __hevo_source_modified_at field to create Transformations using the function event.getSourceModifiedAt(). Read Metadata Column __hevo_source_modified_at.

Accessing data in S3 buckets

In S3, access is defined through IAM policies and an IAM role or user. You can create an IAM user or an IAM role, and assign the IAM policy to either of these to define what data Hevo can access.

The following diagram illustrates the steps to do this and configure Amazon S3 as a Source for your Hevo Pipeline. These steps are explained in detail further in this document.

Prerequisites

• An active AWS account and an S3 bucket from which data is to be ingested exist.

• You are logged as an IAM user with permission to:

  • Create an IAM policy.

  • Create an IAM role (to generate the IAM role-based credentials) or create an IAM user (to generate the access credentials).

• The IAM role-based credentials or access credentials are available to authenticate Hevo on your AWS account.

• You are assigned the Team Administrator, Team Collaborator, or Pipeline Administrator role in Hevo, to create the Pipeline.

Create an IAM Policy

Create an IAM policy with the ListBucket and GetObject permissions. These permissions are required for Hevo to access data from your S3 bucket.

To do this:

1. Log in to the AWS IAM Console.

2. In the left navigation pane, under Access management, click Policies.

   

3. In the Policies page, click Create policy.

   

4. In the Specify permissions page, click JSON, and in the Policy editor section, paste the following JSON statements:

   

   Note: Replace the placeholder values in the commands below with your own. For example, <your_bucket_name> with Hevo-S3-bucket.

   {
       "Version": "2012-10-17",
       "Statement": [
           {
               "Sid": "VisualEditor0",
               "Effect": "Allow",
               "Action": [
                   "s3:GetObject",
                   "s3:ListBucket"
               ],
               "Resource": [
                   "arn:aws:s3:::<your_bucket_name>",
                   "arn:aws:s3:::<your_bucket_name>/*"
               ]
           }
       ]
   }
   

   The JSON statements allow Hevo to access and ingest data from the bucket name you specify.

   

5. At the bottom of the page, click Next.

   

6. In the Review and create page, specify the Policy name, and at the bottom of the page, click Create policy.

   

Obtain Amazon S3 Credentials

You must generate either access credentials or IAM role-based credentials and assign them the IAM policy to access and ingest your S3 data.

Generate IAM role-based credentials

Generate access credentials

Configure Amazon S3 as a Source

Perform the following steps to configure S3 as the Source in your Pipeline:

1. Click PIPELINES in the Navigation Bar.

2. Click + CREATE PIPELINE in the Pipelines List View.

3. In the Select Source Type page, select S3.

4. In the Configure your S3 Source page, specify the following:

   

   • Pipeline Name: A unique name for the Pipeline.

   • Source Setup: The credentials needed to allow Hevo to access data from your S3 account. Select one of the following setup methods:

     • Connect using IAM Role:

       

       • IAM Role ARN: The ARN that you retrieved above.

       • External ID: The external ID that you retrieved above.

       • Bucket Name: The name of the bucket from which you want to ingest data.

       • Bucket Region: The AWS region where the bucket is located.

     • Connect using Access Credentials:

       

       • Access Key ID: The access key that you retrieved above.

       • Secret Access Key: The secret access key that you retrieved above.

       • Bucket Name: The name of the bucket from which you want to ingest data.

       • Bucket Region: The AWS region where the bucket is located.

5. Click TEST & CONTINUE.

6. In the Data Root section, specify the following. The data root signifies the directories or files that contain your data. By default, the files are listed from the root directory.

   

   • Select the folders from which you want to ingest data.

     Note: If Hevo cannot retrieve the list of files from your S3 bucket, it displays the Path Prefix field. In this situation, you must specify the prefix of the path for the directory that contains your data. To specify the path prefixes for multiple files, you can click the Plus ( ) icon.

     

   • File Format: The format of the data file in the selected folders. Hevo supports AVRO, CSV, JSON, TSV, and XML formats.

     Note: You can select only one file format at a time. If your Source data is in a different format, you can export the data to either of the supported formats and then ingest the files.

     Based on the format you select, you must specify some additional settings:

     • Field Delimiter: The character on which the fields in each line are separated. For example, \t or ,.

       Note: This field is visible only for CSV data.

     • Create Events from child nodes: If enabled, Hevo loads each node present under the root node in the XML file as a separate Event. If disabled, Hevo combines and loads all nodes present in the XML file as a single Event.

       Note: This field is visible only for XML data.

     • Header Row: The row number in your CSV file whose data you want Hevo to use as column headers. Hevo starts ingesting data from the specified header row in your CSV file, thus skipping all the rows before it. Default value: 1.

       If you set the header row to 0, Hevo automatically generates the column headers during ingestion. Refer to the Example to understand this behavior.

       Note: This field is visible only for CSV data.

     • Include compressed files: If enabled, Hevo also ingests the compressed files of the selected file format from the folders. Hevo supports the tar.gz and zip compression types only. If disabled, Hevo does not ingest any compressed file present in the selected folders.

       Note: This field is visible for all supported data formats.

     • Create Event Types from folders: If enabled, Hevo ingests each subfolder as a separate Event Type. If disabled, Hevo merges subfolders into their parent folders and ingests them as one Event Type.

       Note: This field is visible for all supported data formats.

     • Convert date/time format fields to timestamp: If enabled, Hevo converts the date/time format within the files of selected folders to timestamp. For example, 07/11/2022, 12:39:23 to 1667804963. If disabled, Hevo ingests the datetime fields in the same format.

       Note: This field is visible for all supported data formats.

   • Click CONFIGURE SOURCE.

7. Proceed to configuring the data ingestion and setting up the Destination.

Data Replication

Note: The custom frequency must be set in hours as an integer value. For example, 1, 2, or 3 but not 1.5 or 1.75.

Example: Automatic Column Header Creation for CSV Tables

If you specify the Header Row as 0 while creating a Pipeline, Hevo automatically generates the column headers while ingesting data from the Source.

For example, consider the following data in CSV format, which has no column headers.

  CLAY COUNTY,32003,11973623
  CLAY COUNTY,32003,46448094
  CLAY COUNTY,32003,55206893
  CLAY COUNTY,32003,15333743
  SUWANNEE COUNTY,32060,85751490
  SUWANNEE COUNTY,32062,50972562
  ST JOHNS COUNTY,846636,32033,
  NASSAU COUNTY,32025,88310177
  NASSAU COUNTY,32041,34865452

When Hevo ingests this data, it auto-generates the column headers, as displayed below:

The record in the Destination appears as follows:

See Also

• How can I load different folders of an Amazon S3 bucket as separate Event Types?

• Ingestion Statuses for File-Based Sources

• Metadata Column __hevo_source_modified_at

Revision History

Refer to the following table for the list of key updates made to this page: