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.
Request Parameters
For information about the parameters that are common to all actions, see Common 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 Errors.
- InternalServiceError
-
Request processing has failed due to some unknown error, exception, or failure.
HTTP Status Code: 500
- InvalidParameterValue
-
The value of an input parameter is bad or out-of-range.
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:
