翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
GenerateEmbedUrlForAnonymousUser
Amazon の埋め込みに使用できる埋め込み URL を生成します QuickSight リーダーユーザーを登録しなくても、Webサイトのダッシュボードにアクセスできます。このアクションを使用する前に、ダッシュボードとアクセス許可があることを確認してください。
生成された URL には、次のルールが適用されます。
-
一時的なベアラートークンが含まれています。生成されてから 5 分間有効です。この期間内に引き出されると、再利用することはできません。
-
URL の有効期間は、を使用してカスタマイズできる実際のセッションの有効期間と混同しないでください。
SessionLifetimeInMinutesパラメータ。結果として得られるユーザーセッションは、15 分（最小）から 10 時間（最大）まで有効です。デフォルトのセッション期間は 10 時間です。 -
請求されるのは、URL が使用された場合か、Amazon とのやり取りがあった場合のみです QuickSight。
詳細については、次を参照してください。埋め込み分析のアマゾン QuickSight ユーザーガイド。
埋め込みのハイレベルな手順と、埋め込みをカスタマイズする方法のインタラクティブなデモについては、アマゾン QuickSight 開発者ポータル。
リクエストの構文
POST /accounts/AwsAccountId/embed-url/anonymous-user HTTP/1.1
Content-type: application/json
{
"AllowedDomains": [ "string" ],
"AuthorizedResourceArns": [ "string" ],
"ExperienceConfiguration": {
"Dashboard": {
"InitialDashboardId": "string"
}
},
"Namespace": "string",
"SessionLifetimeInMinutes": number,
"SessionTags": [
{
"Key": "string",
"Value": "string"
}
]
}URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
- AwsAccountId
-
の IDAWS アカウント埋め込んでいるダッシュボードが含まれています。
長さの制約: 固定長は 12 です。
パターン:
^[0-9]{12}$必須: はい
リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
- AuthorizedResourceArns
-
Amazon 用の Amazon リソースネーム (ARN) QuickSight セッションの存続期間中にユーザーがアクセスを許可されるリソース。選択内容
Dashboardエクスペリエンスを埋め込む場合は、ユーザーに表示させたいアカウントのダッシュボード ARN のリストを渡します。現在、各 API 呼び出しで最大 25 個のダッシュボード ARN を渡すことができます。Type: 文字列の配列
必須: はい
- ExperienceConfiguration
-
埋め込むエクスペリエンスの構成。
型: AnonymousUserEmbeddingExperienceConfiguration オブジェクト
必須: はい
- Namespace
-
ザ・アマゾン QuickSight 匿名ユーザーが仮想的に属する名前空間。Amazonを使用していない場合 QuickSight カスタム名前空間、これを
default。Type: 文字列
長さの制約: 最大長は 64 文字です。
パターン:
^[a-zA-Z0-9._-]*$必須: はい
- AllowedDomains
-
生成された URL にアクセスするための許可リストに追加するドメイン。このドメインは埋め込まれます。このオプションのパラメータは、Manage で設定されている静的ドメインを上書きします。 QuickSight Amazonのメニュー QuickSight console. 代わりに、このパラメーターに含めるドメインのみが許可されます。各 API 呼び出しで最大 3 つのドメインまたはサブドメインを一覧表示できます。
特定のドメインのすべてのサブドメインを許可リストに含めるには、
*。例:https://*.sapp.amazon.com以下のすべてのサブドメインを含むhttps://sapp.amazon.com。Type: 文字列の配列
必須: いいえ
- SessionLifetimeInMinutes
-
セッションが有効な時間 (分)。セッションの有効期間は [15 〜 600] 分です。
Type: Long
有効範囲: 最小値は 15 です。最大値は 600 です。
必須: いいえ
- SessionTags
-
行レベルのセキュリティに使用されるセッションタグ。このパラメータを使用する前に、を使用して、関連するデータセットを設定済みであることを確認します。
DataSet$RowLevelPermissionTagConfigurationパラメータを使用して、セッションタグを使用して行レベルのセキュリティを提供できるようにします。これらはに使用されるタグではありませんAWSリソースへのタグ付け機能。詳細については、次を参照してください。タグによる行レベルのセキュリティ (RLS) の使用のアマゾン QuickSight ユーザーガイド。
Type: 配列SessionTagオブジェクト
配列メンバー: 最小数は 1 項目です。最大数は 50 項目です。
必須: いいえ
レスポンスの構文
HTTP/1.1 Status
Content-type: application/json
{
"EmbedUrl": "string",
"RequestId": "string"
}レスポンス要素
アクションが成功すると、以下の HTTP レスポンスが返されます。
- Status
-
リクエストの HTTP ステータス。
サービスから以下のデータが JSON 形式で返されます。
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- AccessDeniedException
-
このアイテムにはアクセスできません。提供された認証情報を検証できませんでした。リクエストを実行する権限がない可能性があります。あなたのアカウントがAmazonの使用を許可されていることを確認してください QuickSight サービスの利用を許可されていること、ポリシーに正しいアクセス許可があること、正しいアクセスキーを使っていることを確認してください。
HTTP ステータスコード: 401
- InternalFailureException
-
内部エラーが発生しました。
HTTP ステータスコード: 500
- InvalidParameterValueException
-
1 つ以上のパラメータに無効な値があります。
HTTP ステータスコード: 400
- ResourceNotFoundException
-
1 つ以上のリソースが見つかりません。
HTTP ステータスコード: 404
- SessionLifetimeInMinutesInvalidException
-
セッションの存続期間に指定された分数が有効ではありません。セッションの有効期間は 15 〜 600 分です。
HTTP ステータスコード: 400
- ThrottlingException
-
アクセスが調整済みです。
HTTP ステータスコード: 429
- UnsupportedPricingPlanException
-
このエラーは、Amazon で埋め込みオペレーションを呼び出していることを示します QuickSight必要な料金プランがAWSアカウント. 匿名ユーザーに埋め込みを使用する前に、 QuickSight 管理者が Amazon に容量価格を追加する必要がある QuickSight。この操作は、Amazon の管理 QuickSightページで.
容量価格を追加した後は、
GetDashboardEmbedUrlでの API オペレーション--identity-type ANONYMOUSオプション。HTTP ステータスコード: 403
- UnsupportedUserEditionException
-
このエラーは、Amazon でオペレーションをコールしていることを示します。 QuickSightエディションにその操作のサポートが含まれていないサブスクリプション。アマゾンアマゾン QuickSight 現在、Standard Edition と Enterprise E すべてのオペレーションと機能がすべてのエディションで利用できるわけではありません。
HTTP ステータスコード: 403
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
