GetDashboard
Displays the details of the dashboard that you specify.
To copy an existing dashboard, use GetDashboard, and then use the data
returned within DashboardBody as the template for the new dashboard when
you call PutDashboard 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, GetDashboard 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
GetDashboard in any other enabled Region, or retry after propagation
completes.
Request Parameters
- DashboardName
-
The name of the dashboard to be described.
Type: String
Required: Yes
Response Elements
The following elements are returned by the service.
- DashboardArn
-
The Amazon Resource Name (ARN) of the dashboard.
Type: String
- DashboardBody
-
The detailed information about the dashboard, including what widgets are included and their location on the dashboard. For more information about the
DashboardBodysyntax, see Dashboard Body Structure and Syntax.Type: String
- DashboardName
-
The name of the dashboard.
Type: String
Errors
For information about the errors that are common to all actions, see Common Error Types.
- InternalServiceError
-
Request processing has failed due to some unknown error, exception, or failure.
- Message
HTTP Status Code: 500
- InvalidParameterValue
-
The value of an input parameter is bad or out-of-range.
- message
HTTP Status Code: 400
- ResourceNotFound
-
The specified dashboard does not exist.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
