- Newest
- Most votes
- Most comments
If you look at ListDashboardsCommandOutput: https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/ListDashboardsCommandOutput/, you have got a list of Dahboard summary objects.
If you cannot repurpose the "Name" field for it, then you need another call to the DescribeDashboardCommand API (https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/DescribeDashboardCommand/),which returns the description field: https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-iotsitewise/Interface/DescribeDashboardCommandOutput/
Thanks Antonio for the links.
I did a DescribeDashboard for a given AWS account ID and dashboard ID and this is the structure returned:
"Status": 200,
"Dashboard": {
"DashboardId": ...,
"Arn": ...,
"Name": ...,
"Version": {
"CreatedTime": ...,
"Errors": [],
"VersionNumber": 15,
"Status": "CREATION_SUCCESSFUL",
"SourceEntityArn": ...,
"DataSetArns": [
...
...
],
"ThemeArn": "arn:aws:quicksight::aws:theme/MIDNIGHT",
"Sheets": [
{
"SheetId": ...,
"Name": "Overview"
},
{
"SheetId": ...,
"Name": "Email Performance"
}
]
},
"CreatedTime": ...,
"LastPublishedTime": ...,
"LastUpdatedTime": ...,
"LinkEntities": [
...
]
},
"RequestId": ...
}
I noticed that there is a "Description" field inside the Version
block, but it's missing in the output above.
I've been trying to get the description of the dashboard, and I've a feeling it's not possible to set the description in the QuickSight console or the AWS console when I publish a dashboard, so I'm guessing I would have to do it via the CLI or the SDK.
Do you think that for the SDK I could use the UpdateDashboardCommand to set the dashboard's description so I could retrieve it from the DescribeDashboard?
Relevant content
- asked 2 years ago
- AWS OFFICIALUpdated 3 years ago
- AWS OFFICIALUpdated 5 months ago
I accept your answer, but your link is wrong as it refers to IoT SiteWise instead of QuickSight. It should be this one, which has the "Description" field in Dashboard.Version:
https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DashboardVersion/