Actions, resources, and condition keys for Amazon Q Business
Amazon Q Business (service prefix: qbusiness) provides the following
service-specific operations, resources, actions, and condition 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.
-
View the programmatic service authorization reference
for this service.
Topics
API operations defined by Amazon Q Business
The following table maps API operations to the IAM actions they authorize. Only condition keys that have static values for the given API and action are listed; for the full set of condition keys supported by each action, see the Actions table.
| Operation | IAM action | Condition key | Possible value(s) | Access level |
|---|---|---|---|---|
|
AssociatePermission |
Write |
|||
Write |
||||
|
BatchDeleteDocument |
Write |
|||
|
BatchPutDocument |
Write |
|||
iam:PassedToService |
qbusiness.amazonaws.com |
Write |
||
|
CancelSubscription |
Write |
|||
|
Chat |
Read |
|||
|
ChatSync |
Read |
|||
|
CheckDocumentAccess |
Read |
|||
|
CreateAnonymousWebExperienceUrl |
Write |
|||
|
CreateApplication |
Write |
|||
Tagging, Write |
||||
iam:PassedToService |
qbusiness.amazonaws.com |
Write |
||
|
CreateChatResponseConfiguration |
Write |
|||
Tagging, Write |
||||
|
CreateDataAccessor |
Write |
|||
Write |
||||
Tagging, Write |
||||
|
CreateDataSource |
Write |
|||
Write |
||||
Tagging, Write |
||||
iam:PassedToService |
qbusiness.amazonaws.com |
Write |
||
|
CreateIndex |
Write |
|||
Tagging, Write |
||||
|
CreatePlugin |
Write |
|||
Tagging, Write |
||||
iam:PassedToService |
qbusiness.amazonaws.com |
Write |
||
|
CreateRetriever |
Write |
|||
Tagging, Write |
||||
iam:PassedToService |
qbusiness.amazonaws.com |
Write |
||
|
CreateSubscription |
Write |
|||
|
CreateUser |
Write |
|||
|
CreateWebExperience |
Write |
|||
Tagging, Write |
||||
iam:PassedToService |
qbusiness.amazonaws.com |
Write |
||
|
DeleteApplication |
Write |
|||
|
DeleteAttachment |
Write |
|||
|
DeleteChatControlsConfiguration |
Write |
|||
|
DeleteChatResponseConfiguration |
Write |
|||
|
DeleteConversation |
Write |
|||
|
DeleteDataAccessor |
Write |
|||
|
DeleteDataSource |
Write |
|||
|
DeleteGroup |
Write |
|||
|
DeleteIndex |
Write |
|||
|
DeletePlugin |
Write |
|||
|
DeleteRetriever |
Write |
|||
|
DeleteUser |
Write |
|||
|
DeleteWebExperience |
Write |
|||
|
DisassociatePermission |
Write |
|||
Write |
||||
|
GetApplication |
Read |
|||
|
GetChatControlsConfiguration |
List |
|||
|
GetChatResponseConfiguration |
Read |
|||
|
GetDataAccessor |
Read |
|||
|
GetDataSource |
Read |
|||
|
GetDocumentContent |
Read |
|||
|
GetGroup |
Read |
|||
|
GetIndex |
Read |
|||
|
GetMedia |
Read |
|||
|
GetPlugin |
Read |
|||
|
GetPolicy |
Read |
|||
|
GetRetriever |
Read |
|||
|
GetUser |
Read |
|||
|
GetWebExperience |
Read |
|||
|
ListApplications |
List |
|||
|
ListAttachments |
List |
|||
|
ListChatResponseConfigurations |
List |
|||
|
ListConversations |
List |
|||
|
ListDataAccessors |
List |
|||
|
ListDataSourceSyncJobs |
List |
|||
|
ListDataSources |
List |
|||
|
ListDocuments |
List |
|||
|
ListGroups |
List |
|||
|
ListIndices |
List |
|||
|
ListMessages |
List |
|||
|
ListPluginActions |
Read |
|||
|
ListPluginTypeActions |
Read |
|||
|
ListPluginTypeMetadata |
Read |
|||
|
ListPlugins |
List |
|||
|
ListRetrievers |
List |
|||
|
ListSubscriptions |
List |
|||
|
ListTagsForResource |
Read |
|||
|
ListWebExperiences |
List |
|||
|
PutFeedback |
Write |
|||
|
PutGroup |
Write |
|||
iam:PassedToService |
qbusiness.amazonaws.com |
Write |
||
|
SearchRelevantContent |
Read |
|||
|
StartDataSourceSyncJob |
Write |
|||
|
StopDataSourceSyncJob |
Write |
|||
|
TagResource |
Tagging, Write |
|||
|
UntagResource |
Tagging, Write |
|||
|
UpdateApplication |
Write |
|||
iam:PassedToService |
qbusiness.amazonaws.com |
Write |
||
|
UpdateChatControlsConfiguration |
Write |
|||
|
UpdateChatResponseConfiguration |
Write |
|||
|
UpdateDataAccessor |
Write |
|||
|
UpdateDataSource |
Write |
|||
iam:PassedToService |
qbusiness.amazonaws.com |
Write |
||
|
UpdateIndex |
Write |
|||
|
UpdatePlugin |
Write |
|||
iam:PassedToService |
qbusiness.amazonaws.com |
Write |
||
|
UpdateRetriever |
Write |
|||
iam:PassedToService |
qbusiness.amazonaws.com |
Write |
||
|
UpdateSubscription |
Write |
|||
|
UpdateUser |
Write |
|||
|
UpdateWebExperience |
Write |
|||
iam:PassedToService |
qbusiness.amazonaws.com |
Write |
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.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
Grants permission to associate resource based policy statement to the application |
Write |
|||
Grants permission to batch delete document |
Write |
|||
Grants permission to batch put document |
Write |
|||
Grants permission to cancel a subscription |
Write |
|||
Grants permission to chat using an application |
Read |
|||
Grants permission to chat synchronously using an application |
Read |
|||
Grants permission to check if a user has access to a document |
Read |
|||
Grants permission to create a unique URL for anonymous Amazon Q Business web experience |
Write |
|||
Grants permission to create an application |
Write |
|||
Grants permission to create a chat response configuration to the application |
Write |
|||
Grants permission to create DataAccessor to the application |
Write |
|||
Grants permission to create a data source for a given application and index |
Write |
|||
Grants permission to create an index for a given application |
Write |
|||
Grants permission to create a new integration for a Q Business application |
Write |
|||
Grants permission to create a plugin for a given application |
Write |
|||
Grants permission to create a retriever for a given application |
Write |
|||
Grants permission to create a subscription |
Write |
|||
Grants permission to create a user |
Write |
|||
Grants permission to create a web experience for a given application |
Write |
|||
Grants permission to delete an application |
Write |
|||
Grants permission to delete an attachment in the current chat context |
Write |
|||
Grants permission to delete chat controls configuration for an application |
Write |
|||
Grants permission to delete a chat response configuration |
Write |
|||
Grants permission to delete a conversation |
Write |
|||
Grants permission to delete DataAccessor |
Write |
|||
Grants permission to delete a DataSource |
Write |
|||
Grants permission to delete a group |
Write |
|||
Grants permission to delete an index |
Write |
|||
Grants permission to delete an integration for a Q Business application |
Write |
|||
Grants permission to delete a plugin |
Write |
|||
Grants permission to delete a retriever |
Write |
|||
Grants permission to delete a user |
Write |
|||
Grants permission to delete a web-experience |
Write |
|||
Grants permission to disassociate resource based policy statement to the application |
Write |
|||
Grants permission to get an application |
Read |
|||
Grants permission to get chat controls configuration for an application |
List |
|||
Grants permission to get a chat response configuration |
Read |
|||
Grants permission to get DataAccessor |
Read |
|||
Grants permission to get a data source |
Read |
|||
Grants permission to get a document content |
Read |
|||
Grants permission to get a group |
Read |
|||
Grants permission to get an index |
Read |
|||
Grants permission to get an integration for a Q Business application |
Read |
|||
Grants permission to get the media associated to a system message |
Read |
|||
Grants permission to get a plugin |
Read |
|||
Grants permission to get resource based policy of the application |
Read |
|||
Grants permission to get a retriever |
Read |
|||
Grants permission to get a user |
Read |
|||
Grants permission to get a web-experience |
Read |
|||
Grants permission to list the applications |
List |
|||
Grants permission to list attachments in the current chat context |
List |
|||
Grants permission to list chat response configurations for an application |
List |
|||
Grants permission to list all conversations for an application |
List |
|||
Grants permission to list DataAccessors for the application |
List |
|||
Grants permission to get Data Source sync job history |
List |
|||
Grants permission to list the data sources of an application and an index |
List |
|||
Grants permission to list all documents |
List |
|||
Grants permission to list groups |
List |
|||
Grants permission to list the indices of an application |
List |
|||
Grants permission to list all integrations for a Q Business application |
List |
|||
Grants permission to list all messages |
List |
|||
Grants permission to list the plugins actions of a plugin within application |
Read |
|||
Grants permission to list all the actions for a plugin type |
Read |
|||
Grants permission to list all the plugin type metadata |
Read |
|||
Grants permission to list the plugins of an application |
List |
|||
Grants permission to list the retrievers of an application |
List |
|||
Grants permission to list subscriptions |
List |
|||
Grants permission to list tags for a resource |
Read |
|||
Grants permission to list the web experiences of an application |
List |
|||
Grants permission to put feedback about a conversation message |
Write |
|||
Grants permission to put a group of users |
Write |
|||
Grants permission to search relevant content from the Amazon Q Business Application |
Read |
|||
Grants permission to start Data Source sync job |
Write |
|||
Grants permission to start deployment for an integration |
Write |
|||
Grants permission to stop Data Source sync job |
Write |
|||
Grants permission to tag a resource with given key value pairs |
Tagging, Write |
|||
Grants permission to remove the tag with the given key from a resource |
Tagging, Write |
|||
Grants permission to update an Application |
Write |
|||
Grants permission to update chat controls configuration for an application |
Write |
|||
Grants permission to update a chat response configuration |
Write |
|||
Grants permission to update DataAccessor |
Write |
|||
Grants permission to update a DataSource |
Write |
|||
Grants permission to update an index |
Write |
|||
Grants permission to update an integration for a Q Business application |
Write |
|||
Grants permission to update a plugin |
Write |
|||
Grants permission to update a Retriever |
Write |
|||
Grants permission to update a subscription |
Write |
|||
Grants permission to update a user |
Write |
|||
Grants permission to update a WebExperience |
Write |
|||
Permission-only actions for Amazon Q Business
The following actions are defined by Amazon Q Business but are not directly invocable through any API operation. They can only be used in IAM policy statements to grant or deny permissions.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
Grants permission to configure vended log delivery for Amazon Q Business application resource |
Permissions management, Write |
|||
Grants permission to create AWS IAM Identity center Trusted Token Issuer based DataAccessor to the application |
Write |
|||
Grants permission to disable the ACL crawl while creating the Amazon Q Business data source resource |
Write |
|||
Grants permission to put resource based policy statement to the application |
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.
| Resource types | ARN | Condition keys |
|---|---|---|
arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId} |
||
arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/chat-response-configuration/${ChatResponseConfigurationId} |
||
arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/data-accessor/${DataAccessorId} |
||
arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/index/${IndexId}/data-source/${DataSourceId} |
||
arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/index/${IndexId} |
||
arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/integration/${IntegrationId} |
||
arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/plugin/${PluginId} |
||
arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/retriever/${RetrieverId} |
||
arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/subscription/${SubscriptionId} |
||
arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/web-experience/${WebExperienceId} |
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.
| Condition keys | Description | Type |
|---|---|---|
Filters access by the tags that are passed in the request |
String |
|
Filters access by the tags associated with the resource |
String |
|
Filters access by the tag keys that are passed in the request |
ArrayOfString |
|
Filters access by IAM Identity Center Group ID |
ArrayOfString |
|
Filters access by IAM Identity Center User ID |
ArrayOfString |