DeleteDashboards 搭配 AWS SDK 或 CLI 使用 - AWS SDK 程式碼範例

文件 AWS 開發套件範例 GitHub 儲存庫中有更多可用的 AWS SDK 範例。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

DeleteDashboards 搭配 AWS SDK 或 CLI 使用

下列程式碼範例示範如何使用 DeleteDashboards。

動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：

.NET
AWS SDK for .NET
注意

GitHub 上提供更多範例。尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。

    /// <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;
    }

  • 如需 API 詳細資訊，請參閱AWS SDK for .NET API 參考中的 DeleteDashboards。

CLI
AWS CLI

刪除指定的儀表板

下列delete-dashboards範例會刪除指定帳戶中名為 Dashboard-A和 Dashboard-B 的兩個儀表板。

aws cloudwatch delete-dashboards \
    --dashboard-names Dashboard-A Dashboard-B

此命令不會產生輸出。

如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的 Amazon CloudWatch 儀表板。 Amazon CloudWatch

  • 如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteDashboards。

Java
SDK for Java 2.x
注意

GitHub 上提供更多範例。尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。

    /**
     * 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);
                }
            });
    }

  • 如需 API 詳細資訊，請參閱AWS SDK for Java 2.x API 參考中的 DeleteDashboards。

Kotlin
SDK for Kotlin
注意

GitHub 上提供更多範例。尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。

suspend fun deleteDashboard(dashboardName: String) {
    val dashboardsRequest =
        DeleteDashboardsRequest {
            dashboardNames = listOf(dashboardName)
        }
    CloudWatchClient { region = "us-east-1" }.use { cwClient ->
        cwClient.deleteDashboards(dashboardsRequest)
        println("$dashboardName was successfully deleted.")
    }
}

  • 如需 API 詳細資訊，請參閱《適用於 Kotlin 的AWS SDK API 參考》中的 DeleteDashboards。

PowerShell
Tools for PowerShell

範例 1：刪除指定的儀表板，在繼續之前促進確認。若要略過確認，請將 -Force 切換新增至命令。

Remove-CWDashboard -DashboardName Dashboard1

  • 如需 API 詳細資訊，請參閱 AWS Tools for PowerShell Cmdlet 參考中的 DeleteDashboards。