UpdateDashboard - Amazon QuickSight
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Updates a dashboard in an Amazon 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 API operation.

Request Syntax

PUT /accounts/AwsAccountId/dashboards/DashboardId HTTP/1.1 Content-type: application/json { "DashboardPublishOptions": { "AdHocFilteringOption": { "AvailabilityStatus": "string" }, "DataPointDrillUpDownOption": { "AvailabilityStatus": "string" }, "DataPointMenuLabelOption": { "AvailabilityStatus": "string" }, "DataPointTooltipOption": { "AvailabilityStatus": "string" }, "ExportToCSVOption": { "AvailabilityStatus": "string" }, "ExportWithHiddenFieldsOption": { "AvailabilityStatus": "string" }, "SheetControlsOption": { "VisibilityState": "string" }, "SheetLayoutElementMaximizationOption": { "AvailabilityStatus": "string" }, "VisualAxisSortOption": { "AvailabilityStatus": "string" }, "VisualMenuOption": { "AvailabilityStatus": "string" }, "VisualPublishOptions": { "ExportHiddenFieldsOption": { "AvailabilityStatus": "string" } } }, "Definition": { "AnalysisDefaults": { "DefaultNewSheetConfiguration": { ... } }, "CalculatedFields": [ { ... } ], "ColumnConfigurations": [ { ... } ], "DataSetIdentifierDeclarations": [ { ... } ], "FilterGroups": [ { ... } ], "Options": { "Timezone": "string", "WeekStart": "string" }, "ParameterDeclarations": [ { ... } ], "Sheets": [ { ... } ] }, "Name": "string", "Parameters": { "DateTimeParameters": [ { "Name": "string", "Values": [ number ] } ], "DecimalParameters": [ { "Name": "string", "Values": [ number ] } ], "IntegerParameters": [ { "Name": "string", "Values": [ number ] } ], "StringParameters": [ { "Name": "string", "Values": [ "string" ] } ] }, "SourceEntity": { "SourceTemplate": { "Arn": "string", "DataSetReferences": [ { "DataSetArn": "string", "DataSetPlaceholder": "string" } ] } }, "ThemeArn": "string", "ValidationStrategy": { "Mode": "string" }, "VersionDescription": "string" }

URI Request Parameters

The request uses the following URI parameters.


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

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes


The ID for the dashboard.

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

Pattern: [\w\-]+

Required: Yes

Request Body

The request accepts the following data in JSON format.


The display name of the dashboard.

Type: String

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

Required: Yes


Options for publishing the dashboard when you create it:

  • AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

  • AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

  • VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.

Type: DashboardPublishOptions object

Required: No


The definition of a dashboard.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Type: DashboardVersionDefinition object

Required: No


A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.

Type: Parameters object

Required: No


The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any Amazon account and any Amazon QuickSight-supported Amazon Web Services Region.

Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Type: DashboardSourceEntity object

Required: No


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 account where you create the dashboard.

Type: String

Required: No


The option to relax the validation needed to update a dashboard with definition objects. This skips the validation step for specific errors.

Type: ValidationStrategy object

Required: No


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

Type: String

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

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Arn": "string", "CreationStatus": "string", "DashboardId": "string", "RequestId": "string", "Status": number, "VersionArn": "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.


The Amazon Resource Name (ARN) of the resource.

Type: String


The creation status of the request.

Type: String



The ID for the dashboard.

Type: String

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

Pattern: [\w\-]+


The Amazon request ID for this operation.

Type: String


The HTTP status of the request.

Type: Integer


The ARN of the dashboard, including the version number.

Type: String


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


Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409


An internal failure occurred.

HTTP Status Code: 500


One or more parameters has a value that isn't valid.

HTTP Status Code: 400


A limit is exceeded.

HTTP Status Code: 409


One or more resources can't be found.

HTTP Status Code: 404


Access is throttled.

HTTP Status Code: 429


This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

HTTP Status Code: 403

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: