Prerequisites for Amazon Q customizations
Amazon Q customizations build upon the foundation of Amazon Q Developer Pro, and uses its features.
To use Amazon Q customizations you must first follow the Amazon Q Developer Pro setup process under Getting started with Amazon Q Developer. This includes adding any users to your Amazon Q Developer Pro profile that you also wish to grant access to Amazon Q Customizations.
Authorizing your administrator
When you use Amazon Q Customizations, your Amazon Q administrator must be authorized to access your codebase, which you can store on Amazon S3 or through AWS CodeConnections. However, during the standard setup process for Amazon Q Developer Pro, your AWS Organizations administrator does not provide the Amazon Q administrator with access to those services.
This means that to create customizations, administrators need additional permissions. For an example policy that grants the needed permissions, see Allow administrators to create customizations.
Note
If you are using GitHub as your data source, you can restrict usage to certain repositories. See Create a connection to GitHub in the Developer Tools Console User Guide.
Note
The encryption key that you set up for Amazon Q Developer Pro is also used for customizations.
Preparing your data
It's important to create your customization using the best possible source material. When preparing your data source, add code containing patterns that are encouraged on your team. Avoid code containing anti-patterns, bugs, security vulnerabilities, performance issues, and so forth.
To prepare your data source, follow these guidelines:
-
Your data source must contain at least 2 MB, and at most 20 GB, of source code files from supported languages. Any file in your data source that's larger than 10 MB will be ignored.
-
There is no limit on the number of files in your data source, but you must include at least 10 files for each language that you want your customization to support.
-
File names and individual directory names must not exceed 255 characters. (Cumulatively, they can exceed 255 characters.) Exceeding these limits causes the customization creation to fail.
-
In the Amazon S3 data source, all source code must be placed within a directory and not at the root level. Any files at the root level will be ignored.
Note
Amazon Q uses the following file types to train customizations:
-
Java (.java)
-
JavaScript (.js, .jsx)
-
Markdown (.md, .mdx)
-
Python (.py)
-
reStructuredText (.rst)
-
Text (.txt)
-
TypeScript (.ts, .tsx)
You can store information about the creation of your customizations in Amazon CloudWatch Logs. For more information, see Accessing customization-related messages in Amazon CloudWatch Logs.
