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.
Managing subscriptions for an Amazon Q Business application using APIs
Amazon Q Business provides APIs to manage subscriptions in your Amazon Q Business application. You can use these APIs to implement your own subscription management solution if you create a Amazon Q Business application environment programmatically.
Note
As of Dec 17, 2024, Amazon Q Business will recognize all email addresses as
case-insensitive and recognize subaddresses as equivalent to the original email
address. For example, JohnDoe@example.com, johndoe@example.com, and
johndoe+work@example.com will be considered the same email address. For assistance
with applications or to report a concern, contact Support, sign into the
AWS Support Center
| API action | API description | Relevant User Guide topic |
|---|---|---|
| CreateSubscription | Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application NoteIf you're using IAM federation to manage user and group access to Amazon Q Business, subscriptions are created automatically when a user logs in to their Amazon Q Business application. |
|
| CancelSubscription | Unsubscribes a user or a group from their pricing tier in an Amazon Q Business application | |
| ListSubscriptions | Lists all subscriptions created in an Amazon Q Business application | |
| UpdateSubscription | Updates the pricing tier for an Amazon Q Business subscription |