Own AWS? Customize your docs with AI search, analytics, and more.

PUT

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

http://quicksight.{region}.amazonaws.com/accounts/{AwsAccountId}/dashboards/{DashboardId}

Updates a dashboard in an Amazon Web Services account. <note> 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 <code> <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateDashboardPublishedVersion.html">UpdateDashboardPublishedVersion</a> </code> API operation. </note>

Access Token Required: API Key

Path Parameters

AwsAccountIdstringrequired

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

DashboardIdstringrequired

The ID for the dashboard.

Body Params

Namestringrequired

The display name of the dashboard.

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.

Definitionobject

The contents of a dashboard.

Parametersobject

A list of Amazon QuickSight parameters and the list's override values.

SourceEntityobject

Dashboard source entity.

VersionDescriptionstring

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

DashboardPublishOptionsobject

Dashboard publish options.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://quicksight.{region}.amazonaws.com/accounts/{AwsAccountId}/dashboards/{DashboardId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

PUT