POST

/accounts/{AwsAccountId}/search/dashboards

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

<p>Searches for dashboards that belong to a user. </p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note>

Access Token Required: API Key

Path Parameters

AwsAccountIdstringrequired

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

Query Params

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

Body Params

Filtersarrayrequired

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

NextTokenstring

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

MaxResultsinteger

The maximum number of results to be returned per request.

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 POST \
2     --url 'http://quicksight.{region}.amazonaws.com/accounts/{AwsAccountId}/search/dashboards' \
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}