CreateDashboard - Amazon QuickSight


Creates a dashboard from a template. To first create a template, see the CreateTemplate 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 AWS account.

Request Syntax

POST /accounts/AwsAccountId/dashboards/DashboardId HTTP/1.1 Content-type: application/json { "DashboardPublishOptions": { "AdHocFilteringOption": { "AvailabilityStatus": "string" }, "ExportToCSVOption": { "AvailabilityStatus": "string" }, "SheetControlsOption": { "VisibilityState": "string" }, "VisualPublishOptions": { "ExportHiddenFieldsOption": { "AvailabilityStatus": "string" } } }, "Definition": { "AnalysisDefaults": { "DefaultNewSheetConfiguration": { ... } }, "CalculatedFields": [ { ... } ], "ColumnConfigurations": [ { ... } ], "DataSetIdentifierDeclarations": [ { ... } ], "FilterGroups": [ { ... } ], "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" ] } ] }, "Permissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "SourceEntity": { "SourceTemplate": { "Arn": "string", "DataSetReferences": [ { "DataSetArn": "string", "DataSetPlaceholder": "string" } ] } }, "Tags": [ { "Key": "string", "Value": "string" } ], "ThemeArn": "string", "VersionDescription": "string" }

URI Request Parameters

The request uses the following URI parameters.


The ID of the AWS account where you want to create the dashboard.

Length Constraints: Fixed length of 12.

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

Required: Yes


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

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


The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.

Type: Parameters object

Required: No


A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

To specify no permissions, omit the permissions list.

Type: Array of ResourcePermission objects

Array Members: Minimum number of 1 item. Maximum number of 64 items.

Required: No


The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create 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 SourceTemplateARN can contain any AWS account and any Amazon QuickSight-supported AWS 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


Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 200 items.

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 is used in the source entity. The theme ARN must exist in the same AWS account where you create the dashboard.

Type: String

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

Response Elements

If the action is successful, the service sends back the following HTTP response.


The HTTP status of the request.

The following data is returned in JSON format by the service.


The ARN of the dashboard.

Type: String


The status of the dashboard creation request.

Type: String



The ID for the dashboard.

Type: String

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

Pattern: [\w\-]+


The AWS request ID for this operation.

Type: String


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

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


The resource specified already exists.

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 AWS SDKs, see the following: