Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateDashboard

Updates an existing dashboard's properties, including its name, description, and widget configurations.

Request Syntax


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

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 update.

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

description

The new description for the dashboard. If not specified, the existing description is retained.

Type: String

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

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

Required: No

name

The new name for the dashboard. If not specified, the existing name is retained.

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_-]

Required: No

widgets

The updated array of widget configurations for the dashboard. Replaces all existing widgets.

Type: Array of Widget objects

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

Required: No

Response Syntax


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

arn

The ARN of the updated 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]+)

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 AWS 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