

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# GenerateEmbedUrlForRegisteredUser
<a name="API_GenerateEmbedUrlForRegisteredUser"></a>

Amazonの埋め込みに使用できる埋め込みURLを生成します QuickSight あなたのウェブサイトでの経験。このアクションは、Amazonに登録されているあらゆるタイプのユーザーに使用できます QuickSight アカウント. この処理を使用する前に、関連する Amazon を設定していることを確認してください QuickSight リソースと権限。

生成された URL には、次のルールが適用されます。
+ 一時的なベアラートークンが含まれています。これは、生成されてから 5 分間有効です。この期間内に引き出されると、再利用することはできません。
+ URL の有効期間は、を使用してカスタマイズできる実際のセッションの有効期間と混同しないでください。` [SessionLifetimeInMinutes](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForRegisteredUser.html#QS-GenerateEmbedUrlForRegisteredUser-request-SessionLifetimeInMinutes) `パラメータ。

  結果として得られるユーザーセッションは、15 分（最小）から 10 時間（最大）まで有効です。デフォルトのセッション期間は 10 時間です。
+ 請求されるのは、URL が使用された場合か、Amazon とのやり取りがあった場合のみです。 QuickSight。

詳細については、次を参照してください。[埋め込み分析](https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html)の*アマゾン QuickSight ユーザーガイド*。

埋め込みのハイレベルな手順と、埋め込みをカスタマイズする方法のインタラクティブなデモについては、[アマゾン QuickSight 開発者ポータル](https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html)。

## リクエストの構文
<a name="API_GenerateEmbedUrlForRegisteredUser_RequestSyntax"></a>

```
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 リクエストパラメータ
<a name="API_GenerateEmbedUrlForRegisteredUser_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [AwsAccountId](#API_GenerateEmbedUrlForRegisteredUser_RequestSyntax) **   <a name="QS-GenerateEmbedUrlForRegisteredUser-request-AwsAccountId"></a>
の IDAWS アカウント埋め込んでいるダッシュボードが含まれています。  
長さの制約: 固定長は 12 です。  
パターン: `^[0-9]{12}$`   
必須: はい

## リクエストボディ
<a name="API_GenerateEmbedUrlForRegisteredUser_RequestBody"></a>

リクエストは以下の JSON 形式のデータを受け入れます。

 ** [ExperienceConfiguration](#API_GenerateEmbedUrlForRegisteredUser_RequestSyntax) **   <a name="QS-GenerateEmbedUrlForRegisteredUser-request-ExperienceConfiguration"></a>
埋め込んでいるエクスペリエンス。登録ユーザーには、Amazonを埋め込むことができます QuickSight ダッシュボードまたは Amazon 全体 QuickSight console.  
型: [RegisteredUserEmbeddingExperienceConfiguration](API_RegisteredUserEmbeddingExperienceConfiguration.md) オブジェクト  
必須: はい

 ** [UserArn](#API_GenerateEmbedUrlForRegisteredUser_RequestSyntax) **   <a name="QS-GenerateEmbedUrlForRegisteredUser-request-UserArn"></a>
登録ユーザーの Amazon リソース名。  
Type: 文字列  
必須: はい

 ** [AllowedDomains](#API_GenerateEmbedUrlForRegisteredUser_RequestSyntax) **   <a name="QS-GenerateEmbedUrlForRegisteredUser-request-AllowedDomains"></a>
生成された URL にアクセスするための許可リストに追加するドメイン。このドメインは埋め込まれます。このオプションのパラメータは、Manage で設定されている静的ドメインを上書きします。 QuickSight Amazonのメニュー QuickSight console. 代わりに、このパラメーターに含めるドメインのみが許可されます。各 API 呼び出しで最大 3 つのドメインまたはサブドメインを一覧表示できます。  
特定のドメインのすべてのサブドメインを許可リストに含めるには、`*`。例:`https://*.sapp.amazon.com`以下のすべてのサブドメインを含む`https://sapp.amazon.com`。  
Type: 文字列の配列  
必須: いいえ

 ** [SessionLifetimeInMinutes](#API_GenerateEmbedUrlForRegisteredUser_RequestSyntax) **   <a name="QS-GenerateEmbedUrlForRegisteredUser-request-SessionLifetimeInMinutes"></a>
セッションが有効な時間 (分) セッションの有効期間は [15 〜 600] 分です。  
Type: Long  
有効範囲: 最小値は 15 です。最大値は 600 です。  
必須: いいえ

## レスポンスの構文
<a name="API_GenerateEmbedUrlForRegisteredUser_ResponseSyntax"></a>

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

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

## レスポンス要素
<a name="API_GenerateEmbedUrlForRegisteredUser_ResponseElements"></a>

アクションが成功すると、以下の HTTP レスポンスが返されます。

 ** [Status](#API_GenerateEmbedUrlForRegisteredUser_ResponseSyntax) **   <a name="QS-GenerateEmbedUrlForRegisteredUser-response-Status"></a>
リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

 ** [EmbedUrl](#API_GenerateEmbedUrlForRegisteredUser_ResponseSyntax) **   <a name="QS-GenerateEmbedUrlForRegisteredUser-response-EmbedUrl"></a>
Amazonの埋め込みURL QuickSight ダッシュボードまたはコンソール。  
Type: 文字列

 ** [RequestId](#API_GenerateEmbedUrlForRegisteredUser_ResponseSyntax) **   <a name="QS-GenerateEmbedUrlForRegisteredUser-response-RequestId"></a>
-AWSこの処理のリクエスト ID。  
Type: 文字列

## エラー
<a name="API_GenerateEmbedUrlForRegisteredUser_Errors"></a>

すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。

 ** AccessDeniedException **   
このアイテムにはアクセスできません。提供された認証情報を検証できませんでした。リクエストを実行する権限がない可能性があります。アカウントがAmazonの使用を許可されていることを確認してください QuickSight サービス、ポリシーに正しいアクセス許可があること、正しいアクセスキーを使っていること。  
HTTP ステータスコード: 401

 ** InternalFailureException **   
内部エラーが発生しました。  
HTTP ステータスコード: 500

 ** InvalidParameterValueException **   
1 つ以上のパラメータに無効な値があります。  
HTTP ステータスコード: 400

 ** QuickSightUserNotFoundException **   
指定された名前のユーザーが見つかりません。このエラーは、次のような提供されたユーザー名に基づいてユーザーを見つける必要があるオペレーションで発生する可能性があります。`DeleteUser`,`DescribeUser`、などといった具合です。  
HTTP ステータスコード: 404

 ** ResourceNotFoundException **   
1 つ以上のリソースが見つかりません。  
HTTP ステータスコード: 404

 ** SessionLifetimeInMinutesInvalidException **   
セッションの存続期間に指定された分数が有効ではありません。セッションの有効期間は 15 〜 600 分です。  
HTTP ステータスコード: 400

 ** ThrottlingException **   
アクセスが調整済みです。  
HTTP ステータスコード: 429

 ** UnsupportedPricingPlanException **   
このエラーは、Amazon で埋め込みオペレーションを呼び出していることを示します。 QuickSight必要な料金プランがAWSアカウント. 匿名ユーザーに埋め込みを使用する前に、 QuickSight 管理者が Amazon に容量価格を追加する必要がある QuickSight。この操作は、**Amazon の管理 QuickSight**ページで.  
容量価格を追加した後は、` [GetDashboardEmbedUrl](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GetDashboardEmbedUrl.html) `での API オペレーション`--identity-type ANONYMOUS`オプション。  
HTTP ステータスコード: 403

 ** UnsupportedUserEditionException **   
このエラーは、Amazon でオペレーションを呼び出していることを示します QuickSightエディションにその操作のサポートが含まれていないサブスクリプション。アマゾンアマゾン QuickSight 現在、Standard Edition と Enterprise E すべてのオペレーションと機能がすべてのエディションで利用できるわけではありません。​  
HTTP ステータスコード: 403

## 以下の資料も参照してください。
<a name="API_GenerateEmbedUrlForRegisteredUser_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUser) 
+  [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUser) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUser) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUser) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUser) 
+  [AWS向け SDK JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUser) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUser) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUser) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUser) 