SearchGroups - Amazon QuickSight
請求語法URI 請求參數請求主體回應語法回應元素錯誤另請參閱

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

SearchGroups

使用SearchGroups在指定的亞馬遜搜索組的操作 QuickSight 命名空間使用提供的過濾器。

請求語法

POST /accounts/AwsAccountId/namespaces/Namespace/groups-search?max-results=MaxResults&next-token=NextToken HTTP/1.1
Content-type: application/json

{
   "Filters": [ 
      { 
         "Name": "string",
         "Operator": "string",
         "Value": "string"
      }
   ]
}

URI 請求參數

請求會使用下列 URI 參數。

AwsAccountId

的 IDAWS群組所在的帳戶。目前，您使用的 IDAWS您的亞馬遜帳戶 QuickSight 帳戶。

長度限制：固定長度為 12。

模式：^[0-9]{12}$

必要：是

MaxResults

本次請求傳回結果的最大數量。

有效範圍：最小值為 1。最大值為 100。

Namespace

您想要搜尋的命名空間。

長度限制：長度上限為 64。

模式：^[a-zA-Z0-9._-]*$

必要：是

NextToken

可用於後續請求的分頁字符。

請求主體

請求接受採用 JSON 格式的下列資料。

Filters

您要套用至搜尋的搜尋篩選器結構。

類型：的陣列GroupSearchFilter對象

陣列成員：固定項目數為 1。

必要：是

回應語法

HTTP/1.1 Status
Content-type: application/json

{
   "GroupList": [ 
      { 
         "Arn": "string",
         "Description": "string",
         "GroupName": "string",
         "PrincipalId": "string"
      }
   ],
   "NextToken": "string",
   "RequestId": "string"
}

回應元素

如果動作成功，則服務傳回下列 HTTP 回應。

Status

請求的 HTTP 狀態。

服務會傳回下列 JSON 格式的資料。

GroupList

指定命名空間的群組清單，符合您在您的SearchGroups請求。

類型：的陣列Group對象

NextToken

可用於後續請求的分頁字符。

類型：字串

RequestId

所以此AWS此操作的請求 ID。

類型：字串

錯誤

如需所有動作常見的錯誤相關資訊，請參閱常見錯誤。

AccessDeniedException

您無法存取。提供的登入資料無法驗證。您可能無法取得授權以執行請求。確保您的帳戶已獲授權使用亞馬遜 QuickSight 服務，您的政策有正確許可，以及您使用正確的存取金鑰。

HTTP 狀態碼：401

InternalFailureException

發生內部故障。

HTTP 狀態碼：500

InvalidNextTokenException

NextToken 值無效。

HTTP 狀態碼：400

InvalidParameterValueException

一或多個參數的值無效。

HTTP 狀態碼：400

PreconditionNotMetException

未滿足一個或多個先決條件。

HTTP 狀態碼：400

ResourceNotFoundException

無法找到一個或多個資源。

HTTP 狀態碼：404

ResourceUnavailableException

此資源目前無法使用。

HTTP 狀態碼：503

ThrottlingException

存取已調節。

HTTP 狀態碼：429

另請參閱

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：