Manage Amazon QuickSight assets¶
In general, these should be:
- Created in top-down order (connection, then QuickSightFolder, then QuickSightAnalysis and QuickSightDashboard and QuickSightDataset then QuickSightAnalysisVisual and QuickSightDashboardVisual and QuickSightDatasetField respectively)
- Deleted in bottom-up order (QuickSightAnalysisVisual and QuickSightDashboardVisual and QuickSightDatasetField, then QuickSightAnalysis and QuickSightDashboard and QuickSightDataset, then QuickSightFolder, then connection)1
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
Asset structure¶
Connection¶
A QuickSight connection requires a name
and qualifiedName
. For creation, specific settings are also required to distinguish it as a QuickSight connection rather than another type of connection. In addition, at least one of adminRoles
, adminGroups
, or adminUsers
must be provided.
Coming soon
Create a QuickSight connection | |
---|---|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
|
- Retrieve the GUID for the admin role, to use later for defining the roles that can administer the connection.
- Build up the minimum request to create a connection.
- Provide a human-readable name for your connection, such as
production
ordevelopment
. - Set the type of connection to
QuickSight
. - List the workspace roles that should be able to administer the connection
(or
None
if none). All users with that workspace role (current and future) will be administrators of the connection. Note that the values here need to be the GUID(s) of the workspace role(s). At least one ofadmin_roles
,admin_groups
, oradmin_users
must be provided. - List the group names that can administer this connection (or
None
if none). All users within that group (current and future) will be administrators of the connection. Note that the values here are the name(s) of the group(s). At least one ofadmin_roles
,admin_groups
, oradmin_users
must be provided. - List the user names that can administer this connection (or
None
if none). Note that the values here are the username(s) of the user(s). At least one ofadmin_roles
,admin_groups
, oradmin_users
must be provided. - Actually call Atlan to create the connection.
- Retrieve the qualifiedName for use in subsequent creation calls.
(You'd probably want to do some
None
checking first.)
Coming soon
POST /api/meta/entity/bulk | |
---|---|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
|
- The
typeName
must be exactlyConnection
. - Human-readable name for your connection, such as
production
ordevelopment
. - The
connectorName
must be exactlyquicksight
. - The
qualifiedName
should follow the pattern:default/quicksight/<epoch>
, where<epoch>
is the time in milliseconds at which the connection is being created. - The
category
must bebi
. - List any workspace roles that can administer this connection. All users with that workspace role (current and future) will be administrators of the connection. Note that the values here need to be the GUID(s) of the workspace role(s). At least one of
adminRoles
,adminGroups
, oradminUsers
must be provided. - List any groups that can administer this connection. All users within that group (current and future) will be administrators of the connection. Note that the values here are the name(s) of the group(s). At least one of
adminRoles
,adminGroups
, oradminUsers
must be provided. - List any users that can administer this connection. Note that the values here are the username(s) of the user(s). At least one of
adminRoles
,adminGroups
, oradminUsers
must be provided.
Access policies
Atlan creates the policies that grant access to a connection, including the ability to retrieve the connection and to create assets within it, asynchronously. It can take several seconds (even up to approximately 30 seconds) before these are in place after creating the connection.
You may therefore need to wait before you'll be able to create the assets below within the connection.
To confirm access, retrieve the connection after it has been created. The SDKs' retry loops will automatically retry until the connection can be successfully retrieved. At that point, your API token has permission to create the other assets.
Note: if you are reusing an existing connection rather than creating one via your API token, you must give your API token a persona that has access to that connection. Otherwise all attempts to create, read, update, or delete assets within that connection will fail due to a lack of permissions.
QuickSightFolder¶
A QuickSightFolder
requires a name
and a qualifiedName
.
For creation, you also need to specify the connectionQualifiedName
of the connection for the QuickSight folder and
the QuickSight ID
for this QuickSight folder on Amazon QuickSight.
Coming soon
Create a QuickSight folder | |
---|---|
17 18 19 20 21 22 23 24 25 26 27 |
|
- Build up the minimum request to create a folder.
- Provide a human-readable name for your folder.
- Provide the
qualifiedName
of the QuickSight connection. - Provide the
QuickSight ID
used in Amazon QuickSight folder. - Actually call Atlan to create the folder.
- Retrieve the created folder for use in subsequent creation calls.
(You'd probably want to do some
None
checking first.)
Coming soon
POST /api/meta/entity/bulk | |
---|---|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
|
- The
typeName
must be exactlyQuickSightFolder
. - Human-readable name for your folder.
- The
connectorName
must be exactlyquicksight
. - The
qualifiedName
should follow the pattern:default/quicksight/<epoch>/<quickSightId>
, wheredefault/quicksight/<epoch>
is thequalifiedName
of the connection for this folder and<quickSightId>
is the QuickSight ID
for this Amazon QuickSight folder. - The
connectionQualifiedName
must be the exactqualifiedName
of the connection for this folder. - The
quickSightId
provided for this Amazon QuickSight folder.
QuickSightDataset¶
A QuickSightDataset
requires a name
and a qualifiedName
.
For creation, you also need to specify the connectionQualifiedName
of the connection for the QuickSight dataset and
the QuickSight ID
for this QuickSight dataset on Amazon QuickSight.
Coming soon
Create a QuickSight dataset | |
---|---|
17 18 19 20 21 22 23 24 25 26 27 |
|
- Build up the minimum request to create a dataset.
- Provide a human-readable name for your dataset.
- Provide the
qualifiedName
of the QuickSight connection. - Provide the
QuickSight ID
used in Amazon QuickSight dataset. - Actually call Atlan to create the dataset.
- Retrieve the created dataset for use in subsequent creation calls.
(You'd probably want to do some
None
checking first.)
Coming soon
POST /api/meta/entity/bulk | |
---|---|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
|
- The
typeName
must be exactlyQuickSightDataset
. - Human-readable name for your dataset.
- The
connectorName
must be exactlyquicksight
. - The
qualifiedName
should follow the pattern:default/quicksight/<epoch>/<quickSightId>
, wheredefault/quicksight/<epoch>
is thequalifiedName
of the connection for this dataset and<quickSightId>
is theQuickSight ID
for this Amazon QuickSight dataset. - The
connectionQualifiedName
must be the exactqualifiedName
of the connection for this dataset. - The
quickSightId
provided for this Amazon QuickSight dataset.
QuickSightDashboard¶
A QuickSightDashboard
requires a name
and a qualifiedName
.
For creation, you also need to specify the connectionQualifiedName
of the connection for the QuickSight dashboard and
the QuickSight ID
for this QuickSight dashboard on Amazon QuickSight.
Coming soon
Create a QuickSight dashboard | |
---|---|
17 18 19 20 21 22 23 24 25 26 27 |
|
- Build up the minimum request to create a dashboard.
- Provide a human-readable name for your dashboard.
- Provide the
qualifiedName
of the QuickSight connection. - Provide the
QuickSight ID
used in Amazon QuickSight dashboard. - Actually call Atlan to create the dashboard.
- Retrieve the created dashboard for use in subsequent creation calls.
(You'd probably want to do some
None
checking first.)
Coming soon
POST /api/meta/entity/bulk | |
---|---|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
|
- The
typeName
must be exactlyQuickSightDashboard
. - Human-readable name for your dashboard.
- The
connectorName
must be exactlyquicksight
. - The
qualifiedName
should follow the pattern:default/quicksight/<epoch>/<quickSightId>
, wheredefault/quicksight/<epoch>
is thequalifiedName
of the connection for this dashboard and<quickSightId>
is theQuickSight ID
for this Amazon QuickSight dashboard. - The
connectionQualifiedName
must be the exactqualifiedName
of the connection for this dashboard. - The
quickSightId
provided for this Amazon QuickSight dashboard.
QuickSightAnalysis¶
A QuickSightAnalysis
requires a name
and a qualifiedName
.
For creation, you also need to specify the connectionQualifiedName
of the connection for the QuickSight analysis and
the QuickSight ID
for this QuickSight analysis on Amazon QuickSight.
Coming soon
Create a QuickSight analysis | |
---|---|
17 18 19 20 21 22 23 24 25 26 27 |
|
- Build up the minimum request to create a analysis.
- Provide a human-readable name for your analysis.
- Provide the
qualifiedName
of the QuickSight connection. - Provide the
QuickSight ID
used in Amazon QuickSight analysis. - Actually call Atlan to create the analysis.
- Retrieve the created analysis for use in subsequent creation calls.
(You'd probably want to do some
None
checking first.)
Coming soon
POST /api/meta/entity/bulk | |
---|---|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
|
- The
typeName
must be exactlyQuickSightAnalysis
. - Human-readable name for your analysis.
- The
connectorName
must be exactlyquicksight
. - The
qualifiedName
should follow the pattern:default/quicksight/<epoch>/<quickSightId>
, wheredefault/quicksight/<epoch>
is thequalifiedName
of the connection for this analysis and<quickSightId>
is theQuickSight ID
for this Amazon QuickSight analysis. - The
connectionQualifiedName
must be the exactqualifiedName
of the connection for this analysis. - The
quickSightId
provided for this Amazon QuickSight analysis.
QuickSightDatasetField¶
A QuickSightDatasetField
requires a name
and a qualifiedName
.
For creation, you also need to specify the DatasetQualifiedName
of the QuickSight dataset that you wish to link this field to and
the QuickSight ID
for this QuickSight dataset field on Amazon QuickSight.
Coming soon
Create a QuickSight dataset field | |
---|---|
17 18 19 20 21 22 23 24 25 26 27 |
|
- Build up the minimum request to create a dataset field.
- Provide a human-readable name for your dataset field.
- Provide the
qualifiedName
of the QuickSight dataset. - Provide the
QuickSight ID
used in Amazon QuickSight dataset field. - Actually call Atlan to create the dataset field.
- Retrieve the created dataset field for use in subsequent creation calls.
(You'd probably want to do some
None
checking first.)
Coming soon
POST /api/meta/entity/bulk | |
---|---|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
|
- The
typeName
must be exactlyQuickSightDatasetField
. - Human-readable name for your dataset field.
- The
connectorName
must be exactlyquicksight
. - The
qualifiedName
should follow the pattern:default/quicksight/<epoch>/<quickSightId_dataset>/<quickSightId>
, wheredefault/quicksight/<epoch>/<quickSightId_dataset>
is thequalifiedName
of the dataset for this dataset field and<quickSightId>
is theQuickSight ID
for this Amazon QuickSight dataset field. - The
quickSightDatasetQualifiedName
must be the exactqualifiedName
of the dataset for this dataset field. - The
typeName
for this embedded reference must beQuickSightDataset
. - To complete the reference, you must include a
uniqueAttributes
with thequalifiedName
of the Dataset. Note: the Dataset must already exist in Atlan before creating the dataset field. - The
connectionQualifiedName
must be the exactqualifiedName
of the connection for this dataset field. - The
quickSightId
provided for this Amazon QuickSight dataset field.
QuickSightDashboardVisual¶
A QuickSightDashboardVisual
requires a name
and a qualifiedName
.
For creation, you also need to specify the DashboardQualifiedName
of the QuickSight dashboard that you wish to link this dashboard visual to, along with the QuickSight ID
, QuickSight Sheet ID
, and QuickSight Sheet Name
for this dashboard visual in Amazon QuickSight.
Coming soon
Create a QuickSight dashboard visual | |
---|---|
17 18 19 20 21 22 23 24 25 26 27 28 29 |
|
- Build up the minimum request to create a dashboard visual.
- Provide a human-readable name for your dashboard visual.
- Provide the
qualifiedName
of the QuickSight dashboard. - Provide the
QuickSight ID
used in Amazon QuickSight dashboard visual. - Provide the
QuickSight Sheet ID
which links to Amazon QuickSight dashboard visual. - Provide the
QuickSight Sheet Name
which links to Amazon QuickSight dashboard visual. - Actually call Atlan to create the dashboard visual.
- Retrieve the created dashboard visual for use in subsequent creation calls.
(You'd probably want to do some
None
checking first.)
Coming soon
POST /api/meta/entity/bulk | |
---|---|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
|
- The
typeName
must be exactlyQuickSightDashboardVisual
. - Human-readable name for your dashboard visual.
- The
connectorName
must be exactlyquicksight
. - The
qualifiedName
should follow the pattern:default/quicksight/<epoch>/<quickSightId_dashboard>/<quickSightSheetId>/<quickSightId>
, wheredefault/quicksight/<epoch>/<quickSightId_dashboard>
is thequalifiedName
of the dashboard for this dashboard visual,is the QuickSight Sheet ID
for this Amazon QuickSight dashboard visual and<quickSightId>
is theQuickSight ID
for this Amazon QuickSight dashboard visual. - The
quickSightAnalysisQualifiedName
must be the exactqualifiedName
of the analysis for this dashboard visual. - The
quickSightSheetId
must be the exactQuickSight Sheet ID
for this Amazon QuickSight dashboard visual. - The
quickSightSheetName
must be the exactQuickSight Sheet Name
for this Amazon QuickSight dashboard visual. - The
typeName
for this embedded reference must beQuickSightDashboard
. - To complete the reference, you must include a
uniqueAttributes
with thequalifiedName
of the dashboard. Note: the analysis must already exist in Atlan before creating the dashboard visual. - The
connectionQualifiedName
must be the exactqualifiedName
of the connection for this dashboard visual. - The
quickSightId
provided for this Amazon QuickSight dashboard visual.
QuickSightAnalysisVisual¶
A QuickSightAnalysisVisual
requires a name
and a qualifiedName
.
For creation, you also need to specify the AnalysisQualifiedName
of the QuickSight analysis that you wish to link this analysis visual to, along with the QuickSight ID
, QuickSight Sheet ID
, and QuickSight Sheet Name
for this analysis visual in Amazon QuickSight.
Coming soon
Create a QuickSight analysis visual | |
---|---|
17 18 19 20 21 22 23 24 25 26 27 28 29 |
|
- Build up the minimum request to create a analysis visual.
- Provide a human-readable name for your analysis visual.
- Provide the
qualifiedName
of the QuickSight analysis. - Provide the
QuickSight ID
used in Amazon QuickSight analysis visual. - Provide the
QuickSight Sheet ID
which links to Amazon QuickSight analysis visual. - Provide the
QuickSight Sheet Name
which links to Amazon QuickSight analysis visual. - Actually call Atlan to create the analysis visual.
- Retrieve the created analysis visual for use in subsequent creation calls.
(You'd probably want to do some
None
checking first.)
Coming soon
POST /api/meta/entity/bulk | |
---|---|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
|
- The
typeName
must be exactlyQuickSightAnalysisVisual
. - Human-readable name for your analysis visual.
- The
connectorName
must be exactlyquicksight
. - The
qualifiedName
should follow the pattern:default/quicksight/<epoch>/<quickSightId_analysis>/<quickSightSheetId>/<quickSightId>
, wheredefault/quicksight/<epoch>/<quickSightId_analysis>
is thequalifiedName
of the analysis for this analysis visual,is the QuickSight Sheet ID
for this Amazon QuickSight analysis visual and<quickSightId>
is theQuickSight ID
for this Amazon QuickSight analysis visual. - The
quickSightAnalysisQualifiedName
must be the exactqualifiedName
of the analysis for this analysis visual. - The
quickSightSheetId
must be the exactQuickSight Sheet ID
for this Amazon QuickSight analysis visual. - The
quickSightSheetName
must be the exactQuickSight Sheet Name
for this Amazon QuickSight analysis visual. - The
typeName
for this embedded reference must beQuickSightAnalysis
. - To complete the reference, you must include a
uniqueAttributes
with thequalifiedName
of the analysis. Note: the analysis must already exist in Atlan before creating the analysis visual. - The
connectionQualifiedName
must be the exactqualifiedName
of the connection for this analysis visual. - The
quickSightId
provided for this Amazon QuickSight analysis visual.
Available relationships¶
Every level of the QuickSight
structure is an Asset
,
and can therefore be related to the following other assets.
erDiagram
Asset }o--o{ AtlasGlossaryTerm : meanings
Asset ||--o{ Link : links
Asset ||--o| Readme : readme
Asset }o--o{ Process : inputToProcesses
Asset }o--o{ Process : outputFromProcesses
AtlasGlossaryTerm¶
A glossary term provides meaning to an asset. The link terms to assets snippet provides more detail on setting this relationship.
Link¶
A link provides additional context to an asset, by providing a URL to additional information.
Readme¶
A README provides rich documentation for an asset. The add asset READMEs snippet provides more detail on setting this relationship.
Process¶
A process provides lineage information for an asset. An asset can be both an input and an output for one or more processes. The lineage snippets provide more detail on creating and working with lineage.
-
Although if you want to delete everything in a connection,your better avenue is the packaged connection delete utility in the UI. ↩