SearchDashboards - 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).


Searches for dashboards that belong to a user.


This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Request Syntax

POST /accounts/AwsAccountId/search/dashboards HTTP/1.1 Content-type: application/json { "Filters": [ { "Name": "string", "Operator": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" }

URI Request Parameters

The request uses the following URI parameters.


The ID of the Amazon account that contains the user whose dashboards you're searching for.

Length Constraints: Fixed length of 12.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.


The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]

Type: Array of DashboardSearchFilter objects

Array Members: Fixed number of 1 item.

Required: Yes


The maximum number of results to be returned per request.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No


The token for the next set of results, or null if there are no more results.

Type: String

Required: No

Response Syntax

HTTP/1.1 Status Content-type: application/json { "DashboardSummaryList": [ { "Arn": "string", "CreatedTime": number, "DashboardId": "string", "LastPublishedTime": number, "LastUpdatedTime": number, "Name": "string", "PublishedVersionNumber": number } ], "NextToken": "string", "RequestId": "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 list of dashboards owned by the user specified in Filters in your request.

Type: Array of DashboardSummary objects

Array Members: Maximum number of 100 items.


The token for the next set of results, or null if there are no more results.

Type: String


The Amazon request ID for this operation.

Type: String


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


An internal failure occurred.

HTTP Status Code: 500


The NextToken value isn't valid.

HTTP Status Code: 400


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

HTTP Status Code: 400


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: