Amazon Quick Sight APIs を使用した埋め込み - Amazon Quick Suite

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

Amazon Quick Sight APIs を使用した埋め込み

 適用対象: Enterprise Edition 
   対象者: Amazon Quick Suite 開発者 

Amazon Quick Sight APIs を使用して分析を埋め込む実際のプロセスには、いくつかのステップしかありません。

作業を開始する前に、以下の準備が整っていることを確認します。

  • AWS SDK を使用して API コールを行うアプリケーションで使用される発信者 ID に必要な IAM アクセス許可を設定します。たとえば、quicksight:GenerateEmbedUrlForAnonymousUser または quicksight:GenerateEmbedUrlForRegisteredUser アクションを許可するアクセス許可を付与します。

  • 登録済みユーザーに を埋め込むには、Amazon Quick Sight アセットを事前に共有します。新規認証ユーザーの場合、アセットへのアクセスを許可する方法を理解する必要があります。これを行う 1 つの方法は、すべてのアセットを Amazon Quick Sight フォルダに追加することです。Amazon Quick Sight API を使用する場合は、 DescribeDashboardPermissionsおよび UpdateDashboardPermissions API オペレーションを使用します。詳細については、Amazon Quick Suite API リファレンスのDescribeDashboardPermissions」またはUpdateDashboardPermissions」を参照してください。名前空間またはグループ内のすべてのユーザーとダッシュボードを共有する場合は、ダッシュボードを namespace または group で共有できます。

  • ダッシュボードを埋め込む場合は、埋め込むダッシュボードの ID を持っていることを確認してください。ダッシュボード ID は、ダッシュボードの URL 内にあるコードです。ダッシュボードの URL から取得することもできます。

  • Amazon Quick Sight 管理者は、Amazon Quick Sight 分析を埋め込む予定のドメインを明示的に有効にする必要があります。これを行うには、プロファイルメニューから Amazon Quick Sight、ドメイン、埋め込みを管理するか、 GenerateEmbedUrlForAnonymousUser または GenerateEmbedUrlForRegisteredUser API コールの AllowedDomainsパラメータを使用します。

    このオプションは、Amazon Quick Sight 管理者にのみ表示されます。サブドメインをドメインの一部として追加することもできます。詳しくは、「Amazon Quick Suite API を使用して実行時にドメインの一覧表示を許可する」を参照してください。

    許可リスト内のすべての静的ドメイン (開発、ステージング、本稼働など) は明示的に許可され、HTTPS を使用している必要があります。許可リストには最大 100 個のドメインを追加できます。Amazon Quick Sight API オペレーションを使用して、実行時にドメインを追加できます。

すべての前提条件が完了したら、Amazon Quick Sight を埋め込むには次のステップが必要です。詳細については、後で説明します。

  1. 認証では、アプリケーションサーバーを使用してユーザーを認証します。サーバーでの認証後、必要な AWS SDK を使用して埋め込みダッシュボード URL を生成します。

  2. ウェブポータルまたはアプリケーションに、生成された URL を使用して Amazon Quick Sight を埋め込みます。このプロセスを簡素化するために、NPMJS および GitHub で利用可能な Amazon Quick Sight Embedding SDK を使用できます。このカスタマイズされた JavaScript SDK は、Amazon Quick Sight をアプリケーションページに効率的に統合し、デフォルトを設定し、コントロールを接続し、コールバックを取得し、エラーを処理するのに役立つように設計されています。

AWS CloudTrail 監査ログを使用して、埋め込みダッシュボードの数、埋め込みエクスペリエンスのユーザー、アクセス率に関する情報を取得できます。

トピック