Dashboard status is not in api response

Question & Answer
, ,
1

Hello,
I am trying to use boto3 1.26.90 python function QuickSight.Client.describe_dashboard to retrieve dashboard status, i.e. if the dashboard is ‘CREATION_IN_PROGRESS’|‘CREATION_SUCCESSFUL’|‘CREATION_FAILED’|‘UPDATE_IN_PROGRESS’|‘UPDATE_SUCCESSFUL’|‘UPDATE_FAILED’|‘DELETED’,

According to the documentation boto3 1.26.90, api response should be something like
[‘CreatedTime’, ‘Errors’, ‘VersionNumber’, ‘Status’, ‘Arn’, ‘SourceEntityArn’, ‘DataSetArns’, ‘Description’, ‘ThemeArn’, ‘Sheets’]

But i only got the following, which does not include field Status
[‘CreatedTime’, ‘Errors’, ‘VersionNumber’, ‘SourceEntityArn’, ‘DataSetArns’, ‘ThemeArn’, ‘Sheets’]

Any ideas why?

Thanks

2

I think you can try describe dashboard definition under ResourceStatus

1 Like
3

Thanks Max, yes, i have tried the describe_dashboard_definition too and the response not have the ResourceStatus either (as per documentation), very strange

boto3 version: 1.26.90
botocore version: 1.29.90

response dictionary keys: dict_keys([‘ResponseMetadata’, ‘Status’, ‘DashboardId’, ‘Errors’, ‘Name’, ‘ThemeArn’, ‘Definition’, ‘RequestId’, ‘DashboardPublishOptions’])

4

Is the Status what you are looking for but the name is not the same?

5

That ‘Status’ is actually the status of http request, for example, the value i got is 200, i think that means successful. So still missing the dashboard status or the resource status field.

6

@marz_nana ,
can you paste api call and the entire response you are getting ?

Here is an example for one of my dashboards

{'ResponseMetadata': {'RequestId': 'bc0b0da9-56d1-47a2-ad0f-e917e71d3d42',
  'HTTPStatusCode': 200,
  'HTTPHeaders': {'date': 'Wed, 26 Jul 2023 07:44:55 GMT',
   'content-type': 'application/json',
   'content-length': '1305',
   'connection': 'keep-alive',
   'x-amzn-requestid': 'bc0b0da9-56d1-47a2-ad0f-e917e71d3d42'},
  'RetryAttempts': 0},
 'Status': 200,
 'Dashboard': {'DashboardId': 'aabd76b999a-6a78-4c9a-808e-11d0665ccddd',
  'Arn': 'arn:aws:quicksight:eu-central-1:XXXXX:dashboard/aabd76b999a-6a78-4c9a-808e-11d0665ccddd',
  'Name': 'twingodashboard',
  'Version': {'CreatedTime': datetime.datetime(2023, 7, 25, 23, 40, 59, 852000, tzinfo=tzlocal()),
   'Errors': [],
   'VersionNumber': 1,
 'Status': 'CREATION_SUCCESSFUL',
   'DataSetArns': ['arn:aws:quicksight:eu-central-1:XXXXX:dataset/aabe0a72980-7cbf-4d8f-9ec9-d5de2e83c797'],
   'ThemeArn': 'arn:aws:quicksight:eu-central-1:XXXXX:theme/aaba1edac8b-00e2-4f91-baf7-fed3918b3cf0',
   'Sheets': [{'SheetId': 'd76b999a-6a78-4c9a-808e-11d0665ccddd_def9f8c8-cf8d-4fd8-8357-e2de78aa063e',
     'Name': 'Sheet 1'}]},
  'CreatedTime': datetime.datetime(2023, 7, 25, 23, 40, 59, 533000, tzinfo=tzlocal()),
  'LastPublishedTime': datetime.datetime(2023, 7, 25, 23, 41, 1, 399000, tzinfo=tzlocal()),
  'LastUpdatedTime': datetime.datetime(2023, 7, 25, 23, 40, 59, 852000, tzinfo=tzlocal())},
 'RequestId': 'bc0b0da9-56d1-47a2-ad0f-e917e71d3d42'}
7

Yes, sure, see below, this is the response from QuickSight.Client.describe_dashboard

{“ResponseMetadata”: {“RequestId”: “734e917c-22c0-44c2-83c1-fe37400d06a1”, “HTTPStatusCode”: 200, “HTTPHeaders”: {“date”: “Thu, 27 Jul 2023 19:29:03 GMT”, “content-type”: “application/json”, “content-length”: “2181”, “connection”: “keep-alive”, “x-amzn-requestid”: “734e917c-22c0-44c2-83c1-fe37400d06a1”},
“RetryAttempts”: 0}, “Status”: 200, “Dashboard”: {“DashboardId”: “c4120a51-8b69-4236-adde-ec8ead5f845f”, “Arn”: “arn:aws:quicksight:ap-southeast-2:xxxxx:dashboard/c4120a51-8b69-4236-adde-ec8ead5f845f”, “Name”: “XXXXX”, “Version”: {“CreatedTime”: datetime.datetime(2023, 7, 5, 9, 40, 38, 1000, tzinfo=tzlocal()), “Errors”: , “VersionNumber”: 7, “SourceEntityArn”: “arn:aws:quicksight:ap-southeast-2:XXXXX:analysis/0ce46df2-ffb9-45f7-b08b-862f81c10902”, “DataSetArns”: [“arn:aws:quicksight:ap-southeast-2:XXXX:dataset/7606d2c7-750d-4efa-bc6d-993262ca4914”, “arn:aws:quicksight:ap-southeast-2:XXXX:dataset/964f26b8-471b-435e-b2cf-04e6ccab6ad7”], “ThemeArn”: “arn:aws:quicksight:ap-southeast-2:XXXX:theme/72133063-e6fb-43e0-9180-f65793c25c8f”, “Sheets”: [{“SheetId”: “c4120a51-8b69-4236-adde-ec8ead5f845f_f5bdc4bd-135e-4363-b9d6-d8064ddb4cc4”, “Name”: “XXXX”}, {“SheetId”: “c4120a51-8b69-4236-adde-ec8ead5f845f_a1e86147-3dfb-40a1-922a-23e119b34363”, “Name”: “FULL LIST”}, {“SheetId”: “c4120a51-8b69-4236-adde-ec8ead5f845f_c1ae1984-642a-4178-8632-486880ca5413”, “Name”: “TABLES”}]}, “CreatedTime”: datetime.datetime(2023, 6, 29, 7, 45, 50, 831000, tzinfo=tzlocal()), “LastPublishedTime”: datetime.datetime(2023, 6, 29, 7, 45, 50, 831000, tzinfo=tzlocal()), “LastUpdatedTime”: datetime.datetime(2023, 7, 5, 9,
40, 38, 1000, tzinfo=tzlocal())}, “RequestId”: “734e917c-22c0-44c2-83c1-fe37400d06a1”}

8

Hello @marz_nana !

Are you still running into this issue, and if so could you repost this to the top of community? If you found the solution please feel free to share that as well to help add to the community.

I am going to archive this topic since it has been open for an extended period of time. Thank you!