Amazon QuickSight API を使用した埋め込み - Amazon QuickSight

Amazon QuickSight API を使用した埋め込み

 適用先: Enterprise Edition 
   対象者: Amazon QuickSight デベロッパー 

QuickSight API を使用して分析を埋め込むための実際のプロセスに関わるステップは、ごくわずかです。

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

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

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

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

  • QuickSight 管理者は、QuickSight 分析を埋め込む予定のドメインを明示的に有効にする必要があります。これを行うには、プロファイルメニューから [Manage QuickSight] (QuickSight の管理) を選び [Domains and Embedding] (ドメインと埋め込み) を使用するか、または GenerateEmbedUrlForAnonymousUser の AllowedDomains パラメータまたは GenerateEmbedUrlForRegisteredUser API 呼び出しを使用します。

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

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

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

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

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

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

トピック