Amazon Q Business Q Apps のアクション、リソース、および条件キー
Amazon Q Business Q Apps (サービスプレフィックス: qapps) では、IAM アクセス許可ポリシーで使用できるように、以下のサービス固有のリソース、アクション、および条件コンテキストキーが用意されています。
リファレンス:
-
このサービスを設定する方法について説明します。
-
このサービスで使用可能な API オペレーションのリストを表示します。
-
IAM アクセス許可ポリシーを使用して、このサービスとそのリソースを保護する方法を学びます。
トピック
Amazon Q Business Q Apps で定義されるアクション
IAM ポリシーステートメントの Action エレメントでは、以下のアクションを指定できます。ポリシーを使用して、AWS でオペレーションを実行するアクセス許可を付与します。ポリシーでアクションを使用する場合は、通常、同じ名前の API オペレーションまたは CLI コマンドへのアクセスを許可または拒否します。ただし、場合によっては、1 つのアクションによって複数のオペレーションへのアクセスが制御されます。あるいは、いくつかのオペレーションはいくつかの異なるアクションを必要とします。
[アクション] テーブルの [リソースタイプ] 列は、各アクションがリソースレベルの許可をサポートしているかどうかを示します。この列に値がない場合は、ポリシーステートメントの Resource 要素で、ポリシーが適用されるすべてのリソース (「*」) を指定する必要があります。列にリソースタイプが含まれる場合、そのアクションを含むステートメントでそのタイプの ARN を指定できます。アクションで 1 つ以上のリソースが必須となっている場合、呼び出し元には、それらのリソースを伴うアクションを使用するための許可が付与されている必要があります。必須リソースは、アスタリスク (*) でテーブルに示されています。IAM ポリシーの Resource 要素でリソースアクセスを制限する場合は、必要なリソースタイプごとに ARN またはパターンを含める必要があります。一部のアクションでは、複数のリソースタイプがサポートされています。リソースタイプがオプション (必須として示されていない) の場合、オプションのリソースタイプのいずれかを使用することを選択できます。
[アクション] テーブルの [条件キー] 列には、ポリシーステートメントの Condition 要素で指定できるキーが含まれます。サービスのリソースに関連付けられている条件キーの詳細については、[リソースタイプ] テーブルの [条件キー] 列を参照してください。
注記
リソース条件キーは、リソースタイプテーブルに一覧表示されています。アクションに適用されるリソースタイプへのリンクは、[アクション] テーブルの [リソースタイプ (* 必須)] 列にあります。[リソースタイプ] テーブルのリソースタイプには、[アクション] テーブルのアクションに適用されるリソース条件キーである、[条件キー] 列が含まれています。
以下の表の列の詳細については、「アクションテーブル」を参照してください。
| アクション | 説明 | アクセスレベル | リソースタイプ (* 必須) | 条件キー | 依存アクション |
|---|---|---|---|---|---|
| AssociateLibraryItemReview | Q Business アプリケーション環境でライブラリ項目レビューを関連付ける許可を付与する | 書き込み | |||
| AssociateQAppWithUser | Q Business アプリケーション環境でユーザーと Q App を関連付ける許可を付与する | 書き込み | |||
| CopyQApp [アクセス許可のみ] | Q Business アプリケーション環境で Q App をコピーする許可を付与する | 書き込み | |||
| CreateLibraryItem | Q Business アプリケーション環境でライブラリ項目を作成する許可を付与する | 書き込み | |||
| CreateLibraryItemReview [アクセス許可のみ] | Q Business アプリケーション環境でライブラリ項目レビューを作成する許可を付与する | 書き込み | |||
| CreateQApp | Q Business アプリケーション環境で Q App を作成する許可を付与する | 書き込み | |||
| CreateSubscriptionToken [アクセス許可のみ] | Q Business アプリケーション環境で Q App イベントバストピックをサブスクライブする許可を付与する | 書き込み | |||
| DeleteLibraryItem | Q Business アプリケーション環境でライブラリ項目を削除する許可を付与する | 書き込み | |||
| DeleteQApp | Q Business アプリケーション環境で Q App を削除する許可を付与する | 書き込み | |||
| DisassociateLibraryItemReview | Q Business アプリケーション環境でライブラリ項目レビューの関連付けを解除する許可を付与する | 書き込み | |||
| DisassociateQAppFromUser | Q Business アプリケーション環境でユーザーと Q App の関連付けを解除する許可を付与する | 書き込み | |||
| ExportQAppSessionData [アクセス許可のみ] | Q Business アプリケーション環境で Q App セッションデータをエクスポートする許可を付与する | 書き込み | |||
| GetLibraryItem | Q Business アプリケーション環境でライブラリ項目を取得する許可を付与する | 読み取り | |||
| GetQApp | Q Business アプリケーション環境で Q App を取得する許可を付与する | 読み取り | |||
| GetQAppSession | Q Business アプリケーション環境で Q App セッションを取得する許可を付与する | 読み取り | |||
| GetQAppSessionMetadata [アクセス許可のみ] | Q Business アプリケーション環境で Q App セッションメタデータを取得する許可を付与する | 読み取り | |||
| ImportDocument | Q Business アプリケーション環境で Q App または Q App セッションにドキュメントをインポートする許可を付与する | 書き込み | |||
| ImportDocumentToQApp [アクセス許可のみ] | Q Business アプリケーション環境の Q App にドキュメントをインポートする許可を付与する | 書き込み | |||
| ImportDocumentToQAppSession [アクセス許可のみ] | Q Business アプリケーション環境の Q App セッションにドキュメントをインポートする許可を付与する | 書き込み | |||
| ListLibraryItems | Q Business アプリケーション環境でライブラリアイテムを一覧表示する許可を付与する | リスト | |||
| ListQAppSessionData [アクセス許可のみ] | Q Business アプリケーション環境で Q App セッションデータを取得する許可を付与する | 読み取り | |||
| ListQApps | Q Business アプリケーション環境で Q App を一覧表示する許可を付与する | リスト | |||
| ListTagsForResource | リソースのタグを一覧表示する許可を付与 | 読み込み | |||
| PredictProblemStatementFromConversation [アクセス許可のみ] | Q Business アプリケーション環境の会話ログから問題ステートメントを予測する許可を付与する | 書き込み | |||
| PredictQApp | Q Business アプリケーション環境の会話ログまたは問題ステートメントから Q App を予測する許可を付与する | 書き込み | |||
| PredictQAppFromProblemStatement [アクセス許可のみ] | Q Business アプリケーション環境の問題ステートメントから Q App メタデータを予測する許可を付与する | 書き込み | |||
| StartQAppSession | Q Business アプリケーション環境で Q App セッションを開始する許可を付与する | 書き込み | |||
| StopQAppSession | Q Business アプリケーション環境で Q App セッションを停止する許可を付与する | 書き込み | |||
| TagResource | 指定されたキーと値のペアでリソースにタグを付けるアクセス許可を付与 | タグ付け | |||
| UntagResource | 所与のキーを持つタグをリソースから削除する許可を付与 | タグ付け | |||
| UpdateLibraryItem | Q Business アプリケーション環境でライブラリ項目を更新する許可を付与する | 書き込み | |||
| UpdateLibraryItemMetadata | Q Business アプリケーション環境のライブラリ項目のメタデータを更新する許可を付与する | 書き込み | |||
| UpdateQApp | Q Business アプリケーション環境で Q App を更新する許可を付与する | 書き込み | |||
| UpdateQAppSession | Q Business アプリケーション環境で Q App セッションを更新する許可を付与する | 書き込み | |||
| UpdateQAppSessionMetadata [アクセス許可のみ] | Q Business アプリケーション環境で Q App セッションメタデータを更新する許可を付与する | 書き込み |
Amazon Q Business Q Apps で定義されるリソースタイプ
以下のリソースタイプは、このサービスによって定義され、IAM アクセス許可ポリシーステートメントの Resource エレメントで使用できます。アクションテーブルの各アクションは、そのアクションで指定できるリソースタイプを示しています。リソースタイプは、ポリシーに含めることができる条件キーを定義することもできます。これらのキーは、[リソースタイプ] テーブルの最後の列に表示されます。以下の表の列の詳細については、「リソースタイプテーブル」を参照してください。
| リソースタイプ | ARN | 条件キー |
|---|---|---|
| application |
arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}
|
|
| qapp |
arn:${Partition}:qapps:${Region}:${Account}:application/${ApplicationId}/qapp/${AppId}
|
|
| qapp-session |
arn:${Partition}:qapps:${Region}:${Account}:application/${ApplicationId}/qapp/${AppId}/session/${SessionId}
|
Amazon Q Business Q Apps の条件キー
Amazon Q Business Q Apps は、IAM ポリシーの Condition 要素で使用できる以下の条件キーを定義します。これらのキーを使用して、ポリシーステートメントが適用される条件をさらに絞り込むことができます。以下の表の列の詳細については、「条件キーテーブル」を参照してください。
すべてのサービスで使用できるグローバル条件キーを確認するには、「使用できるグローバル条件キー」を参照してください。
| 条件キー | 説明 | タイプ |
|---|---|---|
| aws:RequestTag/${TagKey} | リクエストで渡されたタグでアクセスをフィルタリングします | 文字列 |
| aws:ResourceTag/${TagKey} | リソースに関連付けられたタグでアクセスをフィルタリングします | 文字列 |
| aws:TagKeys | リクエストで渡されたタグキーでアクセスをフィルタリングします | ArrayOfString |
| qapps:AppIsPublished | Q App が公開されているかどうかによってアクセスをフィルタリングする | 文字列 |
| qapps:SessionIsShared | Q App セッションが共有されているかどうかによってアクセスをフィルタリングする | 文字列 |
| qapps:UserIsAppOwner | リクエスタが Q App 所有者であるかどうかによってアクセスをフィルタリングする | 文字列 |
| qapps:UserIsSessionModerator | リクエスタが Q App セッションモデレーターであるかどうかによってアクセスをフィルタリングする | 文字列 |
