View a markdown version of this page

Use GetDashboard with an AWS SDK or CLI - Amazon CloudWatch

Use GetDashboard with an AWS 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
SDK for .NET (v4)
Note

There's more on GitHub. Find the complete example and learn how to set up and run in the AWS Code Examples Repository. 

    /// <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;
    }

  • For API details, see GetDashboard in AWS SDK for .NET API Reference.

CLI
AWS 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.

  • For API details, see GetDashboard in AWS CLI Command Reference.

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 {...

  • For API details, see GetDashboard in AWS Tools for PowerShell Cmdlet Reference (V4).

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 API details, see GetDashboard in AWS Tools for PowerShell Cmdlet Reference (V5).

For a complete list of AWS SDK developer guides and code examples, see Using CloudWatch with an AWS SDK. This topic also includes information about getting started and details about previous SDK versions.