get_dashboard_details¶

DashboardsApi.get_dashboard_details(dashboard_id, role_id, projection_expression=None, option=None, quicksight_id=None, widget_ref_id=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Get dashboard details

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.

Parameters:

dashboard_id (str) – DashboardId UUID, or {CurrentSlug}-{CustomId} where CustomId is the last 8 characters of the UUID with hyphens removed (lowercase) and CurrentSlug is the PascalCase alphanumerics from DashboardName. (required)
role_id (str) – Amorphic role ID used to authorize the request. Must be a role the authenticated user belongs to. (required)
projection_expression (str) – Comma-separated attributes to include in the default (non-option) response. Ignored for presignedurl and insights_details options.
option (str) – Optional specialized retrieval mode. Omit for full dashboard metadata.
quicksight_id (str) – QuickSight dashboard ID that must match the widget Configuration. Required when option=presignedurl.
widget_ref_id (str) – Widget RefId to target. Required when option is presignedurl or insights_details.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

GetDashboardDetails200Response

Returns:

Returns the result object.

Request and Response Examples¶

HTTP: GET /dashboards/{dashboard_id}

Parameter examples¶

Name	In	Example
`dashboard_id`	path	`"SalesOverview-3c4d5e6f"`
`role_id`	header	`"custom-role-123e4567-e89b-12d3-a456-426614174000"`

Success (HTTP 200)¶

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

details

{
  "DashboardId": "b1e6c2a0-9f4d-4c7a-8f2e-1a2b3c4d5e6f",
  "DashboardName": "Sales Overview",
  "AccessType": "owner",
  "CustomUrlPath": "SalesOverview-3c4d5e6f",
  "CurrentSlug": "SalesOverview",
  "CustomId": "3c4d5e6f",
  "Widgets": []
}

presignedurl

{
  "PresignedUrl": "https://quicksight.aws.amazon.com/embed/...",
  "Message": "Generated dashboard embed url using BI vertical registered user: jane.doe"
}

insights

{
  "Resources": [],
  "Message": "Successfully retrieved insights details"
}

Errors¶

Documented error codes: AUTH-1012, AUTH-1001, IPV-1002, IPV-1051, GE-1004.

HTTP 400

RequestValidationError for invalid query/body types. Body is {“Message”: “<CODE> - <text>”} (IPV-* validation codes).

HTTP 401

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

insufficientAccess

{
  "Message": "AUTH-1012 - User: jane.doe requires at least read-only access on the resource to perform this action."
}

HTTP 422

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

missingParams

{
  "Message": "IPV-1051 - Missing widget_ref_id, quicksight_id in request query"
}

notFound

{
  "Message": "IPV-1002 - Invalid DashboardId - bad-id, resource not found."
}

HTTP 500

Backend/generic failure. Body is {“Message”: “<CODE> - <text>”}.

Unexpected backend failure

{
  "Message": "GE-1004 - Unexpected error - <exception text>"
}