Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetDashboard

Retrieves the configuration and metadata of a specified dashboard, including its widgets and layout settings.

Request Syntax


{
   "arn": "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.

arn

The ARN of the dashboard to retrieve. This is required to uniquely identify the dashboard.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws[-a-z0-9]*:bcm-dashboards::[0-9]{12}:dashboard/(\*|[-a-z0-9]+)

Required: Yes

Response Syntax


{
   "arn": "string",
   "createdAt": number,
   "description": "string",
   "name": "string",
   "type": "string",
   "updatedAt": number,
   "widgets": [ 
      { 
         "configs": [ 
            { 
               "displayConfig": { ... },
               "queryParameters": { ... }
            }
         ],
         "description": "string",
         "height": number,
         "horizontalOffset": number,
         "title": "string",
         "width": number
      }
   ]
}

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.

arn

The ARN of the retrieved dashboard.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws[-a-z0-9]*:bcm-dashboards::[0-9]{12}:dashboard/(\*|[-a-z0-9]+)

createdAt

The timestamp when the dashboard was created.

Type: Timestamp

description

The description of the retrieved dashboard.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: (?!.* {2})[ a-zA-Z0-9.,!?;:@#$%&\-_/\\]*

name

The name of the retrieved dashboard.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 50.

Pattern: (?!.* {2})[a-zA-Z][a-zA-Z0-9 _-]{0,48}[a-zA-Z0-9_-]

type

Indicates the dashboard type.

Type: String

Valid Values: CUSTOM

updatedAt

The timestamp when the dashboard was last modified.

Type: Timestamp

widgets

An array of widget configurations that make up the dashboard.

Type: Array of Widget objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.

HTTP Status Code: 400

InternalServerException

An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Support.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.

HTTP Status Code: 400

ValidationException

The input parameters do not satisfy the requirements. Check the error message for specific validation details.

HTTP Status Code: 400