There are more AWS SDK examples available in the [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub repo.
# Use `ListDashboards` with an AWS SDK or CLI
The following code examples show how to use `ListDashboards`.
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 example:
+ [Creating a CloudWatch dashboard with function name as a variable](cloudwatch_example_cloudwatch_GettingStarted_031_section.md)
------
#### [ .NET ]
**SDK for .NET (v4)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](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;
}
```
+ For API details, see [ListDashboards](https://docs.aws.amazon.com/goto/DotNetSDKV4/monitoring-2010-08-01/ListDashboards) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To retrieve a list of Dashboards**
The following `list-dashboards` example lists all the Dashboards in the specified account.
```
aws cloudwatch list-dashboards
```
Output:
```
{
"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
}
]
}
```
For more information, see [Amazon CloudWatch dashboards](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Dashboards.html) in the *Amazon CloudWatch User Guide*.
+ For API details, see [ListDashboards](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/list-dashboards.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](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);
});
}
```
+ For API details, see [ListDashboards](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/ListDashboards) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](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}")
}
}
}
```
+ For API details, see [ListDashboards](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: Returns the collection of dashboards for your account.**
```
Get-CWDashboardList
```
**Output:**
```
DashboardArn DashboardName LastModified Size
------------ ------------- ------------ ----
arn:... Dashboard1 7/6/2017 8:14:15 PM 252
```
**Example 2: Returns the collection of dashboards for your account whose names start with the prefix 'dev'.**
```
Get-CWDashboardList -DashboardNamePrefix dev
```
+ For API details, see [ListDashboards](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: Returns the collection of dashboards for your account.**
```
Get-CWDashboardList
```
**Output:**
```
DashboardArn DashboardName LastModified Size
------------ ------------- ------------ ----
arn:... Dashboard1 7/6/2017 8:14:15 PM 252
```
**Example 2: Returns the collection of dashboards for your account whose names start with the prefix 'dev'.**
```
Get-CWDashboardList -DashboardNamePrefix dev
```
+ For API details, see [ListDashboards](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------