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

# 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 账户与您的Amazon 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 ID keyson QuickSight 仪表板的控制台 URL
+  `/analyses/AnalysisId `-其中`AnalysisId`是来自Amazon 的实际 ID ID keyson QuickSight 分析的控制台 URL
长度限制：最小长度为 1。长度上限为 1000。

 ** [SessionLifetimeInMinutes](#API_GetSessionEmbedUrl_RequestSyntax) **   <a name="QS-GetSessionEmbedUrl-request-SessionLifetimeInMinutes"></a>
会话的有效时长（以分钟为单位）。会话生命周期必须为 15-600 分钟。  
有效范围：最小值为 15。最大值为 600。

 ** [UserArn](#API_GetSessionEmbedUrl_RequestSyntax) **   <a name="QS-GetSessionEmbedUrl-request-UserArn"></a>
Amazon QuickSight 用户的 Amazon 资源名称 (ARN)，用于与`QUICKSIGHT`身份类型。你可以将它用于任何类型的亚马逊 QuickSight 您账户中的用户（读者、作者或管理员）。他们需要以下项目之一进行身份验证的：  

1. Active Directory (AD) 用户或组成员

1. 已邀请的非联合用户

1.  AWS Identity and Access Management(OpenID Connesource Connect 或 IAM 联合，通过联合单点登录进行身份验证的 AM 角色的会话
对于第三组中的用户、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>
一次性网址，您可以将其放入服务器端网页以嵌入您的亚马逊 QuickSight 会话。此 URL 的有效时间为 5 分钟。API 操作为 URL 提供了一个`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-600 分钟。  
HTTP 状态代码：400

 ** ThrottlingException **   
访问受限。  
HTTP 状态代码：429

 ** UnsupportedUserEditionException **   
此错误表示您正在 Amazon 上调用某个操作 QuickSight该版本不支持该操作的订阅。Amazon QuickSight 当前具有标准版和企业版。每个版本中并未提供所有操作和功能。  
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 SDK](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 SDK](https://docs.aws.amazon.com/goto/SdkForGoV1/quicksight-2018-04-01/GetSessionEmbedUrl) 
+  [适用于 Java V2 的 AWS SDK](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 V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/GetSessionEmbedUrl)