API/CLI calls for dashboard creations

Question & Answer
,
1

Hello Team,

while creating the dashboard from API i am unable to get a source to the analysis from which dashbaord gets created.

EXAMPLE:

  1. From Console could see the source entity arn for the analysis after dashboard creation

{
“Status”: 200,
“Dashboard”: {
“DashboardId”: “”,
“Arn”: “arn:aws:quicksight:us-east-1:9084:dashboard/3a”,
“Name”: “abc”,
“SourceEntityArn”: “arn:aws:quicksight:us-east-1:9084:analysis/”,
“DataSetArns”: [
“arn:aws:quicksight:us-east-1:881:dataset/e96a”
],
},

  1. Api call Template creation only see the template arn in source entity same goes for dasaboarddefinition will not contain the SourceEntityArn key at all in its description.

{
“Status”: 200,
“Dashboard”: {
“DashboardId”: “”,
“Arn”: “arn:aws:quicksight:us-east-1:9084:dashboard/”,
“Name”: “”,
“Version”: {
“Errors”: ,
“VersionNumber”: 1,
“Status”: “CREATION_SUCCESSFUL”,
“SourceEntityArn”: “arn:aws:quicksight:us-east-1:9876:template/test/version/1”,
“DataSetArns”: [
“arn:aws:quicksight:us-east-1:9876:dataset/”
],

Please help if via api/cli call we can get direct link to analysis as we get from console. i understand from template arn i can fetch the analysis but that will not help since the dashboard will still not be linked to its original analysis the dashboard will still not be linked to its original analysis.

thank you

2

hi @ajio,

when creating dashboard via API, it requires template as SourceEntity or JSON definition it definition. as you described, it is a bit different from the dashboard created via GUI. the template is created based on analysis so you should be able to link to the analysis if you see the result from describe-template API for the template that your dashboard is sourced.

kind regards,
Wakana

1 Like
3

thanks for answer,

as i mentioned i could find analysis by tracing back from template but i would require a direct connection. anyways if there is no way we can resolve this.

thanks

4

@ajjo,

What do you mean with a direct connection ? . Do you want to just create the dashboard using the analysis definition and not use the template ?

5

hello @Koushik_Muthanna no actually i have to find a connection to my analysis arn directly when i create a dashboard either from definition/template

6

@ajjo,

If a dashboard is deployed using the template. To get the analysis details which was used in template creation, you would need to run describe-template.

The describe-template-definition will give you the metadata for the analysis itself. Not the analysis arn.

7

no probs, i got to know there is a feature in place to support this. thanks