Amazon Q Business (qbusiness)

Additions

Actions

• AddUserLicenses
  
  • Description:  Grants permission to add one or more users for licenses
  • Access:  Write
• BatchDeleteDocument
  
  • Description:  Grants permission to batch delete document
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

    Name: index

    Required: Yes

• BatchPutDocument
  
  • Description:  Grants permission to batch put document
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

    Name: index

    Required: Yes

• Chat
  
  • Description:  Grants permission to chat using an application
  • Access:  Read
  • Resources: 

    Name: application

    Required: Yes

• ChatSync
  
  • Description:  Grants permission to chat synchronously using an application
  • Access:  Read
  • Resources: 

    Name: application

    Required: Yes

• CreateApplication
  
  • Description:  Grants permission to create an application
  • Access:  Write
  • Conditions: 

    aws:RequestTag/${TagKey}

    aws:TagKeys

• CreateDataSource
  
  • Description:  Grants permission to create a data source for a given application and index
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

    Name: index

    Required: Yes

  • Conditions: 

    aws:RequestTag/${TagKey}

    aws:TagKeys

• CreateIndex
  
  • Description:  Grants permission to create an index for a given application
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

  • Conditions: 

    aws:RequestTag/${TagKey}

    aws:TagKeys

• CreateLicense
  
  • Description:  Grants permission to create a license
  • Access:  Write
• CreatePlugin
  
  • Description:  Grants permission to create a plugin for a given application
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

  • Conditions: 

    aws:RequestTag/${TagKey}

    aws:TagKeys

• CreateRetriever
  
  • Description:  Grants permission to create a retriever for a given application
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

  • Conditions: 

    aws:RequestTag/${TagKey}

    aws:TagKeys

• CreateUser
  
  • Description:  Grants permission to create a user
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

• CreateWebExperience
  
  • Description:  Grants permission to create a web experience for a given application
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

  • Conditions: 

    aws:RequestTag/${TagKey}

    aws:TagKeys

• DeleteApplication
  
  • Description:  Grants permission to delete an application
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

• DeleteChatControlsConfiguration
  
  • Description:  Grants permission to delete chat controls configuration for an application
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

• DeleteConversation
  
  • Description:  Grants permission to delete a conversation
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

• DeleteDataSource
  
  • Description:  Grants permission to delete a DataSource
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

    Name: data-source

    Required: Yes

    Name: index

    Required: Yes

• DeleteGroup
  
  • Description:  Grants permission to delete a group
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

    Name: index

    Required: Yes

• DeleteIndex
  
  • Description:  Grants permission to delete an index
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

    Name: index

    Required: Yes

• DeletePlugin
  
  • Description:  Grants permission to delete a plugin
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

    Name: plugin

    Required: Yes

• DeleteRetriever
  
  • Description:  Grants permission to delete a retriever
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

    Name: retriever

    Required: Yes

• DeleteUser
  
  • Description:  Grants permission to delete a user
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

• DeleteWebExperience
  
  • Description:  Grants permission to delete a web-experience
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

    Name: web-experience

    Required: Yes

• GetApplication
  
  • Description:  Grants permission to get an application
  • Access:  Read
  • Resources: 

    Name: application

    Required: Yes

• GetChatControlsConfiguration
  
  • Description:  Grants permission to get chat controls configuration for an application
  • Access:  List
  • Resources: 

    Name: application

    Required: Yes

• GetDataSource
  
  • Description:  Grants permission to get a data source
  • Access:  Read
  • Resources: 

    Name: application

    Required: Yes

    Name: data-source

    Required: Yes

    Name: index

    Required: Yes

• GetGroup
  
  • Description:  Grants permission to get a group
  • Access:  Read
  • Resources: 

    Name: application

    Required: Yes

    Name: index

    Required: Yes

• GetIndex
  
  • Description:  Grants permission to get an index
  • Access:  Read
  • Resources: 

    Name: application

    Required: Yes

    Name: index

    Required: Yes

• GetLicense
  
  • Description:  Grants permission to get a license
  • Access:  Read
  • Resources: 

    Name: user-license

    Required: Yes

• GetPlugin
  
  • Description:  Grants permission to get a plugin
  • Access:  Read
  • Resources: 

    Name: application

    Required: Yes

    Name: plugin

    Required: Yes

• GetRetriever
  
  • Description:  Grants permission to get a retriever
  • Access:  Read
  • Resources: 

    Name: application

    Required: Yes

    Name: retriever

    Required: Yes

• GetUser
  
  • Description:  Grants permission to get a user
  • Access:  Read
  • Resources: 

    Name: application

    Required: Yes

• GetWebExperience
  
  • Description:  Grants permission to get a web-experience
  • Access:  Read
  • Resources: 

    Name: application

    Required: Yes

    Name: web-experience

    Required: Yes

• ListApplications
  
  • Description:  Grants permission to list the applications
  • Access:  List
• ListConversations
  
  • Description:  Grants permission to list all conversations for an application
  • Access:  List
  • Resources: 

    Name: application

    Required: Yes

• ListDataSourceSyncJobs
  
  • Description:  Grants permission to get Data Source sync job history
  • Access:  List
  • Resources: 

    Name: application

    Required: Yes

    Name: data-source

    Required: Yes

    Name: index

    Required: Yes

• ListDataSources
  
  • Description:  Grants permission to list the data sources of an application and an index
  • Access:  List
  • Resources: 

    Name: application

    Required: Yes

    Name: index

    Required: Yes

• ListDocuments
  
  • Description:  Grants permission to list all documents
  • Access:  List
  • Resources: 

    Name: application

    Required: Yes

    Name: index

    Required: Yes

• ListGroups
  
  • Description:  Grants permission to list groups
  • Access:  List
  • Resources: 

    Name: application

    Required: Yes

    Name: index

    Required: Yes

• ListIndices
  
  • Description:  Grants permission to list the indices of an application
  • Access:  List
  • Resources: 

    Name: application

    Required: Yes

• ListMessages
  
  • Description:  Grants permission to list all messages
  • Access:  List
  • Resources: 

    Name: application

    Required: Yes

• ListPlugins
  
  • Description:  Grants permission to list the plugins of an application
  • Access:  List
  • Resources: 

    Name: application

    Required: Yes

• ListRetrievers
  
  • Description:  Grants permission to list the retrievers of an application
  • Access:  List
  • Resources: 

    Name: application

    Required: Yes

• ListTagsForResource
  
  • Description:  Grants permission to list tags for a resource
  • Access:  Read
  • Resources: 

    Name: application

    Required: No

    Name: data-source

    Required: No

    Name: index

    Required: No

    Name: plugin

    Required: No

    Name: retriever

    Required: No

    Name: web-experience

    Required: No

• ListUserLicenses
  
  • Description:  Grants permission to list licenses
  • Access:  List
• ListWebExperiences
  
  • Description:  Grants permission to list the web experiences of an application
  • Access:  List
  • Resources: 

    Name: application

    Required: Yes

• PutFeedback
  
  • Description:  Grants permission to put feedback about a conversation message
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

• PutGroup
  
  • Description:  Grants permission to put a group of users
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

    Name: index

    Required: Yes

• RemoveUserLicenses
  
  • Description:  Grants permission to remove licenses for one or more users
  • Access:  Write
• StartDataSourceSyncJob
  
  • Description:  Grants permission to start Data Source sync job
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

    Name: data-source

    Required: Yes

    Name: index

    Required: Yes

• StopDataSourceSyncJob
  
  • Description:  Grants permission to stop Data Source sync job
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

    Name: data-source

    Required: Yes

    Name: index

    Required: Yes

• TagResource
  
  • Description:  Grants permission to tag a resource with given key value pairs
  • Access:  Tagging
  • Resources: 

    Name: application

    Required: No

    Name: data-source

    Required: No

    Name: index

    Required: No

    Name: plugin

    Required: No

    Name: retriever

    Required: No

    Name: web-experience

    Required: No

  • Conditions: 

    aws:RequestTag/${TagKey}

    aws:TagKeys

• UntagResource
  
  • Description:  Grants permission to remove the tag with the given key from a resource
  • Access:  Tagging
  • Resources: 

    Name: application

    Required: No

    Name: data-source

    Required: No

    Name: index

    Required: No

    Name: plugin

    Required: No

    Name: retriever

    Required: No

    Name: web-experience

    Required: No

  • Conditions: 

    aws:TagKeys

• UpdateApplication
  
  • Description:  Grants permission to update an Application
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

• UpdateChatControlsConfiguration
  
  • Description:  Grants permission to update chat controls configuration for an application
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

• UpdateDataSource
  
  • Description:  Grants permission to update a DataSource
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

    Name: data-source

    Required: Yes

    Name: index

    Required: Yes

• UpdateIndex
  
  • Description:  Grants permission to update an index
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

    Name: index

    Required: Yes

• UpdatePlugin
  
  • Description:  Grants permission to update a plugin
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

    Name: plugin

    Required: Yes

• UpdateRetriever
  
  • Description:  Grants permission to update a Retriever
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

    Name: retriever

    Required: Yes

• UpdateUser
  
  • Description:  Grants permission to update a user
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

• UpdateWebExperience
  
  • Description:  Grants permission to update a WebExperience
  • Access:  Write
  • Resources: 

    Name: application

    Required: Yes

    Name: web-experience

    Required: Yes

Resources

• application
  
  • Arn:  arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}
  • Conditions: 

    aws:ResourceTag/${TagKey}

• retriever
  
  • Arn:  arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/retriever/${RetrieverId}
  • Conditions: 

    aws:ResourceTag/${TagKey}

• index
  
  • Arn:  arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/index/${IndexId}
  • Conditions: 

    aws:ResourceTag/${TagKey}

• data-source
  
  • Arn:  arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/index/${IndexId}/data-source/${DataSourceId}
  • Conditions: 

    aws:ResourceTag/${TagKey}

• plugin
  
  • Arn:  arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/plugin/${PluginId}
  • Conditions: 

    aws:ResourceTag/${TagKey}

• web-experience
  
  • Arn:  arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/web-experience/${WebExperienceId}
  • Conditions: 

    aws:ResourceTag/${TagKey}

• user-license
  
  • Arn:  arn:${Partition}:qbusiness:${Region}:${Account}:application/${ApplicationId}/user-license/${UserLicenseId}

Conditions

• aws:RequestTag/${TagKey}
  
  • Description:  Filters access by the tags that are passed in the request
  • Type:  String
• aws:ResourceTag/${TagKey}
  
  • Description:  Filters access by the tags associated with the resource
  • Type:  String
• aws:TagKeys
  
  • Description:  Filters access by the tag keys that are passed in the request
  • Type:  ArrayOfString