Amazon Q Business のアクション、リソース、および条件キー

Amazon Q Business (サービスプレフィックス: qbusiness) では、IAM アクセス許可ポリシーで使用できるように、以下のサービス固有のリソース、アクション、および条件コンテキストキーが用意されています。

リファレンス:

このサービスを設定する方法について説明します。
このサービスで使用可能な API オペレーションのリストを表示します。
IAM アクセス許可ポリシーを使用して、このサービスとそのリソースを保護する方法を学びます。

トピック

Amazon Q Business で定義されるアクション
Amazon Q Business で定義されるリソースタイプ
Amazon Q Business の条件キー

Amazon Q Business で定義されるアクション

IAM ポリシーステートメントの Action エレメントでは、以下のアクションを指定できます。ポリシーを使用して、AWS でオペレーションを実行するアクセス許可を付与します。ポリシーでアクションを使用する場合は、通常、同じ名前の API オペレーションまたは CLI コマンドへのアクセスを許可または拒否します。ただし、場合によっては、1 つのアクションによって複数のオペレーションへのアクセスが制御されます。あるいは、いくつかのオペレーションはいくつかの異なるアクションを必要とします。

[アクション] テーブルの [リソースタイプ] 列は、各アクションがリソースレベルの許可をサポートしているかどうかを示します。この列に値がない場合は、ポリシーステートメントの Resource 要素で、ポリシーが適用されるすべてのリソース (「*」) を指定する必要があります。列にリソースタイプが含まれる場合、そのアクションを含むステートメントでそのタイプの ARN を指定できます。アクションで 1 つ以上のリソースが必須となっている場合、呼び出し元には、それらのリソースを伴うアクションを使用するための許可が付与されている必要があります。必須リソースは、アスタリスク (*) でテーブルに示されています。IAM ポリシーの Resource 要素でリソースアクセスを制限する場合は、必要なリソースタイプごとに ARN またはパターンを含める必要があります。一部のアクションでは、複数のリソースタイプがサポートされています。リソースタイプがオプション (必須として示されていない) の場合、オプションのリソースタイプのいずれかを使用することを選択できます。

[アクション] テーブルの [条件キー] 列には、ポリシーステートメントの Condition 要素で指定できるキーが含まれます。サービスのリソースに関連付けられている条件キーの詳細については、[リソースタイプ] テーブルの [条件キー] 列を参照してください。

注記

リソース条件キーは、リソースタイプテーブルに一覧表示されています。アクションに適用されるリソースタイプへのリンクは、[アクション] テーブルの [リソースタイプ (* 必須)] 列にあります。[リソースタイプ] テーブルのリソースタイプには、[アクション] テーブルのアクションに適用されるリソース条件キーである、[条件キー] 列が含まれています。

以下の表の列の詳細については、「アクションテーブル」を参照してください。

アクション	説明	アクセスレベル	リソースタイプ (* 必須)	条件キー
AddUserLicenses	ライセンスに 1 人以上のユーザーを追加するためのアクセス許可を付与	書き込み
AllowVendedLogDeliveryForResource [アクセス許可のみ]	Amazon Q Business アプリケーションリソースの vended log 配信を設定する許可を付与する	権限の管理	application*
AllowVendedLogDeliveryForResource [アクセス許可のみ]	Amazon Q Business アプリケーションリソースの vended log 配信を設定する許可を付与する	権限の管理		aws:ResourceTag/${TagKey}
BatchDeleteDocument	ドキュメントを一括で削除する許可を付与	書き込み	application*
BatchDeleteDocument	ドキュメントを一括で削除する許可を付与	書き込み	index*
BatchPutDocument	ドキュメントを一括で配置する許可を付与	書き込み	application*
BatchPutDocument	ドキュメントを一括で配置する許可を付与	書き込み	index*
CancelSubscription	サブスクリプションをキャンセルする許可を付与する	書き込み	application*
CancelSubscription	サブスクリプションをキャンセルする許可を付与する	書き込み	subscription*
Chat	アプリケーションを使用してチャットするためのアクセス許可を付与	読み取り	application*
ChatSync	アプリケーションを使用して同期的にチャットするためのアクセス許可を付与	読み取り	application*
CreateApplication	アプリケーションを作成する許可を付与	書き込み		aws:RequestTag/${TagKey} aws:TagKeys
CreateDataSource	特定のアプリケーションとインデックスのデータソースを作成するためのアクセス許可を付与	書き込み	application*
			index*
				aws:RequestTag/${TagKey} aws:TagKeys
CreateIndex	特定のアプリケーションのインデックスを作成するためのアクセス許可を付与	書き込み	application*
CreateIndex	特定のアプリケーションのインデックスを作成するためのアクセス許可を付与	書き込み		aws:RequestTag/${TagKey} aws:TagKeys
CreateLicense	ライセンスを作成するためのアクセス許可を付与	書き込み
CreatePlugin	特定のアプリケーションのプラグインを作成するためのアクセス許可を付与	書き込み	application*
CreatePlugin	特定のアプリケーションのプラグインを作成するためのアクセス許可を付与	書き込み		aws:RequestTag/${TagKey} aws:TagKeys
CreateRetriever	特定のアプリケーションのレトリバーを作成するためのアクセス許可を付与	書き込み	application*
CreateRetriever	特定のアプリケーションのレトリバーを作成するためのアクセス許可を付与	書き込み		aws:RequestTag/${TagKey} aws:TagKeys
CreateSubscription	サブスクリプションを作成する許可を付与する	書き込み	application*
CreateUser	ユーザーを作成する許可を付与	書き込み	application*
CreateWebExperience	特定のアプリケーションのウェブエクスペリエンスを作成するためのアクセス許可を付与	書き込み	application*
CreateWebExperience	特定のアプリケーションのウェブエクスペリエンスを作成するためのアクセス許可を付与	書き込み		aws:RequestTag/${TagKey} aws:TagKeys
DeleteApplication	アプリケーションを削除する許可を付与	書き込み	application*
DeleteChatControlsConfiguration	アプリケーションのチャットコントロール設定を削除するためのアクセス許可を付与	書き込み	application*
DeleteConversation	会話を削除するためのアクセス許可を付与	書き込み	application*
DeleteDataSource	データソースを削除するためのアクセス許可を付与	書き込み	application*
			data-source*
			index*
DeleteGroup	グループを削除するアクセス許可を付与	書き込み	application*
DeleteGroup	グループを削除するアクセス許可を付与	書き込み	index*
DeleteIndex	インデックスを削除するためのアクセス許可を付与	書き込み	application*
DeleteIndex	インデックスを削除するためのアクセス許可を付与	書き込み	index*
DeletePlugin	プラグインを削除するためのアクセス許可を付与	書き込み	application*
DeletePlugin	プラグインを削除するためのアクセス許可を付与	書き込み	plugin*
DeleteRetriever	レトリバーを削除するためのアクセス許可を付与	書き込み	application*
DeleteRetriever	レトリバーを削除するためのアクセス許可を付与	書き込み	retriever*
DeleteUser	ユーザーを削除する許可を付与	書き込み	application*
DeleteWebExperience	ウェブエクスペリエンスを削除するためのアクセス許可を付与	書き込み	application*
DeleteWebExperience	ウェブエクスペリエンスを削除するためのアクセス許可を付与	書き込み	web-experience*
DisableAclOnDataSource [アクセス許可のみ]	Amazon Q Business データソースリソースの作成中に ACL クロールを無効にする許可を付与する	書き込み	application*
GetApplication	アプリケーションを取得する許可を付与	読み取り	application*
GetChatControlsConfiguration	アプリケーションのチャットコントロール設定を取得するためのアクセス許可を付与	リスト	application*
GetDataSource	データソースを取得するためのアクセス許可を付与	読み取り	application*
			data-source*
			index*
GetGroup	グループを取得するためのアクセス許可を付与	読み取り	application*
GetGroup	グループを取得するためのアクセス許可を付与	読み取り	index*
GetIndex	インデックスを取得するためのアクセス許可を付与	読み取り	application*
GetIndex	インデックスを取得するためのアクセス許可を付与	読み取り	index*
GetLicense	ライセンスを取得する許可を付与	読み取り	user-license*
GetPlugin	プラグインを取得するためのアクセス許可を付与	読み取り	application*
GetPlugin	プラグインを取得するためのアクセス許可を付与	読み取り	plugin*
GetRetriever	レトリバーを取得するためのアクセス許可を付与	読み取り	application*
GetRetriever	レトリバーを取得するためのアクセス許可を付与	読み取り	retriever*
GetUser	ユーザーを取得するためのアクセス許可を付与	読み取り	application*
GetWebExperience	ウェブエクスペリエンスを取得するためのアクセス許可を付与	読み取り	application*
GetWebExperience	ウェブエクスペリエンスを取得するためのアクセス許可を付与	読み取り	web-experience*
ListApplications	アプリケーションを一覧表示するためのアクセス許可を付与	リスト
ListConversations	アプリケーションのすべての会話を一覧表示するためのアクセス許可を付与	リスト	application*
ListDataSourceSyncJobs	データソース同期ジョブの履歴を取得する許可を付与	リスト	application*
			data-source*
			index*
ListDataSources	アプリケーションとインデックスのデータソースを一覧表示するためのアクセス許可を付与	リスト	application*
ListDataSources	アプリケーションとインデックスのデータソースを一覧表示するためのアクセス許可を付与	リスト	index*
ListDocuments	すべてのドキュメントを一覧表示するためのアクセス許可を付与	リスト	application*
ListDocuments	すべてのドキュメントを一覧表示するためのアクセス許可を付与	リスト	index*
ListGroups	グループを一覧表示するためのアクセス許可を付与する	リスト	application*
ListGroups	グループを一覧表示するためのアクセス許可を付与する	リスト	index*
ListIndices	アプリケーションのインデックスを一覧表示するためのアクセス許可を付与	リスト	application*
ListMessages	すべてのメッセージを一覧表示するためのアクセス許可を付与	リスト	application*
ListPlugins	アプリケーションのプラグインを一覧表示するためのアクセス許可を付与	リスト	application*
ListRetrievers	アプリケーションのレトリバーを一覧表示するためのアクセス許可を付与	リスト	application*
ListSubscriptions	サブスクリプションを一覧表示する許可を付与	リスト	application*
ListTagsForResource	リソースのタグを一覧表示する許可を付与	読み取り	application
			data-source
			index
			plugin
			retriever
			web-experience
ListUserLicenses	ライセンスを一覧表示する許可を付与	リスト
ListWebExperiences	アプリケーションのウェブエクスペリエンスを一覧表示するためのアクセス許可を付与	リスト	application*
PutFeedback	会話メッセージに関するフィードバックを入力するためのアクセス許可を付与	書き込み	application*
PutGroup	ユーザーのグループを入力するためのアクセス許可を付与	書き込み	application*
PutGroup	ユーザーのグループを入力するためのアクセス許可を付与	書き込み	index*
RemoveUserLicenses	1 人以上のユーザーのライセンスを削除するためのアクセス許可を付与	書き込み
StartDataSourceSyncJob	データソース同期ジョブを開始する許可を付与	書き込み	application*
			data-source*
			index*
StopDataSourceSyncJob	データソース同期ジョブを停止する許可を付与	書き込み	application*
			data-source*
			index*
TagResource	指定されたキーと値のペアでリソースにタグを付けるアクセス許可を付与	タグ付け	application
			data-source
			index
			plugin
			retriever
			web-experience
				aws:RequestTag/${TagKey} aws:TagKeys
UntagResource	所与のキーを持つタグをリソースから削除する許可を付与	タグ付け	application
			data-source
			index
			plugin
			retriever
			web-experience
				aws:TagKeys
UpdateApplication	アプリケーションを更新するためのアクセス許可を付与	書き込み	application*
UpdateChatControlsConfiguration	アプリケーションのチャットコントロール設定を更新するためのアクセス許可を付与	書き込み	application*
UpdateDataSource	データソースを更新するためのアクセス許可を付与	書き込み	application*
			data-source*
			index*
UpdateIndex	インデックスを更新するためのアクセス許可を付与	書き込み	application*
UpdateIndex	インデックスを更新するためのアクセス許可を付与	書き込み	index*
UpdatePlugin	プラグインを更新するためのアクセス許可を付与	書き込み	application*
UpdatePlugin	プラグインを更新するためのアクセス許可を付与	書き込み	plugin*
UpdateRetriever	レトリバーを更新するためのアクセス許可を付与	書き込み	application*
UpdateRetriever	レトリバーを更新するためのアクセス許可を付与	書き込み	retriever*
UpdateSubscription	サブスクリプションを更新する許可を付与する	書き込み	application*
UpdateSubscription	サブスクリプションを更新する許可を付与する	書き込み	subscription*
UpdateUser	ユーザーを更新するためのアクセス許可を付与	書き込み	application*
UpdateWebExperience	ウェブエクスペリエンスを更新するためのアクセス許可を付与	書き込み	application*
UpdateWebExperience	ウェブエクスペリエンスを更新するためのアクセス許可を付与	書き込み	web-experience*

Amazon Q Business で定義されるリソースタイプ

以下のリソースタイプは、このサービスによって定義され、IAM アクセス許可ポリシーステートメントの Resource エレメントで使用できます。アクションテーブルの各アクションは、そのアクションで指定できるリソースタイプを示しています。リソースタイプは、ポリシーに含めることができる条件キーを定義することもできます。これらのキーは、[リソースタイプ] テーブルの最後の列に表示されます。以下の表の列の詳細については、「リソースタイプテーブル」を参照してください。

リソースタイプ	ARN	条件キー
application	`arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}`	aws:ResourceTag/${TagKey}
retriever	`arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/retriever/${RetrieverId}`	aws:ResourceTag/${TagKey}
index	`arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/index/${IndexId}`	aws:ResourceTag/${TagKey}
data-source	`arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/index/${IndexId}/data-source/${DataSourceId}`	aws:ResourceTag/${TagKey}
plugin	`arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/plugin/${PluginId}`	aws:ResourceTag/${TagKey}
web-experience	`arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/web-experience/${WebExperienceId}`	aws:ResourceTag/${TagKey}
user-license	`arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/user-license/${UserLicenseId}`
subscription	`arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/subscription/${SubscriptionId}`

Amazon Q Business の条件キー

Amazon Q Business は、IAM ポリシーの Condition 要素で使用できる以下の条件キーを定義します。これらのキーを使用して、ポリシーステートメントが適用される条件をさらに絞り込むことができます。以下の表の列の詳細については、「条件キーテーブル」を参照してください。

すべてのサービスで使用できるグローバル条件キーを確認するには、「使用できるグローバル条件キー」を参照してください。

条件キー	説明	タイプ
aws:RequestTag/${TagKey}	リクエストで渡されたタグでアクセスをフィルタリングします	文字列
aws:ResourceTag/${TagKey}	リソースに関連付けられたタグでアクセスをフィルタリングします	文字列
aws:TagKeys	リクエストで渡されたタグキーでアクセスをフィルタリングします	ArrayOfString

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

Amazon Q

Amazon Q Business Q アプリ