DeleteDashboard

Deletes a specified dashboard. This action cannot be undone.

Request Syntax


{
   "arn": "string"
}

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

arn

The ARN of the dashboard to be deleted.

Type: String

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

Pattern: arn:aws[-a-z0-9]*:bcm-dashboards::[0-9]{12}:dashboard/(\*|[-a-z0-9]+)

Required: Yes


{
   "arn": "string"
}

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

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

arn

The ARN of the dashboard that was deleted.

Type: String

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

Pattern: arn:aws[-a-z0-9]*:bcm-dashboards::[0-9]{12}:dashboard/(\*|[-a-z0-9]+)

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

AccessDeniedException

You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.

HTTP Status Code: 400

InternalServerException

An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Support.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.

HTTP Status Code: 400

ValidationException

The input parameters do not satisfy the requirements. Check the error message for specific validation details.

HTTP Status Code: 400