Actions, resources, and condition keys for Amazon Q Business
Amazon Q Business (service prefix: qbusiness
) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.
References:
-
Learn how to configure this service.
-
View a list of the API operations available for this service.
-
Learn how to secure this service and its resources by using IAM permission policies.
Topics
Actions defined by Amazon Q Business
You can specify the following actions in the Action
element of an IAM policy statement. Use policies to grant permissions to perform an operation in AWS. When you use an action in a policy, you usually allow or deny access to the API operation or CLI command with the same name. However, in some cases, a single action controls access to more than one operation. Alternatively, some operations require several different actions.
The Resource types column of the Actions table indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") to which the policy applies in the Resource
element of your policy statement. If the column includes a resource type, then you can specify an ARN of that type in a statement with that action. If the action has one or more required resources, the caller must have permission to use the action with those resources. Required resources are indicated in the table with an asterisk (*). If you limit resource access with the Resource
element in an IAM policy, you must include an ARN or pattern for each required resource type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one of the optional resource types.
The Condition keys column of the Actions table includes keys that you can specify in a policy statement's Condition
element. For more information on the condition keys that are associated with resources for the service, see the Condition keys column of the Resource types table.
Note
Resource condition keys are listed in the Resource types table. You can find a link to the resource type that applies to an action in the Resource types (*required) column of the Actions table. The resource type in the Resource types table includes the Condition keys column, which are the resource condition keys that apply to an action in the Actions table.
For details about the columns in the following table, see Actions table.
Actions | Description | Access level | Resource types (*required) | Condition keys | Dependent actions |
---|---|---|---|---|---|
AddUserLicenses | Grants permission to add one or more users for licenses | Write | |||
BatchDeleteDocument | Grants permission to batch delete document | Write | |||
BatchPutDocument | Grants permission to batch put document | Write | |||
CancelSubscription | Grants permission to cancel a subscription | Write | |||
Chat | Grants permission to chat using an application | Read | |||
ChatSync | Grants permission to chat synchronously using an application | Read | |||
CreateApplication | Grants permission to create an application | Write | |||
CreateDataSource | Grants permission to create a data source for a given application and index | Write | |||
CreateIndex | Grants permission to create an index for a given application | Write | |||
CreateLicense | Grants permission to create a license | Write | |||
CreatePlugin | Grants permission to create a plugin for a given application | Write | |||
CreateRetriever | Grants permission to create a retriever for a given application | Write | |||
CreateSubscription | Grants permission to create a subscription | Write | |||
CreateUser | Grants permission to create a user | Write | |||
CreateWebExperience | Grants permission to create a web experience for a given application | Write | |||
DeleteApplication | Grants permission to delete an application | Write | |||
DeleteChatControlsConfiguration | Grants permission to delete chat controls configuration for an application | Write | |||
DeleteConversation | Grants permission to delete a conversation | Write | |||
DeleteDataSource | Grants permission to delete a DataSource | Write | |||
DeleteGroup | Grants permission to delete a group | Write | |||
DeleteIndex | Grants permission to delete an index | Write | |||
DeletePlugin | Grants permission to delete a plugin | Write | |||
DeleteRetriever | Grants permission to delete a retriever | Write | |||
DeleteUser | Grants permission to delete a user | Write | |||
DeleteWebExperience | Grants permission to delete a web-experience | Write | |||
DisableAclOnDataSource [permission only] | Grants permission to disable the ACL crawl while creating the Amazon Q Business data source resource | Write | |||
GetApplication | Grants permission to get an application | Read | |||
GetChatControlsConfiguration | Grants permission to get chat controls configuration for an application | List | |||
GetDataSource | Grants permission to get a data source | Read | |||
GetGroup | Grants permission to get a group | Read | |||
GetIndex | Grants permission to get an index | Read | |||
GetLicense | Grants permission to get a license | Read | |||
GetPlugin | Grants permission to get a plugin | Read | |||
GetRetriever | Grants permission to get a retriever | Read | |||
GetUser | Grants permission to get a user | Read | |||
GetWebExperience | Grants permission to get a web-experience | Read | |||
ListApplications | Grants permission to list the applications | List | |||
ListConversations | Grants permission to list all conversations for an application | List | |||
ListDataSourceSyncJobs | Grants permission to get Data Source sync job history | List | |||
ListDataSources | Grants permission to list the data sources of an application and an index | List | |||
ListDocuments | Grants permission to list all documents | List | |||
ListGroups | Grants permission to list groups | List | |||
ListIndices | Grants permission to list the indices of an application | List | |||
ListMessages | Grants permission to list all messages | List | |||
ListPlugins | Grants permission to list the plugins of an application | List | |||
ListRetrievers | Grants permission to list the retrievers of an application | List | |||
ListSubscriptions | Grants permission to list subscriptions | List | |||
ListTagsForResource | Grants permission to list tags for a resource | Read | |||
ListUserLicenses | Grants permission to list licenses | List | |||
ListWebExperiences | Grants permission to list the web experiences of an application | List | |||
PutFeedback | Grants permission to put feedback about a conversation message | Write | |||
PutGroup | Grants permission to put a group of users | Write | |||
RemoveUserLicenses | Grants permission to remove licenses for one or more users | Write | |||
StartDataSourceSyncJob | Grants permission to start Data Source sync job | Write | |||
StopDataSourceSyncJob | Grants permission to stop Data Source sync job | Write | |||
TagResource | Grants permission to tag a resource with given key value pairs | Tagging | |||
UntagResource | Grants permission to remove the tag with the given key from a resource | Tagging | |||
UpdateApplication | Grants permission to update an Application | Write | |||
UpdateChatControlsConfiguration | Grants permission to update chat controls configuration for an application | Write | |||
UpdateDataSource | Grants permission to update a DataSource | Write | |||
UpdateIndex | Grants permission to update an index | Write | |||
UpdatePlugin | Grants permission to update a plugin | Write | |||
UpdateRetriever | Grants permission to update a Retriever | Write | |||
UpdateSubscription | Grants permission to update a subscription | Write | |||
UpdateUser | Grants permission to update a user | Write | |||
UpdateWebExperience | Grants permission to update a WebExperience | Write | |||
Resource types defined by Amazon Q Business
The following resource types are defined by this service and can be used in the Resource
element of IAM permission policy statements. Each action in the Actions table identifies the resource types that can be specified with that action. A resource type can also define which condition keys you can include in a policy. These keys are displayed in the last column of the Resource types table. For details about the columns in the following table, see Resource types table.
Resource types | ARN | Condition keys |
---|---|---|
application |
arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}
|
|
retriever |
arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/retriever/${RetrieverId}
|
|
index |
arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/index/${IndexId}
|
|
data-source |
arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/index/${IndexId}/data-source/${DataSourceId}
|
|
plugin |
arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/plugin/${PluginId}
|
|
web-experience |
arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/web-experience/${WebExperienceId}
|
|
user-license |
arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/user-license/${UserLicenseId}
|
|
subscription |
arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/subscription/${SubscriptionId}
|
Condition keys for Amazon Q Business
Amazon Q Business defines the following condition keys that can be used in the Condition
element of an IAM policy. You can use these keys to further refine the conditions under which the policy statement applies. For details about the columns in the following table, see Condition keys table.
To view the global condition keys that are available to all services, see Available global condition keys.
Condition keys | Description | Type |
---|---|---|
aws:RequestTag/${TagKey} | Filters access by the tags that are passed in the request | String |
aws:ResourceTag/${TagKey} | Filters access by the tags associated with the resource | String |
aws:TagKeys | Filters access by the tag keys that are passed in the request | ArrayOfString |