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

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

GenerateEmbedUrlForRegisteredUser

生成一個嵌入的 URL，您可以用來嵌入亞馬遜 QuickSight 您網站的經驗。此操作可用於在亞馬遜註冊的任何類型的用戶 QuickSight 帳戶。使用此操作之前，請確認您已設定相關的 Amazon QuickSight 資源和權限。

下列規則會套用至產生的 URL：

  • 它包含一個臨時承載令牌。它在生成之後的 5 分鐘內有效。一旦在此期間內兌換，將不能再次使用。

  • URL 有效期間不應與實際的工作階段存留期混淆，該存留期可以使用 SessionLifetimeInMinutes 參數。

    產生的使用者工作階段有效期為 15 分鐘 (最少) 到 10 小時 (最長)。預設工作階段持續時間為 10 小時。

  • 只有在使用網址或與亞馬遜互動時才會向您收費 QuickSight。

如需詳細資訊，請參閱「」內嵌式分析中的亞馬遜 QuickSight 使用者指南。

如需有關嵌入的高階步驟，以及如需自訂嵌入方式的互動式示範的詳細資訊，請造訪亞馬遜 QuickSight 開發人員入口網站。

請求語法

POST /accounts/AwsAccountId/embed-url/registered-user HTTP/1.1
Content-type: application/json

{
   "AllowedDomains": [ "string" ],
   "ExperienceConfiguration": { 
      "Dashboard": { 
         "InitialDashboardId": "string"
      },
      "QSearchBar": { 
         "InitialTopicId": "string"
      },
      "QuickSightConsole": { 
         "InitialPath": "string"
      }
   },
   "SessionLifetimeInMinutes": number,
   "UserArn": "string"
}

URI 請求參數

請求會使用下列 URI 參數。

AwsAccountId

的 IDAWS 帳戶其中包含您要嵌入的儀表板。

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

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

必要：是

請求主體

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

ExperienceConfiguration

您正在嵌入的體驗。對於註冊用戶，您可以嵌入亞馬遜 QuickSight 儀表板或整個亞馬遜 QuickSight console (&Wight)

類型：RegisteredUserEmbeddingExperienceConfiguration 物件

必要：是

UserArn

註冊使用者的 Amazon Resource Name。

類型：字串

必要：是

AllowedDomains

您要新增至允許清單以存取隨後內嵌產生的 URL 的網域。此選用參數會覆寫在「管理」中設定的靜態網域 QuickSight 亞馬遜菜單 QuickSight console (&Wight) 相反地，它只允許您包含在此參數中的網域。您可以在每個 API 呼叫中列出最多三個網域或子網域。

若要將特定網域下的所有子網域納入允許清單，請使用*。例如：https://*.sapp.amazon.com包括下面的所有子域https://sapp.amazon.com。

類型：字串陣列

必要：否

SessionLifetimeInMinutes

工作階段維持有效的分鐘數。工作階段生命週期必須介於 [15-600] 分鐘。

類型：Long

有效範圍：最小值為 15。最大值為 600。

必要：否

回應語法

HTTP/1.1 Status
Content-type: application/json

{
   "EmbedUrl": "string",
   "RequestId": "string"
}

回應元素

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

Status

請求的 HTTP 狀態。

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

EmbedUrl

亞馬遜的嵌入網址 QuickSight 儀表板或控制台。

類型：字串

RequestId

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

類型：字串

錯誤

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

AccessDeniedException

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

HTTP 狀態碼：401

InternalFailureException

發生內部故障。

HTTP 狀態碼：500

InvalidParameterValueException

一或多個參數的值無效。

HTTP 狀態碼：400

QuickSightUserNotFoundException

找不到提供名稱的使用者。此錯誤可能發生於需要根據所提供使用者名稱尋找尋找使用者名稱尋找尋找使用者名稱尋找尋找使用者名稱DeleteUser、DescribeUser，以此類推。

HTTP 狀態碼：404

ResourceNotFoundException

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

HTTP 狀態碼：404

SessionLifetimeInMinutesInvalidException

針對工作階段生命週期指定的分鐘數無效。工作階段生命週期必須為 15-600 分鐘。

HTTP 狀態碼：400

ThrottlingException

存取已調節。

HTTP 狀態碼：429

UnsupportedPricingPlanException

此錯誤表明您正在調用亞馬遜中的嵌入操作 QuickSight沒有所需的定價計劃AWS帳戶。在您可以為匿名使用者使用內嵌之前， QuickSight 管理員需要將容量定價新增至 Amazon QuickSight。您可以在管理 Amazon QuickSight(憑證已建立！) 頁面上的名稱有些許差異。

新增容量定價後，您可以使用 GetDashboardEmbedUrl 使用者進行 API 操作--identity-type ANONYMOUS選項。

HTTP 狀態碼：403

UnsupportedUserEditionException

此錯誤表示您正在呼叫 Amazon (Amazon) 的操作 QuickSight訂閱版本不包括對該操作的支持。Amazon QuickSight 目前包含 Standard Edition (企業版)。不是每個版本都會提供所有操作和功能。

HTTP 狀態碼：403

另請參閱

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