Managing subscriptions
This section provides instructions for managing Amazon Q Developer subscriptions. It details the prerequisites for subscribing, how to assign users and groups to subscriptions, and the steps to manage your Amazon Q Developer settings. Additionally, it includes troubleshooting tips for common subscription issues to ensure smooth and effective use of Amazon Q Developer services.
Prerequisites for subscribing to Amazon Q Developer
Before you begin, be sure that you've authorized an Amazon Q Developer subscriptions administrator, authorized an Amazon Q Developer profile administrator, and set up either an organization instance or an account instance of Amazon Q Developer.
Subscribing to Amazon Q Developer
Note
If you are using an organization instance of IAM Identity Center, then AWS recommends that you manage your Amazon Q Developer profile from the organization management account.
If you choose to manage it from some other account within the same organization (including a delegated admin account), then you will not be able to change the default profile settings. These include:
-
You will receive suggestions with code references.
-
All Amazon Q Developer features will be enabled.
-
Your data will be encrypted with a AWS KMS key that AWS owns and manages for you.
-
Sign in to the AWS Management Console, and open the Amazon Q Developer subscriptions console
. -
Choose Subscriptions.
-
You can view users and groups in your organization’s member accounts on the Subscriptions page by enabling View subscriptions from member accounts in Settings. When this option is not enabled, the Subscriptions page only displays users and groups in your AWS account.
-
On the Amazon Q subscriptions page, select the users and groups that should be end users of Amazon Q Developer, and choose Assign.
It is necessary to search for each user whom you want to add by name. The names of the users registered to your IAM Identity Center will not appear automatically. Also, you must search by display name (usually the user's first and last name), and not by the one-word username used to sign in to the AWS account.
Note
When you add a group, as defined in IAM Identity Center, to a subscription, or add a user to a subscribed group, it may take up to 24 hours for that user, or users in that group, to be subscribed.
-
Open the Amazon Q Developer console.
-
Manage your Amazon Q Developer settings.
On this page, you can select the features of Amazon Q Developer that will be available to your users.
-
Copy the Start URL.
Pass the Start URL along to your developers, and direct them to Using Amazon Q Developer in the IDE.
Enabling trusted access
Amazon Q Developer uses trusted access to share the settings made in the Organizations management account with member accounts in the same organization.
For example, the Amazon Q Developer Pro administrator, working in the Organizations management account, may enable suggestions with code references. If trusted access is enabled, then suggestions with code references will also be enabled for all member accounts in that organization.
When you subscribe to Amazon Q Developer Pro with an Amazon OpenSearch Service management account, you are given the option to share settings with member accounts. You may also share or un-share those settings after subscribing.
To enable or disable trusted access after subscribing, use the following procedure.
-
On the Amazon Q Developer Settings page, under Member account settings, choose Edit.
-
In the pop-up window, select On or Off.
-
Choose Save.
To learn more about trusted access, refer to Enabling trusted access for AWS Account Management in the Amazon OpenSearch Service User Guide.
Unsubscribing
Unsubscribing from Amazon Q Developer Pro
Administrators can unsubscribe users from Amazon Q Developer Pro subscriptions through the subscriptions page in the console by de-selecting user names in the Amazon Q console.
To unsubscribe a user:
-
Go to the Subscriptions page of the Amazon Q Developer console.
-
Select the user.
-
Under Actions, choose Unsubscribe.
-
A pop-up window will ask you to confirm. Choose Unsubscribe.
However, the process varies based on the creator of the subscription:
-
Member account administrators can only view and unsubscribe users subscribed within their account, and only if they created that specific subscription.
-
Organization management account administrators can unsubscribe users if they created that subscription. They can also view other accounts the user is subscribed through (by selecting Share settings profile with member accounts on the Settings page), allowing them to coordinate with respective member account admins for unsubscription. Alternatively, they can log in as a member account administrator and unsubscribe the user directly.
For more information, refer to Managing AWS accounts in your organization.
Unsubscribing from Amazon Q Business
To unsubscribe from Amazon Q Business, see Section 2.c., Unsubscribe and remove, under Adding user access and subscriptions to an Amazon Q application in the Amazon Q Business User Guide.
Unsubscribing from Amazon QuickSight Q
To unsubscribe from Amazon QuickSight, see Unsubscribing from Amazon QuickSight Q in the Amazon QuickSight User Guide.
Note
If a user is using both Amazon QuickSight and Amazon Q Business as part of Amazon Q Business Pro, then you must remove the user from both services in order to avoid further billing for that user.
Troubleshooting subscriptions
You may encounter the following error message when trying to access Amazon Q Developer in the AWS Management Console and on the AWS Documentation website:
An error occurred when attempting to access Amazon Q Review the Amazon Q in console common errors documentation for potential solutions.
This could be due to one of the following reasons:
-
You were recently added to a group, and your subscription is not yet active.
If your administrator manages Amazon Q subscription access using identity provider groups, there might be a delay when they add users to the group. You might need to wait up to 24 hours for access to be activated.
-
You don't have an active subscription.
Try refreshing the page to use the Amazon Q Developer Free Tier.
-
Your access to the Amazon Q Developer Pro managed application was revoked.
You still have an active subscription, but your access to the Amazon Q Developer Pro managed application was revoked or the managed application was deleted. Contact your administrator to restore your access.
-
You don't have sufficient IAM permissions.
You or your AWS administrator must update your IAM permissions to allow the use of Amazon Q Developer. For more information, see Identity-based policy examples for Amazon Q Developer. After you obtain the necessary permissions, reload the console page to access Amazon Q.
