v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141341,3811.0 MB

Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the [CreateTemplate](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html) API operation.

A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.

post/accounts/{AwsAccountId}/dashboards/{DashboardId}

Path parameters

AwsAccountIdstring required

The ID of the Amazon Web Services account where you want to create the dashboard.

DashboardIdstring required

The ID for the dashboard, also added to the IAM policy.

Request body

Namestring required

The display name of the dashboard.

VersionDescriptionstring

A description for the first version of the dashboard being created.

ThemeArnstring

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

Response

Success

Arnstring

The ARN of the dashboard.

VersionArnstring

The ARN of the dashboard, including the version number of the first version that is created.

DashboardIdstring

The ID for the dashboard.

CreationStatus'CREATION_IN_PROGRESS' | 'CREATION_SUCCESSFUL' | 'CREATION_FAILED' | 'UPDATE_IN_PROGRESS' | 'UPDATE_SUCCESSFUL' | 'UPDATE_FAILED' | 'DELETED'

The status of the dashboard creation request.

Statusinteger

The HTTP status of the request.

RequestIdstring

The Amazon Web Services request ID for this operation.