GetSessionEmbedUrl - Amazon QuickSight
リクエストの構文URI リクエストパラメータリクエスト本文レスポンスの構文レスポンス要素エラー以下の資料も参照してください。

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

GetSessionEmbedUrl

Amazon Amazonを埋め込むために使用できるセッションURLと認証コードを生成します QuickSight ウェブサーバーコードでコンソール。を使用するGetSessionEmbedUrlユーザーがデータソース、データセット、分析、およびダッシュボードを作成できる作成ポータルを提供する場所。埋め込まれた Amazon にアクセスするユーザー QuickSight コンソールは、作成者または管理者セキュリティコホートに属している必要があります。これらの機能の一部へのアクセスを制限する場合は、カスタムアクセス許可プロファイルを追加します。 UpdateUser API オペレーション。を使用する RegisterUser カスタムアクセス許可プロファイルをアタッチした新規ユーザーを追加する API オペレーション。詳細については、次のセクションを参照してください。アマゾン QuickSight ユーザーガイド:

リクエストの構文

GET /accounts/AwsAccountId/session-embed-url?entry-point=EntryPoint&session-lifetime=SessionLifetimeInMinutes&user-arn=UserArn HTTP/1.1

URI リクエストパラメータ

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

AwsAccountId

の IDAWS アカウントAmazon に関連付けられている QuickSight サブスクリプション。

長さの制約: 固定長は 12 です。

パターン: ^[0-9]{12}$

必須: はい

EntryPoint

埋め込みセッションにアクセスするために使用する URL。エントリポイント URL は、次のパスに制限されます。

  • /start

  • /start/analyses

  • /start/dashboards

  • /start/favorites

  • /dashboards/DashboardId -ここで、としますDashboardIdは Amazon からの実際の ID キーです QuickSight ダッシュボードのコンソール URL

  • /analyses/AnalysisId -ここで、としますAnalysisIdは Amazon からの実際の ID キーです QuickSight 分析のコンソール URL

長さの制約: 最小長は 1 です｡ 最大長は 1,000 です。

SessionLifetimeInMinutes

セッションが有効な時間 (分) セッションの有効期間は 15 〜 600 分です。

有効範囲: 最小値は 15 です。最大値は 600 です。

UserArn

ザ・アマゾン QuickSight ユーザーの Amazon リソースネーム (ARN)QUICKSIGHTID のタイプ。これはどのタイプのAmazonにも使用できます QuickSight アカウントのユーザー (読者、著者、管理者)。これらの認証は、次のいずれかとして認証されている必要があります。

  1. Active Directory (AD) ユーザーまたはグループメンバー

  2. 招待された非フェデレーションユーザー

  3. AWS Identity and Access ManagementSAML、OpenID Connect、または IAM フェデレーションを使用したフェデレーションを使用したフェデレーションを使用したフェデレーションを通じて認証された (IAM) ユーザーおよび IAM ロールベースセッション

3 番目のグループのユーザー、IAM ユーザー、および IAM ロールベースのセッションでは、このパラメーターを省略します。

リクエスト本文

リクエストにリクエスト本文がありません。

レスポンスの構文

HTTP/1.1 Status
Content-type: application/json

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

レスポンス要素

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

Status

リクエストの HTTP ステータス。

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

EmbedUrl

Amazonを埋め込むためにサーバーサイドのウェブページに入れることができる使い捨てのURL QuickSight セッション。この URL は 5 分間有効です。API オペレーションは、URL にauth_code10 時間有効なユーザーセッションへの 1 回 (および 1 回だけ) のサインオンを可能にする値。

Type: 文字列

RequestId

-AWSこの処理のリクエスト ID。

Type: 文字列

エラー

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

AccessDeniedException

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

HTTP ステータスコード: 401

InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500

InvalidParameterValueException

1 つ以上のパラメータに無効な値があります。

HTTP ステータスコード: 400

QuickSightUserNotFoundException

指定された名前のユーザーが見つかりません。このエラーは、提供されたユーザー名に基づいてユーザーを見つける必要があるオペレーションで発生する可能性があります。DeleteUser,DescribeUserなど。

HTTP ステータスコード: 404

ResourceExistsException

指定されたリソースは既に存在します。

HTTP ステータスコード: 409

ResourceNotFoundException

1 つ以上のリソースが見つかりません。

HTTP ステータスコード: 404

SessionLifetimeInMinutesInvalidException

セッションの存続期間に指定された分数が無効です。セッションの有効期間は 15 〜 600 分です。

HTTP ステータスコード: 400

ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429

UnsupportedUserEditionException

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

HTTP ステータスコード: 403

以下の資料も参照してください。

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。