Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions,
see Getting Started with Amazon Web Services in China
(PDF).
Use GetDashboard with an Amazon SDK or CLI
The following code examples show how to use GetDashboard.
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 examples:
- .NET
-
- Amazon SDK for .NET (v4)
-
/// <summary>
/// Get information on a dashboard.
/// </summary>
/// <param name="dashboardName">The name of the dashboard.</param>
/// <returns>A JSON object with dashboard information.</returns>
public async Task<string> GetDashboard(string dashboardName)
{
var dashboardResponse = await _amazonCloudWatch.GetDashboardAsync(
new GetDashboardRequest()
{
DashboardName = dashboardName
});
return dashboardResponse.DashboardBody;
}
- CLI
-
- Amazon CLI
-
To retrieve information about a Dashboard
The following get-dashboard example displays information about the dashboard named Dashboard-A in the specified account.
aws cloudwatch get-dashboard \
--dashboard-name Dashboard-A
Output:
{
"DashboardArn": "arn:aws:cloudwatch::123456789012:dashboard/Dashboard-A",
"DashboardBody": "{\"widgets\":[{\"type\":\"metric\",\"x\":0,\"y\":0,\"width\":6,\"height\":6,\"properties\":{\"view\":\"timeSeries\",\"stacked\":false,\"metrics\":[[\"AWS/EC2\",\"NetworkIn\",\"InstanceId\",\"i-0131f062232ade043\"],[\".\",\"NetworkOut\",\".\",\".\"]],\"region\":\"us-east-1\"}}]}",
"DashboardName": "Dashboard-A"
}
For more information, see Amazon CloudWatch dashboards in the Amazon CloudWatch User Guide.
- PowerShell
-
- Tools for PowerShell V4
-
Example 1: Returns the arn the body of the specified dashboard.
Get-CWDashboard -DashboardName Dashboard1
Output:
DashboardArn DashboardBody
------------ -------------
arn:aws:cloudwatch::123456789012:dashboard/Dashboard1 {...
- Tools for PowerShell V5
-
Example 1: Returns the arn the body of the specified dashboard.
Get-CWDashboard -DashboardName Dashboard1
Output:
DashboardArn DashboardBody
------------ -------------
arn:aws:cloudwatch::123456789012:dashboard/Dashboard1 {...
For a complete list of Amazon SDK developer guides and code examples, see
Using CloudWatch with an Amazon SDK.
This topic also includes information about getting started and details about previous SDK versions.