SearchDashboards - Amazon QuickSight

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

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 状态代码:500

InvalidNextTokenException

NextToken 值无效。

HTTP 状态代码:400

InvalidParameterValueException

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

HTTP 状态代码:400

ResourceNotFoundException

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

HTTP 状态代码:404

ThrottlingException

访问受限。

HTTP 状态代码:429

UnsupportedUserEditionException

此错误指示您正在 Amazon 上调用某个操作 QuickSight该版本不支持该操作的订阅。Amazon QuickSight 当前具有标准版和企业版。每个版本中并未提供所有操作和功能。

HTTP 状态代码:403

另请参阅

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