View a markdown version of this page

GitHub (Server) connector overview - Amazon Q Business

Amazon Q Business will no longer be open to new customers starting on July 31, 2026. If you would like to use the service, please sign up prior to July 30. For capabilities similar to Q Business, explore Amazon Quick. Learn more.

GitHub (Server) connector overview

The following table gives an overview of the Amazon Q Business GitHub (Server) connector and its supported features.

Category Feature Support
Security Authentication type OAuth token, Personal token
Authentication credentials

  • GitHub token
Access Control List (ACL) crawling Yes. For more information, see ACL crawling.
Identity crawling Yes
VPC Yes
Crawl features Entities Yes. The following entities are supported:

  • Repository

  • Repository Commit

  • Issue Document

  • Issue Comment

  • Issue Attachment

  • Pull Request Comment

  • Pull request Document

  • Pull Request Attachment

See What is a document? for more details on what each connector crawls as a document.
Field mappings Yes. Supports default and custom field mappings. For more information, see Field mappings.
Filters Yes. The following filters are supported:

  • Include select repositories

  • Include content by specific entities.

  • Include specific branched by name

  • Include/exclude content by file name, file type, and file path
Sync mode Supports full and incremental sync.
File types Supports all files supported by Amazon Q.