Sign in

v1

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

Updates a dashboard in an Amazon Web Services account.

Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the [UpdateDashboardPublishedVersion](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateDashboardPublishedVersion.html) API operation.

put/accounts/{AwsAccountId}/dashboards/{DashboardId}

Path parameters

AwsAccountIdstring required

The ID of the Amazon Web Services account that contains the dashboard that you're updating.

DashboardIdstring required

The ID for the dashboard.

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 was originally associated with the entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

Response

Success

Arnstring

The Amazon Resource Name (ARN) of the resource.

VersionArnstring

The ARN of the dashboard, including the version number.

DashboardIdstring

The ID for the dashboard.

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

The creation status of the request.

Statusinteger

The HTTP status of the request.

RequestIdstring

The Amazon Web Services request ID for this operation.