本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
SearchDashboards
搜尋屬於使用者的控制面板。
注意
此操作為最終一致。結果則為不一定會反映最新的更新和變更。
請求語法
POST /accounts/AwsAccountId
/search/dashboards HTTP/1.1
Content-type: application/json
{
"Filters": [
{
"Name": "string
",
"Operator": "string
",
"Value": "string
"
}
],
"MaxResults": number
,
"NextToken": "string
"
}
URI 請求參數
請求會使用下列 URI 參數。
- AwsAccountId
-
的 IDAWS包含您要搜尋其儀表板的使用者的帳戶。
長度限制:固定長度為 12。
模式:
^[0-9]{12}$
必要項目:是
請求主體
請求接受採用 JSON 格式的下列資料。
- Filters
-
要套用至搜尋的篩選器。目前,您只能以使用者名稱搜尋,例如:
"Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]
類型:的陣列陣列DashboardSearchFilter對象
陣列成員:固定項目數為 1。
必要項目:是
- MaxResults
-
每筆請求傳回結果的最大數量。
類型:整數
有效範圍:最小值為 1。最大值為 100。
必要項目:否
- NextToken
-
用於下一組結果的符記,如果沒有更多結果則為 null。
類型:字串
必要項目:否
回應語法
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"
}
回應元素
如果動作成功,則服務傳回下列 HTTP 回應。
- Status
-
請求的 HTTP 狀態。
服務會傳回下列 JSON 格式的資料。
- DashboardSummaryList
-
在中指定的使用者所擁有的儀表板清單
Filters
在您的請求中。類型:的陣列陣列DashboardSummary對象
陣列成員:項目數上限為 100。
- NextToken
-
用於下一組結果的符記,如果沒有更多結果則為 null。
類型:字串
- RequestId
-
所以此AWS此操作的請求 ID。
類型:字串
錯誤
如需所有動作常見的錯誤相關資訊,請參閱常見錯誤。
- InternalFailureException
-
發生內部故障。
HTTP 狀態碼:HTTP 狀態碼:500
- InvalidNextTokenException
-
NextToken
值無效。HTTP 狀態碼:HTTP 狀態碼:400
- InvalidParameterValueException
-
一或多個參數的值無效。
HTTP 狀態碼:HTTP 狀態碼:400
- ResourceNotFoundException
-
無法找到一個或多個資源。
HTTP 狀態碼:HTTP 狀態碼:404
- ThrottlingException
-
存取已調節。
HTTP 狀態碼:HTTP 狀態碼:429
- UnsupportedUserEditionException
-
此錯誤表示您正在呼叫 Amazon 上的操作 QuickSight訂閱版本不包括對該操作的支持。Amazon QuickSight 目前包含 Standard Edition (企業版)。不是每個版本都會提供所有操作和功能。
HTTP 狀態碼:HTTP 狀態碼:403
另請參閱
如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊,請參閱下列說明: