Crawl Amazon QuickSight
Once you have configured the Amazon QuickSight permissions, you can establish a connection between Atlan and Amazon QuickSight.
To crawl metadata from Amazon QuickSight, review t
he order of operations and then complete the following steps.
Select the source
To select Amazon QuickSight as your source:
- In the top right of any screen in Atlan, navigate to +New and click New Workflow.
- From the Marketplace page, click QuickSight Assets.
- In the right panel, click Setup Workflow.
Provide your credentials
Choose your extraction method:
- In Direct extraction, Atlan connects to your database and crawls metadata directly.
- In Agent extraction, Atlan’s secure agent executes metadata extraction within the organization's environment.
Direct extraction method
To enter your Amazon QuickSight credentials:
- For Authentication, IAM User is the default authentication method.
- For AWS Access Key, enter the AWS access key you downloaded.
- For AWS Secret Key, enter the AWS secret key you downloaded.
- At the bottom, enter the Region and AWS Account ID of your Amazon QuickSight instance.
- Click the Test Authentication button to confirm connectivity to Amazon QuickSight.
- Once authentication is successful, navigate to the bottom of the screen and click Next.
Agent extraction method
Atlan supports using a Secure Agent for fetching metadata from Amazon QuickSight. To use a Secure Agent, follow these steps:
- Select the Agent tab.
- Configure the Amazon QuickSight data source by adding the secret keys for your secret store. For details on the required fields, refer to the Direct extraction section.
- Complete the Secure Agent configuration by following the instructions in the How to configure Secure Agent for workflow execution guide.
- Click Next after completing the configuration.
Configure the connection
To complete the Amazon QuickSight connection configuration:
-
Provide a Connection Name that represents your source environment. For example, you might use values like
production
,development
,gold
, oranalytics
. -
(Optional) To change the users who are able to manage this connection, change the users or groups listed under Connection Admins.
dangerIf you do not specify any user or group, no one will be able to manage the connection - not even admins.
-
Navigate to the bottom of the screen and click Next to proceed.
Configure the crawler
Before running the Amazon QuickSight crawler, you can further configure it.
On the Metadata Filters page, you can override the defaults for any of these options:
- For Fetch all assets without folder, click Yes to fetch assets not linked to any folders, including datasets, analyses, and dashboards, or click No to only fetch assets linked to folders.
- To select the folders you want to include in crawling, click Include Folders. (This will default to all folders, if none are specified.)
- To select the folders you want to exclude from crawling, click Exclude Folders. (This will default to no folders, if none are specified.)
If an asset appears in both the include and exclude filters, the exclude filter takes precedence.
Run the crawler
To run the Amazon QuickSight crawler, after completing the steps above:
- To check for any permissions or other configuration issues before running the crawler, click Preflight checks.
- You can either:
- To run the crawler once immediately, at the bottom of the screen, click the Run button.
- To schedule the crawler to run hourly, daily, weekly, or monthly, at the bottom of the screen, click the Schedule Run button.
Once the crawler has completed running, you will see the assets on Atlan's asset page! 🎉