Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateDashboard

Creates a new dashboard that can contain multiple widgets displaying cost and usage data. You can add custom widgets or use predefined widgets, arranging them in your preferred layout.

Request Syntax


{
   "description": "string",
   "name": "string",
   "resourceTags": [ 
      { 
         "key": "string",
         "value": "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.

description

A description of the dashboard's purpose or contents.

Type: String

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

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

Required: No

name

The name of the dashboard. The name must be unique within your account.

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: Yes

resourceTags

The tags to apply to the dashboard resource for organization and management.

Type: Array of ResourceTag objects

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

Required: No

widgets

An array of widget configurations that define the visualizations to be displayed in the dashboard. Each dashboard can contain up to 20 widgets.

Type: Array of Widget objects

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

Required: Yes

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 newly created 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

ServiceQuotaExceededException

The request would exceed service quotas. For example, attempting to create more than 20 widgets in a dashboard or exceeding the maximum number of dashboards per account.

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