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

# GetSessionEmbedUrl
<a name="API_GetSessionEmbedUrl"></a>

生成一個會話 URL 和授權碼，您可以用它來嵌入亞馬遜亞馬遜 QuickSight 您的 Web 服務器代碼中的控制台。使用`GetSessionEmbedUrl`您想要提供可讓使用者建立資料來源、資料集、分析和儀表板的撰寫入口網站。訪問嵌入式亞馬遜的用戶 QuickSight 控制台需要屬於作者或管理員安全同類群組。如果您想要限制其中某些功能的權限，請使用` [UpdateUser](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html) `API 操作。使用` [RegisterUser](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html) `用於添加帶有自定義權限配置文件的新用戶的 API 操作。如需詳細資訊，請參閱《》*亞馬遜 QuickSight 使用者指南*：
+  [內嵌分析](https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html) 
+  [自訂對亞馬遜的存取 QuickSight 主控台](https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html) 

## 請求語法
<a name="API_GetSessionEmbedUrl_RequestSyntax"></a>

```
GET /accounts/AwsAccountId/session-embed-url?entry-point=EntryPoint&session-lifetime=SessionLifetimeInMinutes&user-arn=UserArn HTTP/1.1
```

## URI 請求參數
<a name="API_GetSessionEmbedUrl_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [AwsAccountId](#API_GetSessionEmbedUrl_RequestSyntax) **   <a name="QS-GetSessionEmbedUrl-request-AwsAccountId"></a>
的 IDAWS 帳戶與您的亞馬遜相關 QuickSight 訂閱。  
長度限制：固定長度為 12。  
模式：`^[0-9]{12}$`  
必要：是

 ** [EntryPoint](#API_GetSessionEmbedUrl_RequestSyntax) **   <a name="QS-GetSessionEmbedUrl-request-EntryPoint"></a>
您用來存取內嵌工作階段的 URL。入口點 URL 受限於下列路徑：  
+  `/start` 
+  `/start/analyses` 
+  `/start/dashboards` 
+  `/start/favorites` 
+  `/dashboards/DashboardId `-位置`DashboardId`是來自 Amazon 的實際 ID 金鑰 QuickSight 儀表板的主控台 URL
+  `/analyses/AnalysisId `-位置`AnalysisId`是來自 Amazon 的實際 ID 金鑰 QuickSight 分析的主控台 URL
長度限制：長度下限為 1。長度上限為 1000。

 ** [SessionLifetimeInMinutes](#API_GetSessionEmbedUrl_RequestSyntax) **   <a name="QS-GetSessionEmbedUrl-request-SessionLifetimeInMinutes"></a>
工作階段維持有效的分鐘數。工作階段生命週期必須為 15  
有效範圍：最小值為 15。最大值為 600。

 ** [UserArn](#API_GetSessionEmbedUrl_RequestSyntax) **   <a name="QS-GetSessionEmbedUrl-request-UserArn"></a>
Amazon QuickSight 使用者的 Amazon Resource Name (ARN)，以使用`QUICKSIGHT`身分類型。您可以將其用於任何類型的亞馬遜 QuickSight 您帳戶中的使用者 (讀者、作者或管理員)。他們需要以下其中一個項目進行驗證：  

1. Active Directory (AD) 使用者或群組成員

1. 受邀的非同盟使用者

1.  AWS Identity and Access Management(IAM) 使用 SAML、或 IAM Feder` 並透過聯合單一登入進行驗證的使用者和以 IAM 角色為基礎的工作階段
針對第三個群組中的使用者 (IAM 使用者和 IAM 角色型工作階段)，省略此參數。

## 請求主體
<a name="API_GetSessionEmbedUrl_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_GetSessionEmbedUrl_ResponseSyntax"></a>

```
HTTP/1.1 Status
Content-type: application/json

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

## 回應元素
<a name="API_GetSessionEmbedUrl_ResponseElements"></a>

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

 ** [Status](#API_GetSessionEmbedUrl_ResponseSyntax) **   <a name="QS-GetSessionEmbedUrl-response-Status"></a>
請求的 HTTP 狀態。

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

 ** [EmbedUrl](#API_GetSessionEmbedUrl_ResponseSyntax) **   <a name="QS-GetSessionEmbedUrl-response-EmbedUrl"></a>
一個單次使用的 URL，您可以將其放入服務器端網頁中以嵌入亞馬遜 QuickSight 工作階段。此網址的有效期為 5 分鐘。該 API 操作提供了一個網址`auth_code`此值可讓您一次 (且只有一次) 登入使用者工作階段，該使用者工作階段有效期為 10 小時。  
類型：字串

 ** [RequestId](#API_GetSessionEmbedUrl_ResponseSyntax) **   <a name="QS-GetSessionEmbedUrl-response-RequestId"></a>
所以此AWS此操作的請求 ID。  
類型：字串

## 錯誤
<a name="API_GetSessionEmbedUrl_Errors"></a>

如需所有動作常見的錯誤相關資訊，請參閱[常見錯誤](CommonErrors.md)。

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

 ** InternalFailureException **   
發生內部故障。  
HTTP 500

 ** InvalidParameterValueException **   
一或多個參數的值無效。  
HTTP 400

 ** QuickSightUserNotFoundException **   
找不到提供名稱的使用者。這可能發生於需要根據所提供使用者名稱尋找使用者的任何操作，例如`DeleteUser`、`DescribeUser`，以此類推。  
HTTP 404

 ** ResourceExistsException **   
指定的資源已存在。  
HTTP 409

 ** ResourceNotFoundException **   
無法找到一個或多個資源。  
HTTP 404

 ** SessionLifetimeInMinutesInvalidException **   
針對工作階段生命週期指定的分鐘數無效。工作階段生命週期必須為 15  
HTTP 400

 ** ThrottlingException **   
存取已調節。  
HTTP 429

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

## 另請參閱
<a name="API_GetSessionEmbedUrl_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [AWS 命令列界面](https://docs.aws.amazon.com/goto/aws-cli/quicksight-2018-04-01/GetSessionEmbedUrl) 
+  [適用於 .NET 的 AWS 開發套件](https://docs.aws.amazon.com/goto/DotNetSDKV3/quicksight-2018-04-01/GetSessionEmbedUrl) 
+  [適用於 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/GetSessionEmbedUrl) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/quicksight-2018-04-01/GetSessionEmbedUrl) 
+  [適用於 Java 的 AWS 開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/GetSessionEmbedUrl) 
+  [AWS適用於 JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/quicksight-2018-04-01/GetSessionEmbedUrl) 
+  [適用於 PHP V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/quicksight-2018-04-01/GetSessionEmbedUrl) 
+  [適用於 Python 的 AWS SDK](https://docs.aws.amazon.com/goto/boto3/quicksight-2018-04-01/GetSessionEmbedUrl) 
+  [適用於 Ruby 的 AWS 開發套件第 3 版](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/GetSessionEmbedUrl)