GenerateEmbedUrlForAnonymousUser - Amazon QuickSight

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

GenerateEmbedUrlForAnonymousUser

生成可用于嵌入亚马逊的嵌入 URL QuickSight 仪表板在您的网站中,无需注册任何读者用户。在使用此操作之前,请确保您已配置仪表板和权限。

以下规则适用于生成的 URL:

  • 它包含一个临时不记名令牌。在生成后的 5 分钟内有效。在此期限内兑换后,将无法再次使用。

  • 不应将 URL 有效期与实际会话生命周期混淆,后者可以使用 SessionLifetimeInMinutes 参数。生成的用户会话有效期为 15 分钟(最短)到 10 小时(最长)。默认会话持续时间为 10 小时。

  • 仅当使用 URL 或与亚马逊互动时,您才需要付费 QuickSight.

有关更多信息,请参阅 。嵌入式分析中的亚马逊 QuickSight 用户指南.

有关嵌入的高级步骤的详细信息以及自定义嵌入方式的交互式演示,请访问亚马逊 QuickSight 开发人员门户.

请求语法

POST /accounts/AwsAccountId/embed-url/anonymous-user HTTP/1.1 Content-type: application/json { "AllowedDomains": [ "string" ], "AuthorizedResourceArns": [ "string" ], "ExperienceConfiguration": { "Dashboard": { "InitialDashboardId": "string" } }, "Namespace": "string", "SessionLifetimeInMinutes": number, "SessionTags": [ { "Key": "string", "Value": "string" } ] }

URI 请求参数

请求使用以下 URI 参数。

AwsAccountId

对于是AWS 账户包含您要嵌入的仪表板。

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

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

要求: 是

请求正文

请求接受采用 JSON 格式的以下数据。

AuthorizedResourceArns

Amazon 资源名称 (ARN) QuickSight 授权用户在会话生命周期内访问的资源。如果选择Dashboard嵌入体验,传递您希望用户能够查看的账户中的仪表板 ARN 列表。目前,您最多可以在每个 API 调用中传递 25 个仪表板 ARN。

类型: 字符串数组

要求: 是

ExperienceConfiguration

您正在嵌入的体验的配置。

类型:AnonymousUserEmbeddingExperienceConfiguration 对象

要求: 是

Namespace

Amazon QuickSight 匿名用户虚拟所属的命名空间。如果你没有使用亚马逊 QuickSight 自定义命名空间,将其设置为default.

类型: 字符串

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

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

要求: 是

AllowedDomains

要添加到允许列表以访问随后嵌入的生成的 URL 的域。此可选参数将覆盖在 Manage 中配置的静态域 QuickSight 亚马逊的菜单 QuickSight 控制台。相反,它只允许您在此参数中包含的域。在每个 API 调用中,您最多可以列出三个域或子域。

要将特定域下的所有子域包含到允许列表中,请使用*. 例如,https://*.sapp.amazon.com包括以下所有子域https://sapp.amazon.com.

类型: 字符串数组

要求: 否

SessionLifetimeInMinutes

会话的有效时长(以分钟为单位) 会话生命周期必须介于 [15-600] 分钟范围内。

类型: 长整型

有效范围: 最小值为 15。最大值为 600。

要求: 否

SessionTags

用于行级别安全的会话标记。在使用此参数之前,请确保您已使用DataSet$RowLevelPermissionTagConfiguration参数,以便会话标记可用于提供行级安全性。

这些不是用于AWS资源标记功能。有关更多信息,请参阅 。使用具有标记的行级别安全性 (RLS)中的亚马逊 QuickSight 用户指南.

类型: 数组的SessionTag对象

数组成员:最少 1 项。最多 50 项。

要求: 否

响应语法

HTTP/1.1 Status Content-type: application/json { "EmbedUrl": "string", "RequestId": "string" }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 响应。

Status

请求的 HTTP 状态。

服务以 JSON 格式返回的以下数据。

EmbedUrl

仪表板的嵌入 URL。

类型: 字符串

RequestId

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

类型: 字符串

错误

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

AccessDeniedException

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

HTTP 状态代码:401

InternalFailureException

出现内部故障。

HTTP 状态代码:500

InvalidParameterValueException

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

HTTP 状态代码:400

ResourceNotFoundException

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

HTTP 状态代码:404

SessionLifetimeInMinutesInvalidException

为会话生命周期指定的分钟数无效。会话生命周期必须为 15-600 分钟。

HTTP 状态代码:400

ThrottlingException

访问受限。

HTTP 状态代码:429

UnsupportedPricingPlanException

此错误表示您正在亚马逊中调用嵌入操作 QuickSight没有您所需的定价计划AWSaccount. 在对匿名用户使用嵌入之前, QuickSight 管理员需要向亚马逊添加容量定价 QuickSight. 您可在管理Amazon QuickSight页.

添加容量定价后,您可以使用 GetDashboardEmbedUrl 使用的--identity-type ANONYMOUS选项。

HTTP 状态代码:403

UnsupportedUserEditionException

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

HTTP 状态代码:403

另请参阅

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