QuickSight assets app
The QuickSight assets app crawls Amazon QuickSight dashboards, analyses, datasets,
and folders and publishes them to Atlan. Build it with the AtlanQuicksight
builder.
Creating an app creates a new connection
Each create mints a new connection and new assets. To re-crawl, re-run the existing workflow (see Re-run an existing app).
IAM authentication
- Python
QuickSight crawling with IAM credentials
from pyatlan.client.atlan import AtlanClient
from pyatlan.model.apps import AtlanQuicksight
client = AtlanClient()
response = (
AtlanQuicksight(client)
.iam( # (1)
username="AKIA...", # (2)
password="••••••", # (3)
region="us-east-1", # (4)
accountid="123456789012", # (5)
)
.connection(
name="production-quicksight",
admin_roles=[client.role_cache.get_id_for_name("$admin")],
)
.include_folders({"folder-id-1": {}}) # (6)
.run(name="quicksight-prod")
)
print(response.slug, response.run_id)
- Step 1—Credential. AWS access key/secret auth; the secret is vaulted.
- Required. AWS access key.
- Required. AWS secret key.
- Required. AWS region.
- Required. AWS account id.
- Step 3—Metadata. Folders to crawl (
{folder_id: {}}). Omit to crawl all folders.
Configuration options
All metadata options are optional:
- Python
QuickSight metadata configuration
(
AtlanQuicksight(client)
.iam(username="AKIA...", password="••••••", region="us-east-1", accountid="123456789012")
.connection(name="production-quicksight", admin_roles=[...])
.include_folders({"folder-id-1": {}}) # (1)
.exclude_folders({"folder-id-2": {}}) # (2)
.fetch_all_assets_without_folder(True) # (3)
.run(name="quicksight-prod")
)
- Folders to include (
{folder_id: {}}). Exclude takes priority over include. - Folders to exclude.
- Also fetch assets not linked to any folder (datasets, analyses, dashboards).