Actions, resources, and condition keys for Amazon Q Business Q Apps
Amazon Q Business Q Apps (service prefix: qapps) 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 Q Apps
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 |
|---|---|---|---|---|---|
| AssociateLibraryItemReview | Grants permission to associate a library item review in the Q Business application environment | Write | |||
| AssociateQAppWithUser | Grants permission to associate Q App with a user in the Q Business application environment | Write | |||
| BatchCreateCategory | Grants permission to create the categories of a library in the Q Business application environment | Write | |||
| BatchDeleteCategory | Grants permission to delete the categories of a library in the Q Business application environment | Write | |||
| BatchUpdateCategory | Grants permission to update the categories of a library in the Q Business application environment | Write | |||
| CopyQApp [permission only] | Grants permission to copy Q App in the Q Business application environment | Write | |||
| CreateLibraryItem | Grants permission to create a library item in the Q Business application environment | Write | |||
| CreateLibraryItemReview [permission only] | Grants permission to create a library item review in the Q Business application environment | Write | |||
| CreatePresignedUrl | Grants permission to create a presigned URL for uploading a file to a Q App or Q App Session in the Q Business application environment | Write | |||
| CreateQApp | Grants permission to create Q App in the Q Business application environment | Write | |||
| CreateSubscriptionToken [permission only] | Grants permission to subscribe to a Q App event bus topic in the Q Business application environment | Write | |||
| DeleteLibraryItem | Grants permission to delete a library item in the Q Business application environment | Write | |||
| DeleteQApp | Grants permission to delete Q App in the Q Business application environment | Write | |||
| DescribeQAppPermissions | Grants permission to get Q App sharing permissions in the Q Business application environment | Read | |||
| DisassociateLibraryItemReview | Grants permission to disassociate a library item review in the Q Business application environment | Write | |||
| DisassociateQAppFromUser | Grants permission to disassociate Q App with a user in the Q Business application environment | Write | |||
| ExportQAppSessionData | Grants permission to export Q App session data in the Q Business application environment | Write | |||
| GetLibraryItem | Grants permission to get a library item in the Q Business application environment | Read | |||
| GetQApp | Grants permission to get Q App in the Q Business application environment | Read | |||
| GetQAppSession | Grants permission to get Q App session in the Q Business application environment | Read | |||
| GetQAppSessionMetadata | Grants permission to get Q App session metadata in the Q Business application environment | Read | |||
| ImportDocument | Grants permission to import a document to Q App or Q App Session in the Q Business application environment | Write | |||
| ImportDocumentToQApp [permission only] | Grants permission to import a document to Q App in the Q Business application environment | Write | |||
| ImportDocumentToQAppSession [permission only] | Grants permission to import a document to Q App session in the Q Business application environment | Write | |||
| ListCategories | Grants permission to list categories in the Q Business application environment | List | |||
| ListLibraryItems | Grants permission to list library items in the Q Business application environment | List | |||
| ListQAppSessionData | Grants permission to get Q App session data in the Q Business application environment | Read | |||
| ListQApps | Grants permission to list Q Apps in the Q Business application environment | List | |||
| ListTagsForResource | Grants permission to list tags for a resource | Read | |||
| PredictProblemStatementFromConversation [permission only] | Grants permission to predict problem statement from conversation log in the Q Business application environment | Write | |||
| PredictQApp | Grants permission to predict Q App from conversation log or problem statement in the Q Business application environment | Write | |||
| PredictQAppFromProblemStatement [permission only] | Grants permission to predict Q App metadata from problem statement in the Q Business application environment | Write | |||
| StartQAppSession | Grants permission to start Q App session in the Q Business application environment | Write | |||
| StopQAppSession | Grants permission to stop Q App session in the Q Business application environment | 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 | |||
| UpdateLibraryItem | Grants permission to update a library item in the Q Business application environment | Write | |||
| UpdateLibraryItemMetadata | Grants permission to update the metadata of a library item in the Q Business application environment | Write | |||
| UpdateQApp | Grants permission to update Q App in the Q Business application environment | Write | |||
| UpdateQAppPermissions | Grants permission to update Q App sharing permissions in the Q Business application environment | Write | |||
| UpdateQAppSession | Grants permission to update Q App session in the Q Business application environment | Write | |||
| UpdateQAppSessionMetadata | Grants permission to update Q App session metadata in the Q Business application environment | Write |
Resource types defined by Amazon Q Business Q Apps
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}
|
|
| qapp |
arn:${Partition}:qapps:${Region}:${Account}:application/${ApplicationId}/qapp/${AppId}
|
|
| qapp-session |
arn:${Partition}:qapps:${Region}:${Account}:application/${ApplicationId}/qapp/${AppId}/session/${SessionId}
|
Condition keys for Amazon Q Business Q Apps
Amazon Q Business Q Apps 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 |
| qapps:AppIsPublished | Filters access by whether Q App is published | String |
| qapps:SessionIsShared | Filters access by whether Q App Session is shared | String |
| qapps:UserIsAppOwner | Filters access by whether requester is Q App owner | String |
| qapps:UserIsSessionModerator | Filters access by whether requester is Q App Session moderator | String |
