QuickSight model¶
Base class for QuickSight assets.
Reference documentation
This is reference documentation covering the entire Atlan model. It is not the best place to start when trying to understand how to manage QuickSight assets in Atlan. For that, we would suggest starting with either:
classDiagram
direction RL
class QuickSight {
<<abstract>>
}
link QuickSight "../quicksight"
class BI {
<<abstract>>
}
link BI "../entities/bi"
BI <|-- QuickSight : extends
class Catalog {
<<abstract>>
}
link Catalog "../entities/catalog"
Catalog <|-- BI : extends
class Asset {
<<abstract>>
}
link Asset "../entities/asset"
Asset <|-- Catalog : extends
class Referenceable {
<<abstract>>
}
link Referenceable "../entities/referenceable"
Referenceable <|-- Asset : extends
class QuickSightFolder
link QuickSightFolder "../entities/quicksightfolder"
QuickSight <|-- QuickSightFolder : extends
class QuickSightDashboardVisual
link QuickSightDashboardVisual "../entities/quicksightdashboardvisual"
QuickSight <|-- QuickSightDashboardVisual : extends
class QuickSightAnalysisVisual
link QuickSightAnalysisVisual "../entities/quicksightanalysisvisual"
QuickSight <|-- QuickSightAnalysisVisual : extends
class QuickSightDatasetField
link QuickSightDatasetField "../entities/quicksightdatasetfield"
QuickSight <|-- QuickSightDatasetField : extends
class QuickSightAnalysis
link QuickSightAnalysis "../entities/quicksightanalysis"
QuickSight <|-- QuickSightAnalysis : extends
class QuickSightDashboard
link QuickSightDashboard "../entities/quicksightdashboard"
QuickSight <|-- QuickSightDashboard : extends
class QuickSightDataset
link QuickSightDataset "../entities/quicksightdataset"
QuickSight <|-- QuickSightDataset : extends
Type-specific properties¶
Following are the properties uniquely available on QuickSight
assets in Atlan.
quickSightId
TBC | |
---|---|
1 2 3 |
|
-
Set the
quickSightId
for aQuickSight
. -
Retrieve the
quickSightId
from aQuickSight
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
quickSightId
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
quickSightSheetId
TBC | |
---|---|
1 2 3 |
|
-
Set the
quickSightSheetId
for aQuickSight
. -
Retrieve the
quickSightSheetId
from aQuickSight
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
quickSightSheetId
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
quickSightSheetName
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
quickSightSheetName
for aQuickSight
. -
Retrieve the
quickSightSheetName
from aQuickSight
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
quickSightSheetName
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
quickSightSheetName
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
quick_sight_id
TBC | |
---|---|
1 2 3 |
|
-
Set the
quick_sight_id
for aQuickSight
. -
Retrieve the
quick_sight_id
from aQuickSight
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
quick_sight_id
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
quick_sight_sheet_id
TBC | |
---|---|
1 2 3 |
|
-
Set the
quick_sight_sheet_id
for aQuickSight
. -
Retrieve the
quick_sight_sheet_id
from aQuickSight
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
quick_sight_sheet_id
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
quick_sight_sheet_name
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
quick_sight_sheet_name
for aQuickSight
. -
Retrieve the
quick_sight_sheet_name
from aQuickSight
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
quick_sight_sheet_name
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
quick_sight_sheet_name
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
quickSightId
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
quickSightId
for aQuickSight
.For more details
For more information, see the asset CRUD snippets.
quickSightSheetId
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
quickSightSheetId
for aQuickSight
.For more details
For more information, see the asset CRUD snippets.
quickSightSheetName
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
quickSightSheetName
for aQuickSight
.For more details
For more information, see the asset CRUD snippets.
Relationships¶
The following illustrates how the various QuickSight objects inter-relate with each other:
erDiagram
Connection ||..o{ QuickSightAnalysis : ""
Connection ||..o{ QuickSightDashboard : ""
Connection ||..o{ QuickSightDataset : ""
Connection ||..o{ QuickSightFolder : ""
QuickSightFolder }o--o{ QuickSightAnalysis : quickSightAnalyses
QuickSightFolder }o--o{ QuickSightDashboard : quickSightDashboards
QuickSightFolder }o--o{ QuickSightDataset : quickSightDatasets
QuickSightAnalysis |o--o{ QuickSightAnalysisVisual : quickSigntAnalysisVisuals
QuickSightDashboard |o--o{ QuickSightDashboardVisual : quickSightDashboardVisuals
QuickSightDataset |o--o{ QuickSightDatasetField : quickSightDatasetFields