DeleteDashboard -

DeleteDashboard

Deletes a dashboard.

Request Syntax

DELETE /accounts/AwsAccountId/dashboards/DashboardId?version-number=VersionNumber HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

AwsAccountId

The ID of the AWS account that contains the dashboard that you're deleting.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

DashboardId

The ID for the dashboard.

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [\w\-]+

VersionNumber

The version number of the dashboard. If the version number property is provided, only the specified version of the dashboard is deleted.

Valid Range: Minimum value of 1.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 Status Content-type: application/json { "Arn": "string", "DashboardId": "string", "RequestId": "string" }

Response Elements

If the action is successful, the service sends back the following HTTP response.

Status

The HTTP status of the request.

The following data is returned in JSON format by the service.

Arn

The Secure Socket Layer (SSL) properties that apply for the resource.

Type: String

DashboardId

The ID of the dashboard.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [\w\-]+

RequestId

The AWS request ID for this operation.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters has a value that isn't valid.

HTTP Status Code: 400

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ThrottlingException

Access is throttled.

HTTP Status Code: 429

UnsupportedUserEditionException

This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

HTTP Status Code: 403

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: