Doc AWS SDK Examples GitHub リポジトリには、他にも SDK の例があります。 [AWS](https://github.com/awsdocs/aws-doc-sdk-examples)
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# AWS SDK または CLI `ListDashboards`で を使用する
次のサンプルコードは、`ListDashboards` を使用する方法を説明しています。
------
#### [ .NET ]
**SDK for .NET (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 の詳細については、*AWS SDK for .NET API リファレンス*の「[ListDashboards](https://docs.aws.amazon.com/goto/DotNetSDKV4/monitoring-2010-08-01/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 リファレンス」の「[ListDashboards](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/ListDashboards)」を参照してください。
------
#### [ Kotlin ]
**SDK for Kotlin**
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 の詳細については、「AWS SDK for Kotlin 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 コマンドレットリファレンス (V5)* の「[ListDashboards](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------