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

组所在 AWS 账户的 ID。目前，您将 ID 用于AWS包含您的亚马逊账户 QuickSight account.

长度限制: 固定长度为 12。

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

必需：必需 是

MaxResults

此请求中要返回的最大结果数。

有效范围：有效范围: 最小值为 1。最大值为 100。

Namespace

要搜索的命名空间。

长度限制: 最大长度为 64。

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

必需：必需 是

NextToken

分页标记，您可在后续的 DescribeDP 使用。

请求正文

请求接受采用 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

指定命名空间中与您在指定命名空间中的组列表，与您在 Filter (筛选条件) 部分的组的列表，SearchGroups请求.

类型: 数组数组的Group对象

NextToken

分页标记，您可在后续的 DescribeDP 使用。

类型: 字符串

RequestId

这些区域有：AWS用于此操作的请求 ID。

类型: 字符串

错误

有关所有操作共有的错误的信息，请参阅常见错误.

AccessDeniedException

您无权访问此项目。无法验证提供的凭证。您可能无权执行请求。确保您的账户已获得使用亚马逊的授权 QuickSight 服务，您的策略具有正确的访问密钥。

HTP 状态代码：401

InternalFailureException

出现内部故障。

HTP 状态代码：500

InvalidNextTokenException

NextToken 值无效。

HTP 状态代码：400

InvalidParameterValueException

一个或多个参数的值无效。

HTP 状态代码：400

PreconditionNotMetException

未满足一个或多个先决条件。

HTP 状态代码：400

ResourceNotFoundException

无法找到一个或多个资源。

HTP 状态代码：404

ResourceUnavailableException

此资源当前不可用。

HTP 状态代码：503

ThrottlingException

访问受限。

HTP 状态代码：429

另请参阅

有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息，请参阅以下内容：