文件 AWS 開發套件範例 GitHub 儲存庫中有更多可用的 [AWS SDK 範例](https://github.com/awsdocs/aws-doc-sdk-examples)。
本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
# `ListDashboards` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `ListDashboards`。
------
#### [ .NET ]
**適用於 .NET 的 SDK (v4)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/CloudWatch#code-examples)中設定和執行。
```
///
/// Get a list of dashboards.
///
/// A list of DashboardEntry objects.
public async Task> ListDashboards()
{
var results = new List();
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 詳細資訊，請參閱 [適用於 .NET 的 AWS SDK API 參考](https://docs.aws.amazon.com/goto/DotNetSDKV4/monitoring-2010-08-01/ListDashboards)中的 *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 儀表板](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Dashboards.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListDashboards](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/list-dashboards.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/cloudwatch#code-examples)中設定和執行。
```
/**
* 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 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 參考](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/ListDashboards)中的 *ListDashboards*。
------
#### [ Kotlin ]
**適用於 Kotlin 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/cloudwatch#code-examples)中設定和執行。
```
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 詳細資訊，請參閱《適用於 Kotlin 的AWS SDK API 參考**》中的 [ListDashboards](https://sdk.amazonaws.com/kotlin/api/latest/index.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 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 Cmdlet 參考 (V4)》**中的 [ListDashboards](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 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 Cmdlet 參考 (V5)》**中的 [ListDashboards](https://docs.aws.amazon.com/powershell/v5/reference)。
------