Skip to main content

Preparing to run the Amazon QuickSight collector

Setting up pre-requisites for running the collector

Make sure that the machine from where you are running the collector meets the following hardware and software requirements.

Table 1.

Item

Requirement

Hardware (for on-premise runs only)

Note: The following specs are based upon running one collector process at a time. Please adjust the hardware if you are running multiple collectors at the same time.

RAM

8 GB

CPU

2 Ghz processor

Software (for on-premise runs only)

Docker

Click here to get Docker.

data.world specific objects (for both cloud and on-premise runs)

Dataset

You must have a ddw-catalogs dataset set up to hold your catalog files when you are done running the collector.

If you are using Catalog Toolkit , follow these instructions to prepare the datasets for collectors.

Network connection

Allowlist IPs and domains



Setting up authentication for cataloging Amazon Quicksight

Required permissions

You will need a user in AWS portal with the following permissions:

  • quicksight:ListAnalyses

  • quicksight:ListDashboards

  • quicksight:ListDataSets

  • quicksight:ListDataSources

  • quicksight:ListFolders

  • quicksight:ListFolderMembers

  • quicksight:DescribeAnalysis

  • quicksight:DescribeDashboard

  • quicksight:DescribeDataSet

  • quicksight:DescribeDataSource

  • quicksight:DescribeFolder

STEP 1: Creating a user

Detailed AWS documentation on IAM based policies topic is available here.

  1. Login to the AWS portal and navigate to IAM service. Under Users, click Add users to add an user. You can also select an existing user.

  2. On the next screen:

    1. Add user to the new or existing group which has required permissions.

    2. Attach policies directly or create a new policy with required permissions and click Next.

      An example on how to add permissions to catalog specific resources.

      {
	{
		{
			"Version": "2012-10-17",
			"Statement": [
				{
					"Sid": "VisualEditor0",
					"Effect": "Allow",
					"Action": "quicksight:DescribeAnalysis",
					"Resource": "arn:aws:quicksight:us-east-1:<aws-account-id>:analysis/<analysis-id>"
				},
				{
					"Sid": "VisualEditor1",
					"Effect": "Allow",
					"Action": [
						"quicksight:ListAnalyses",
						"quicksight:ListDataSources",
						"quicksight:ListDashboards",
						"quicksight:ListFolders",
						"quicksight:ListFolderMembers",
						"quicksight:ListDataSets"
					],
					"Resource": "*"
				},
				{
					"Sid": "VisualEditor2",
					"Effect": "Allow",
					"Action": "quicksight:DescribeDashboard",
					"Resource": "arn:aws:quicksight:us-east-1:<aws-account-id>:dashboard/<dashboard-id>"
				}
			]
		}
	}
}

  3. On the next screen review details and click Create user.

STEP 2: Obtaining access key for the user

Detailed AWS documentation on managing the access key is available here.

  1. Login to the AWS portal and navigate to IAM service.

  2. Under Users, select the user that plan to use for the collector.

  3. On the Security credentials tab, click Create access key.

  4. Select Application running outside AWS. Click Next.

  5. Add the optional Description tag. Click Create Access key.

  6. Note down the Access key ID and Secret access key. You will need this information for setting up the credentials file.

STEP 3: Setting up credentials file

If you are authenticating to Amazon QuickSight using the AWS credentials file, make sure you have the credentials file located at ~/.aws/credentials.

To set up credentials file:

  1. Install the AWS CLI.

  2. From the command line, run aws configure. This stores the credentials to ~/.aws/credentials.

STEP 4: Sign up for Amazon QuickSight

  • For the Amazon QuickSight collector to operate, you must have a subscription to Amazon QuickSight on the AWS account running the collector. Go to the sign-up for QuickSight page to learn more.

In this section: