Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions,
see Getting Started with Amazon Web Services in China
(PDF).
Use DeleteDashboards with an Amazon SDK or CLI
The following code examples show how to use DeleteDashboards.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in
context in the following code examples:
- .NET
-
- Amazon SDK for .NET (v4)
-
/// <summary>
/// Delete a list of CloudWatch dashboards.
/// </summary>
/// <param name="dashboardNames">List of dashboard names to delete.</param>
/// <returns>True if successful.</returns>
public async Task<bool> DeleteDashboards(List<string> dashboardNames)
{
var deleteDashboardsResponse = await _amazonCloudWatch.DeleteDashboardsAsync(
new DeleteDashboardsRequest()
{
DashboardNames = dashboardNames
});
return deleteDashboardsResponse.HttpStatusCode == HttpStatusCode.OK;
}
- CLI
-
- Amazon CLI
-
To delete specified dashboards
The following delete-dashboards example deletes two dashboards named Dashboard-A and Dashboard-B in the specified account.
aws cloudwatch delete-dashboards \
--dashboard-names Dashboard-A Dashboard-B
This command produces no output.
For more information, see Amazon CloudWatch dashboards in the Amazon CloudWatch User Guide.
- Java
-
- SDK for Java 2.x
-
/**
* Deletes the specified dashboard.
*
* @param dashboardName the name of the dashboard to be deleted
* @return a {@link CompletableFuture} representing the asynchronous operation of deleting the dashboard
* @throws RuntimeException if the dashboard deletion fails
*/
public CompletableFuture<DeleteDashboardsResponse> deleteDashboardAsync(String dashboardName) {
DeleteDashboardsRequest dashboardsRequest = DeleteDashboardsRequest.builder()
.dashboardNames(dashboardName)
.build();
return getAsyncClient().deleteDashboards(dashboardsRequest)
.whenComplete((response, exception) -> {
if (exception != null) {
throw new RuntimeException("Failed to delete the dashboard: " + dashboardName, exception);
} else {
logger.info("{} was successfully deleted.", dashboardName);
}
});
}
- Kotlin
-
- SDK for Kotlin
-
suspend fun deleteDashboard(dashboardName: String) {
val dashboardsRequest =
DeleteDashboardsRequest {
dashboardNames = listOf(dashboardName)
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
cwClient.deleteDashboards(dashboardsRequest)
println("$dashboardName was successfully deleted.")
}
}
- PowerShell
-
- Tools for PowerShell V4
-
Example 1: Deletes the specified dashboard, promoting for confirmation before proceeding. To bypass confirmation add the -Force switch to the command.
Remove-CWDashboard -DashboardName Dashboard1
- Tools for PowerShell V5
-
Example 1: Deletes the specified dashboard, promoting for confirmation before proceeding. To bypass confirmation add the -Force switch to the command.
Remove-CWDashboard -DashboardName Dashboard1
For a complete list of Amazon SDK developer guides and code examples, see
Using CloudWatch with an Amazon SDK.
This topic also includes information about getting started and details about previous SDK versions.