Skip to main content

Amazon S3 Metadata

The Qlik Amazon S3 Metadata Connector uses the Amazon S3 API to access your Amazon S3 metadata, such as the names of files and subfolders in your Amazon S3 bucket.

Note: This Amazon S3 Metadata connector is only available in Qlik Sense SaaS. For the client managed version, see Qlik Web Connectors: Amazon S3.

Supported offerings

  • Qlik Sense Business
  • Qlik Sense Enterprise SaaS

Ways to access your data

You need to authenticate the connector with your Amazon S3 account credentials: access key, secret key, region, and bucket name.

Creating a connection and selecting data

Loading data from tables

After you authenticate the connector with your account credentials, use the tables to fetch your data.

Do the following:

  1. Under the list of connections, find your Amazon S3 Metadata connection. Click Data Selection Select tables.

  2. Enter the required table parameters and click Preview data.

    Required parameters are marked with an asterisk (*).

  3. The table fields are displayed under the Data preview tab. You can select fields individually by selecting the box beside each field name.

  4. Select Insert script after you have made your selection.

Below are use cases for some of the available tables:

Tables that can be loaded
Table Description
ListBuckets Fetches a list of buckets from your Amazon S3 account.
List Fetches a list of folders in a bucket and the objects inside those folders. You need the bucket region and bucket name to run this table.
ListObjects Fetches a list of objects in a bucket. You need the bucket region and bucket name to run this table.
Metadata Returns metadata for the object.
InProgressUploads Fetches a list of uploads currently in progress.

Reference - Amazon S3 documentation

You can refer to the Amazon S3 API documentation to learn more about the requirements and restrictions imposed by the Amazon S3 REST API.

Amazon S3 REST API Introduction

Troubleshooting

You receive generic access error messages

There are multiple generic access error messages: "cannot open file", "no fields to load", etc. that can occur.

Possible cause  

You have incorrectly entered Amazon S3 credentials or file/bucket information.

Proposed action  

Ensure that your Amazon S3 account credentials have been correctly entered:

  • Check that your Amazon S3 access key, secret key, region and bucket name are accurately entered in your connector configuration.
  • Check that your load script correctly references your connection name, file name, file path, and file formatting information.
  • Ensure that the file is available in your Amazon S3 instance at the specified file path.

You receive an error message that you have reached the API rate limit

Possible cause  

You have exceeded the API limits that are imposed by the Amazon S3 API.

Proposed action  

To reduce the impact of reaching the API rate limits, develop your app with the following in mind:

  • Extract only the data you need.
  • Reload one Amazon S3-based application at a time.
  • Ensure that loops in your script that make API calls will not result in infinite loops.