UpdateDashboard
Updates a dashboard in an AWS 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
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.
- AwsAccountId
-
The ID of the AWS account that contains the dashboard that you're updating.
Length Constraints: Fixed length of 12.
Pattern:
^[0-9]{12}$
Required: Yes
- DashboardId
-
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.
- Name
-
The display name of the dashboard.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: Yes
- DashboardPublishOptions
-
Options for publishing the dashboard when you create it:
-
AvailabilityStatus
forAdHocFilteringOption
- This status can be eitherENABLED
orDISABLED
. When this is set toDISABLED
, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option isENABLED
by default. -
AvailabilityStatus
forExportToCSVOption
- This status can be eitherENABLED
orDISABLED
. The visual option to export data to .CSV format isn't enabled when this is set toDISABLED
. This option isENABLED
by default. -
VisibilityState
forSheetControlsOption
- This visibility state can be eitherCOLLAPSED
orEXPANDED
. This option isCOLLAPSED
by default.
Type: DashboardPublishOptions object
Required: No
-
- Definition
-
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
- Parameters
-
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
- SourceEntity
-
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 aSourceTemplate
entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using theCreateTemplate
API operation. ForSourceTemplate
, specify the Amazon Resource Name (ARN) of the source template. TheSourceTemplate
ARN can contain any AWS account and any Amazon QuickSight-supported AWS Region.Use the
DataSetReferences
entity withinSourceTemplate
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
- ThemeArn
-
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 AWS account where you create the dashboard.
Type: String
Required: No
- ValidationStrategy
-
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
- VersionDescription
-
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.
- Arn
-
The Amazon Resource Name (ARN) of the resource.
Type: String
- CreationStatus
-
The creation status of the request.
Type: String
Valid Values:
CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED
- DashboardId
-
The ID for the dashboard.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[\w\-]+
- RequestId
-
The AWS request ID for this operation.
Type: String
- Status
-
The HTTP status of the request.
Type: Integer
- VersionArn
-
The ARN of the dashboard, including the version number.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
Updating or deleting a resource can cause an inconsistent state.
HTTP Status Code: 409
- InternalFailureException
-
An internal failure occurred.
HTTP Status Code: 500
- InvalidParameterValueException
-
One or more parameters has a value that isn't valid.
HTTP Status Code: 400
- LimitExceededException
-
A limit is exceeded.
HTTP Status Code: 409
- ResourceNotFoundException
-
One or more resources can't be found.
HTTP Status Code: 404
- ThrottlingException
-
Access is throttled.
HTTP Status Code: 429
- UnsupportedUserEditionException
-
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 AWS SDKs, see the following: