Skip to main content
QuickSight

QuickSight

PROD
In this section, we provide guides and references to use the QuickSight connector. Configure and schedule QuickSight metadata and profiler workflows from the OpenMetadata UI:

​
How to Run the Connector Externally

To run the Ingestion via the UI you’ll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment. If, instead, you want to manage your workflows externally on your preferred orchestrator, you can check the following docs to run the Ingestion Framework anywhere.

External Schedulers

Get more information about running the Ingestion Framework Externally

​
Requirements

AWS QuickSight Permissions To execute metadata extraction and usage workflow successfully the IAM User should have enough access to fetch required data. Following table describes the minimum required permissions
#AWS QuickSight Permission
1DescribeDashboard
2ListAnalyses
3ListDataSources
4ListDashboards
5DescribeAnalysis
6DescribeDataSet
7ListDataSets
8DescribeDataSource
Here is how to add Permissions to an IAM user.
  • Navigate to the IAM console in the AWS Management Console.
  • Choose the IAM user or group to which you want to attach the policy, and click on the “Permissions” tab.
  • Click on the “Add permissions” button and select “Attach existing policies directly”.
  • Search for the policy by name or by filtering the available policies, and select the one you want to attach.
  • Review the policy and click on “Add permissions” to complete the process.
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "quicksight:DescribeDashboard",
                "quicksight:ListAnalyses",
                "quicksight:ListDataSources",
                "quicksight:ListDashboards",
                "quicksight:DescribeAnalysis",
                "quicksight:DescribeDataSet",
                "quicksight:ListDataSets",
                "quicksight:DescribeDataSource"
            ],
            "Resource": "*"
        }
    ]
}

​
Python Requirements

We have support for Python versions 3.9-3.11
To run the QuickSight ingestion, you will need to install: 
pip3 install "openmetadata-ingestion[quicksight]"

​
Metadata Ingestion

All connectors are defined as JSON Schemas. Here you can find the structure to create a connection to QuickSight. In order to create and run a Metadata Ingestion workflow, we will follow the steps to create a YAML configuration able to connect to the source, process the Entities if needed, and reach the OpenMetadata server. The workflow is QuickSightled around the following JSON Schema

​
1. Define the YAML Config

This is a sample config for QuickSight:

​
2. Run with the CLI

First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run: 
metadata ingest -c <path-to-yaml>
Note that from connector to connector, this recipe will always be the same. By updating the YAML configuration, you will be able to extract metadata from different sources.