API による埋め込み QuickSight - Amazon QuickSight

重要:Amazon QuickSight 分析ワークスペースを再設計しました。コンソールの新しい外観を反映していないスクリーンショットや手順のテキストが表示される場合があります。 QuickSight 現在、スクリーンショットと手順のテキストを更新しています。

機能または項目を検索するには、クイック検索バーを使用します。

QuickSightの新しい外観について詳しくは、「Amazon での新しい分析機能の紹介」を参照してください QuickSight。

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

API による埋め込み QuickSight

 適用対象: Enterprise Edition 
   対象ユーザー:Amazon QuickSight 開発者 

QuickSight API を使用してアナリティクスを埋め込む実際のプロセスには、ほんの少しのステップしか必要ありません。

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

  • AWS SDK を使用して API 呼び出しを行うアプリケーションが使用する呼び出し元 ID に必要な IAM 権限を設定します。たとえば、quicksight:GenerateEmbedUrlForAnonymousUser または quicksight:GenerateEmbedUrlForRegisteredUser アクションを許可するアクセス許可を付与します。

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

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

  • QuickSight 管理者は、 QuickSight アナリティクスを埋め込む予定のドメインを明示的に有効にする必要があります。そのためには、プロファイルメニューの [管理] QuickSight、[ドメイン]、[埋め込み] を使用するか、GenerateEmbedUrlForAnonymousUserまたは GenerateEmbedUrlForRegisteredUser API AllowedDomains 呼び出しのパラメータを使用できます。

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

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

前提条件をすべて満たしたら、 QuickSight 埋め込みには以下のステップが必要です。これについては後で詳しく説明します。

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

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

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

トピック