Get dashboard details

GET 
/dashboards/:dashboard_id

Returns details for a dashboard identified by DashboardId UUID or CustomUrlPath value of the form {CurrentSlug}-{CustomId} (for example SalesOverview-3c4d5e6f). Caller must have at least read-only resource access (AUTH-1012 otherwise). Without option, returns dashboard metadata plus AccessType and CustomUrlPath. With option=presignedurl, requires widget_ref_id and quicksight_id and returns DashboardPresignedUrlResponse. With option=insights_details, requires widget_ref_id and returns DashboardInsightsDetailsResponse. Unknown option values fall through to full details. This Lambda maps InvalidInputException to HTTP 422, UnauthorizedUserException (resource ACL) to HTTP 401, RequestValidationError to HTTP 400, and unhandled/GenericFailure to HTTP 500.

Request

Responses

200

Dashboard details, or a specialized payload when option is set.

Response Headers

Access-Control-Allow-Origin
Access-Control-Allow-Methods
Access-Control-Allow-Headers

400

RequestValidationError for invalid query/body types. Body is {"Message": " - "} (IPV-* validation codes).

Response Headers

Access-Control-Allow-Origin
Access-Control-Allow-Methods
Access-Control-Allow-Headers

401

Insufficient resource AccessType (need at least read-only). Body is {"Message": "AUTH-1012 - ..."}.

Response Headers

Access-Control-Allow-Origin
Access-Control-Allow-Methods
Access-Control-Allow-Headers

422

InvalidInputException. Body is {"Message": " - "}. Codes include AUTH-1001, IPV-1002 (invalid/missing dashboard_id), IPV-1051 (missing widget_ref_id and/or quicksight_id for option modes).

Response Headers

Access-Control-Allow-Origin
Access-Control-Allow-Methods
Access-Control-Allow-Headers

500

Backend/generic failure. Body is {"Message": " - "}.

Response Headers

Access-Control-Allow-Origin
Access-Control-Allow-Methods
Access-Control-Allow-Headers