AWS SDK または CLI ListDashboardsで を使用する

次のサンプルコードは、ListDashboards を使用する方法を説明しています。

.NET

SDK for .NET

注記

GitHub には、その他のリソースもあります。用例一覧を検索し、AWS コード例リポジトリでの設定と実行の方法を確認してください。

    /// <summary>
    /// Get a list of dashboards.
    /// </summary>
    /// <returns>A list of DashboardEntry objects.</returns>
    public async Task<List<DashboardEntry>> ListDashboards()
    {
        var results = new List<DashboardEntry>();
        var paginateDashboards = _amazonCloudWatch.Paginators.ListDashboards(
            new ListDashboardsRequest());
        // Get the entire list using the paginator.
        await foreach (var data in paginateDashboards.DashboardEntries)
        {
            results.Add(data);
        }

        return results;
    }

• API の詳細については、「AWS SDK for .NET API リファレンス」の「ListDashboards」を参照してください。

CLI

AWS CLI

ダッシュボードのリストを取得する方法

次の list-dashboards の例では、指定されたアカウントですべてのダッシュボードを一覧表示します。

aws cloudwatch list-dashboards

出力:

{
    "DashboardEntries": [
        {
            "DashboardName": "Dashboard-A",
            "DashboardArn": "arn:aws:cloudwatch::123456789012:dashboard/Dashboard-A",
            "LastModified": "2024-10-11T18:40:11+00:00",
            "Size": 271
        },
        {
            "DashboardName": "Dashboard-B",
            "DashboardArn": "arn:aws:cloudwatch::123456789012:dashboard/Dashboard-B",
            "LastModified": "2024-10-11T18:44:41+00:00",
            "Size": 522
        }
    ]
}

詳細については、「Amazon CloudWatch ユーザーガイド」の「Amazon CloudWatch のダッシュボード」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「ListDashboards」を参照してください。

Java

SDK for Java 2.x

注記

GitHub には、その他のリソースもあります。用例一覧を検索し、AWS コード例リポジトリでの設定と実行の方法を確認してください。

    /**
     * Lists the available dashboards.
     *
     * @return a {@link CompletableFuture} that completes when the operation is finished.
     * The future will complete exceptionally if an error occurs while listing the dashboards.
     */
    public CompletableFuture<Void> listDashboardsAsync() {
        ListDashboardsRequest listDashboardsRequest = ListDashboardsRequest.builder().build();
        ListDashboardsPublisher paginator = getAsyncClient().listDashboardsPaginator(listDashboardsRequest);
        return paginator.subscribe(response -> {
            response.dashboardEntries().forEach(entry -> {
                logger.info("Dashboard name is: {} ", entry.dashboardName());
                logger.info("Dashboard ARN is: {} ", entry.dashboardArn());
            });
        }).exceptionally(ex -> {
            logger.info("Failed to list dashboards: {} ", ex.getMessage());
            throw new RuntimeException("Error occurred while listing dashboards", ex);
        });
    }

• API の詳細については、「AWS SDK for Java 2.x API リファレンス」の「ListDashboards」を参照してください。

Kotlin

SDK for Kotlin

注記

GitHub には、その他のリソースもあります。用例一覧を検索し、AWS コード例リポジトリでの設定と実行の方法を確認してください。

suspend fun listDashboards() {
    CloudWatchClient { region = "us-east-1" }.use { cwClient ->
        cwClient
            .listDashboardsPaginated({})
            .transform { it.dashboardEntries?.forEach { obj -> emit(obj) } }
            .collect { obj ->
                println("Name is ${obj.dashboardName}")
                println("Dashboard ARN is ${obj.dashboardArn}")
            }
    }
}

• API の詳細については、「AWS SDK for Kotlin API リファレンス」の「ListDashboards」を参照してください。

PowerShell

Tools for PowerShell

例 1: アカウントのダッシュボードのコレクションを返します。

Get-CWDashboardList

出力:

DashboardArn DashboardName LastModified        Size
------------ ------------- ------------        ----
arn:...      Dashboard1    7/6/2017 8:14:15 PM 252

例 2: 名前が 'dev' で始まるアカウントのダッシュボードのコレクションを返します。

Get-CWDashboardList -DashboardNamePrefix dev

• API の詳細については、「AWS Tools for PowerShell コマンドレットリファレンス」の「ListDashboards」を参照してください。