Skip to content

Displays the details of the dashboard that you specify

Description

Displays the details of the dashboard that you specify.

To copy an existing dashboard, use get_dashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call put_dashboard to create the copy.

You might have recently enabled an opt-in Region (Region that is disabled by default) for your account. In that Region, get_dashboard can return an access denied error for up to 24 hours after you enable the Region. This delay occurs while dashboard data propagates. The error does not indicate a problem with your permissions. Because dashboards are global, you can call get_dashboard in any other enabled Region, or retry after propagation completes.

Usage

cloudwatch_get_dashboard(DashboardName)

Arguments

  • DashboardName

    [required] The name of the dashboard to be described.

Value

A list with the following syntax:

list(
  DashboardArn = "string",
  DashboardBody = "string",
  DashboardName = "string"
)

Request syntax

svc$get_dashboard(
  DashboardName = "string"
)