GetDashboard
Returns the specified dashboard.
Request Syntax
{
"DashboardId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- DashboardId
-
The name or ARN for the dashboard.
Type: String
Pattern:
^[a-zA-Z0-9._/\-:]+$Required: Yes
Response Syntax
{
"CreatedTimestamp": number,
"DashboardArn": "string",
"LastRefreshFailureReason": "string",
"LastRefreshId": "string",
"RefreshSchedule": {
"Frequency": {
"Unit": "string",
"Value": number
},
"Status": "string",
"TimeOfDay": "string"
},
"Status": "string",
"TerminationProtectionEnabled": boolean,
"Type": "string",
"UpdatedTimestamp": number,
"Widgets": [
{
"QueryAlias": "string",
"QueryParameters": [ "string" ],
"QueryStatement": "string",
"ViewProperties": {
"string" : "string"
}
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- CreatedTimestamp
-
The timestamp that shows when the dashboard was created.
Type: Timestamp
- DashboardArn
-
The ARN for the dashboard.
Type: String
Pattern:
^[a-zA-Z0-9._/\-:]+$ - LastRefreshFailureReason
-
Provides information about failures for the last scheduled refresh.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 1000.
Pattern:
.* - LastRefreshId
-
The ID of the last dashboard refresh.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 20.
Pattern:
\d+ - RefreshSchedule
-
The refresh schedule for the dashboard, if configured.
Type: RefreshSchedule object
- Status
-
The status of the dashboard.
Type: String
Valid Values:
CREATING | CREATED | UPDATING | UPDATED | DELETING - TerminationProtectionEnabled
-
Indicates whether termination protection is enabled for the dashboard.
Type: Boolean
- Type
-
The type of dashboard.
Type: String
Valid Values:
MANAGED | CUSTOM - UpdatedTimestamp
-
The timestamp that shows when the dashboard was last updated.
Type: Timestamp
- Widgets
-
An array of widgets for the dashboard.
Type: Array of Widget objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFoundException
-
This exception is thrown when the specified resource is not found.
HTTP Status Code: 400
- UnsupportedOperationException
-
This exception is thrown when the requested operation is not supported.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
