如何在嵌入的AWS QuickSight仪表盘中启用书签功能？

问题背景 #

尝试在嵌入式AWS QuickSight仪表盘中启用书签功能，参照官方文档配置了GenerateEmbedUrlForRegisteredUser的相关参数，使用Axios调用API后，配置未生效，书签仍未显示。

核心问题分析 #

你的代码存在几个关键错误，导致配置未被正确识别：

• 请求参数位置错误：GenerateEmbedUrlForRegisteredUser是POST API，所有核心配置（包括ExperienceConfiguration）需要放在请求体中，而非URL参数（params）里。
• 体验类型冲突：ExperienceConfiguration中同时指定了多种体验类型（Dashboard、DashboardVisual、QSearchBar等），但该API仅允许配置一种体验类型，多余配置会导致解析异常。
• 必填参数缺失：InitialDashboardId未填写实际的仪表盘ID，为空值会导致配置不生效。
• 错误使用GET请求：GenerateEmbedUrlForRegisteredUser仅支持POST请求，GET调用完全不符合API规范。

修正步骤及代码示例 #

1. 核心修正点 #

• 仅保留POST调用逻辑（GET方法不适用该API，可删除或调整为其他用途）
• 将ExperienceConfiguration移至请求体，仅保留Dashboard相关配置
• 填写实际的InitialDashboardId和UserArn（按需提供）
• 确保请求头包含正确的JSON类型声明

2. 修改后的代码 #

import Axios from "axios";
import { v4 as uuidv4 } from "uuid";

export async function syncQSretrieveDashboards(
  userEmailAddress,
  groupsArr,
  accessToken,
  dashboardId, // 传入实际的仪表盘ID
  userArn // 传入用户ARN，按需提供
) {
  try {
    const headers = {
      Authorization: accessToken,
      "Content-Type": "application/json"
    };
    // 严格遵循GenerateEmbedUrlForRegisteredUser的请求体格式
    const requestBody = {
      UserArn: userArn,
      SessionLifetimeInMinutes: 60, // 按需设置会话时长，范围15-600分钟
      ExperienceConfiguration: {
        Dashboard: {
          InitialDashboardId: dashboardId, // 必填：填写目标仪表盘的实际ID
          FeatureConfigurations: {
            Bookmarks: {
              Enabled: true
            },
            StatePersistence: {
              Enabled: true
            }
          }
        }
      },
      UserEmail: userEmailAddress,
      CorrelationId: uuidv4()
    };

    const quicksightAPIResponse = await Axios.post(
      process.env.REACT_APP_POST_DASHBOARDS,
      requestBody,
      { headers }
    );

    console.log("QS API响应: ", quicksightAPIResponse);
    return quicksightAPIResponse;
  } catch (e) {
    console.error("调用QS API失败: ", e);
    throw e; // 抛出错误便于上层业务处理
  }
}

3. 额外检查项 #

• IAM权限：确保调用API的角色拥有quicksight:GenerateEmbedUrlForRegisteredUser权限，且目标用户已被授权访问指定仪表盘。
• 嵌入SDK版本：使用最新版的QuickSight嵌入SDK，旧版本可能不支持书签功能。
• 仪表盘设置：在QuickSight控制台确认目标仪表盘未禁用书签功能。

内容的提问来源于stack exchange，提问作者Drake