delete_dashboard

DashboardsApi.delete_dashboard(dashboard_id, role_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Delete a dashboard

Removes the dashboard from the application. Caller must hold dashboards.fullaccess on role_id and owner AccessType on the dashboard. On success Message is “Successfully deleted dashboard”. May revoke QuickSight widget access and clean related ACL/notification metadata. 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} CustomUrlPath value. (required)

  • role_id (str) – Amorphic role ID used to authorize the request. Must belong to the user and hold dashboards.fullaccess. (required)

  • _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:

DeleteDashboardResponse

Returns:

Returns the result object.

Request and Response Examples

HTTP: DELETE /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 deleted successfully.

Request / response example

{
  "Message": "Successfully deleted dashboard"
}

Errors

Documented error codes: AUTH-1012, AUTH-1001, AUTH-1030, IPV-1002.

HTTP 400

RequestValidationError for invalid request parameters.

HTTP 401

Insufficient resource AccessType (need owner). Body is {“Message”: “AUTH-1012 - …”}.

HTTP 422

InvalidInputException. Codes include AUTH-1001, AUTH-1030 (missing dashboards.fullaccess), IPV-1002.

notFound

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

HTTP 500

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