# Managing Amazon Q Business application resources Managing resources You can choose to manage your Amazon Q Business application environment and associated resources. To learn how to do so, see the following sections: + [Managing Amazon Q Business applications](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/supported-app-actions.html) + [Managing Amazon Q Business web experiences](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/supported-exp-actions.html) + [Managing user subscriptions](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/manage-user-subscriptions.html) + [Tagging resources](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tagging.html) # Managing Amazon Q Business applications Managing applications To manage an Amazon Q Business application environment, you can take the following actions: **Topics** + [ ## Deleting an application ](#delete-app) + [ ## Getting application environment properties ](#describe-app) + [ ## Listing applications ](#list-app) + [ ## Updating an application environment ](#update-app) ## Deleting an application To delete an Amazon Q Business application environment, you can use the console or the [https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DeleteApplication.html](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DeleteApplication.html) API operation. The following tabs provide a procedure for the console and code examples for the AWS CLI. ------ #### [ Console ] **To delete an Amazon Q Business application** 1. Sign in to the AWS Management Console and open the Amazon Q Business console. 1. In **Applications**, choose **Actions**. 1. Choose **Delete**. 1. In the dialog box that opens, type **Delete** to confirm deletion, and then choose **Delete**. You are returned to the service console while your application environment is deleted. When the deletion process is complete, the console displays a message confirming successful deletion. ------ #### [ AWS CLI ] **To delete an Amazon Q Business application environment** ``` aws qbusiness delete-application \ --application-id application-id ``` ------ ## Getting application environment properties To get the properties of an Amazon Q Business application environment, you can use the console or the [https://docs.aws.amazon.com/amazonq/latest/api-reference/API_GetApplication.html](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_GetApplication.html) API operation. The following tabs provide a procedure for the console and code examples for the AWS CLI. ------ #### [ Console ] **To get properties of an Amazon Q Business application environment** 1. Sign in to the AWS Management Console and open the Amazon Q Business console. 1. For **Applications**, select the name of your application environment from the list of applications. 1. On **Application settings**, the following properties are available: + **Application name** – The name that you chose for your application environment. + **Application ID** – The ID assigned to your application environment. + **Subtitle** – The subtitle that you chose to assign to your application environment. + **Service access** – The service access role that your application environment is using. + **Title** – The title that you gave to your application environment. + **Application status** – The status of your application environment. To update a setting, select **Edit**. ------ #### [ AWS CLI ] **To get Amazon Q Business application properties ** ``` aws qbusiness get-application \ --application-id application-id ``` ------ ## Listing applications To list Amazon Q Business applications, you can use the console or the [https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ListApplications.html](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ListApplications.html) API operation. The following tabs provide a procedure for the console and code examples for the AWS CLI. ------ #### [ Console ] **To list your Amazon Q Business application environments** 1. Sign in to the AWS Management Console and open the Amazon Q Business console. 1. In **Applications**, all your configured application environments are listed. ------ #### [ AWS CLI ] **To list Amazon Q Business application environments ** ``` aws qbusiness list-applications \ --max-results max-results-to-return ``` ------ ## Updating an application environment To update an Amazon Q Business application environment, you can use the console or the [https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateApplication.html](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateApplication.html) API operation. **Note** You can't update the retriever you've chosen or change users and groups added to the application environment when you update it. If you need to update your retriever, create a new application environment. If you're integrating your Amazon Q Business application environment with IAM Identity Center (IDC) and you want to update users and groups, you can do so from the [application environment summary](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/supported-app-actions.html) page. The following tabs provide a procedure for the console and code examples for the AWS CLI. ------ #### [ Console ] **To update an Amazon Q Business application environment** **Option 1** 1. Sign in to the AWS Management Console and open the Amazon Q Business console. 1. In **Applications**, select the name of your application environment from the list of applications. 1. In **Applications**, choose **Actions**. 1. Choose **Edit**. On the **Update application** page, edit your application environment settings. **Option 2** 1. Sign in to the AWS Management Console and open the Amazon Q Business console. 1. In **Applications**, select the name of your application environment from the list of applications. 1. On the application page, select **Edit** from the page header, or select **Edit** from **Application settings**. 1. Choose **Edit**. On the **Update application** page, edit your application environment settings. ------ #### [ AWS CLI ] **To update an Amazon Q Business application environment ** ``` aws qbusiness update-application \ --application-id application-id \ --display-name application-name \ --role-arn roleArn \ --description application-description \ --attachments-configuration attachmentsControlMode=ENABLED ``` ------ # Managing Amazon Q Business web experiences Managing web experiences To manage Amazon Q Business web experiences, you can take the following actions: **Topics** + [ ## Creating a web experience ](#create-experience) + [ ## Deleting a web experience ](#delete-web-experience) + [ ## Getting properties of a web experience ](#describe-web-experience) + [ ## Listing web experiences ](#list-web-experiences) + [ ## Updating a web experience ](#update-web-experience-idp) ## Creating a web experience To create an Amazon Q Business web experience, you can use the console or the [CreateWebExperience](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateWebExperience.html) API operation. The following tabs provide a procedure for the AWS Management Console and code examples for the AWS CLI. ------ #### [ Console ] If you use the console, this action is spread across two steps: [Configuring an Amazon Q Business application using AWS IAM Identity Center](create-application.md) and [Customizing web experience](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/customizing-web-experience-app.html). To create a web experience, you must create an application environment. ------ #### [ AWS CLI ] **To create an Amazon Q Business web experience** ``` aws qbusiness create-web-experience \ --application-id application-id \ --sample-prompts-control-mode sample-prompts \ --subtitle subtitle \ --tags tags \ --title title \ --welcome-message welcome-message \ ``` ------ ## Deleting a web experience To delete an Amazon Q Business web experience, you can use the console or the [DeleteWebExperience](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DeleteWebExperience.html) API operation. If you're using the API, you can delete a web experience without deleting the application environment that it's a part of. If you're using the console, the only way to delete your Amazon Q Business web experience is to delete the Amazon Q Business application environment that it's attached to. The following tabs provide a procedure for the AWS Management Console and code examples for the AWS CLI. ------ #### [ Console ] **To delete an Amazon Q Business web experience** 1. Sign in to the AWS Management Console and open the Amazon Q Business console. 1. In **Applications**, choose **Actions**. 1. Choose **Delete**. 1. In the dialog box that opens, type **Delete** to confirm deletion, and then choose **Delete**. You are returned to the service console while your application environment is deleted. When the deletion process is complete, the console displays a message confirming successful deletion. Both the application environment and the web experience are deleted. ------ #### [ AWS CLI ] **To delete an Amazon Q Business web experience** ``` aws qbusiness delete-web-experience \ --application-id application-id \ --web-experience-id web-experience-id ``` ------ ## Getting properties of a web experience To get the properties of an Amazon Q Business web experience, you can use the console or the [GetWebExperience](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_GetWebExperience.html) API operation. The following tabs provide a procedure for the AWS Management Console and code examples for the AWS CLI. ------ #### [ Console ] **To get properties of an Amazon Q Business web experience ** 1. Sign in to the AWS Management Console and open the Amazon Q Business console. 1. In **Applications**, select the name of your application environment from the list of applications. 1. For **Web experience settings**, the following settings are available: + **Web experience IAM role ARN** – The IAM role assumed by end users when they log in to your web experience. + **Deployed URL** – The deployed URL of your web experience. + **Tags** – Tags that are attached to your web experience. To update a setting, choose **Edit**. ------ #### [ AWS CLI ] **To get properties of an Amazon Q Business web experience** ``` aws qbusiness get-web-experience \ --application-id application-id \ --web-experience-id web-experience-id ``` ------ ## Listing web experiences To list Amazon Q Business web experiences, you can use the console or the [ListWebExperiences](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ListWebExperiences.html) API operation. If you use the console, you can only see the web experience that's attached to a single application environment. The following tabs provide a procedure for the AWS Management Console and code examples for the AWS CLI. ------ #### [ Console ] **To list Amazon Q Business web experiences** 1. Sign in to the AWS Management Console and open the Amazon Q Business console. 1. For **Applications**, the Amazon Q Business web experience attached to your application environment is shown. ------ #### [ AWS CLI ] **To list Amazon Q Business web experiences** ``` aws qbusiness get-web-experience \ --application-id application-id \ --web-experience-id web-experience-id \ --max-results max-results-to-return ``` ------ ## Updating a web experience To update an Amazon Q Business web experience, you can use the console or the [UpdateWebExperience](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateWebExperience.html) API operation. The following tabs provide a procedure for the AWS Management Console and code examples for the AWS CLI. ------ #### [ Console ] **To update an Amazon Q Business web experience** 1. Sign in to the AWS Management Console and open the Amazon Q Business console. 1. In **Applications**, select the name of your application environment from the list of applications. 1. Select **Customize web experience**. 1. Expand the right navigation menu to edit your web experience settings. ------ #### [ AWS CLI ] **To update an Amazon Q Business web experience** ``` aws qbusiness update-web-experience \ --application-id application-id \ --web-experience-id web-experience-id \ --authentication-configuration authentication-configuration \ --sample-prompts-control-mode sample-prompts \ --subtitle subtitle \ --title title \ --welcome-message welcome-message ``` ------ # Managing user subscriptions for IAM Identity Center-integrated applications Managing subscriptions To manage user subscriptions added to an application environment, you can perform the following actions: **Topics** + [ ## Updating user subscriptions ](#update-user-subscriptions) + [ ## Canceling user or group subscriptions ](#delete-user-subscriptions) + [ ## Listing user subscriptions ](#list-user-subscriptions) ## Updating user subscriptions To update a subscription in an Amazon Q Business application, you can use either the AWS Management Console or the [https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateSubscription.html](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateSubscription.html) API operation. For more information on user subscriptions for an IAM Identity Center-integrated Amazon Q Business application, see [Subscriptions for applications using IAM Identity Center](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#managing-sub-tiers-sso). ------ #### [ Console ] **To update user or group subscription tier** 1. Sign in to the AWS Management Console and open the Amazon Q Business console. 1. In **Applications**, select the name of the application environment you created. 1. From your applications page, from the **User access** section, select **Manage user access**. 1. From **Manage access and subscriptions** select the subscription you want to update. Then, select **Edit subscription**. 1. In the **Confirm subscription change** dialog box that opens, from the **New subscription** dropdown select **Q Business Lite** or **Q Business Pro**. 1. Then, select **Confirm**. You will see the subscription status notification change next to the user you've added the subscription to. 1. Then, select **Confirm** to save your changes. ------ #### [ AWS CLI ] **To update user or group subscription tier** ``` aws qbusiness update-subscription \ --application-id application-id \ --subscription-id subscription-id \ --type subscription-type ``` ------ ## Canceling user or group subscriptions To cancel subscriptions, you can use the AWS Management Console or the [https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CancelSubscription.html](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CancelSubscription.html) API operation. When you unsubscribe and remove a user or group, it unsubscribes them from the application environment and removes them from the user list. For more information on user subscriptions for an IAM Identity Center-integrated Amazon Q Business application, see [Subscriptions for applications using IAM Identity Center](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#managing-sub-tiers-sso). ------ #### [ Console ] **To unsubscribe a user or group from an Amazon Q Business application environment** 1. Sign in to the AWS Management Console and open the Amazon Q Business console. 1. In **Applications**, select the name of the application environment you created. 1. From your applications page, from the **User access** section, select **Manage user access**. 1. From **Manage access and subscriptions** select the user or group subscription you want to update. Then, select **Remove and unsubscribe**. 1. Then, from the **Unsubscribe and remove** dialog box, **Confirm**. 1. Then, select **Confirm** to save your changes. This step cancels subscriptions for the selected users and groups and also removes them from your Amazon Q Business application environment. **Note** To stop subscription charges for a user, ensure you have unsubscribed that user from all Amazon Q Business application environments and Quick instances. For instructions on how to unsubscribe a user from Quick, see [Unsubscribing from Quick Q](https://docs.aws.amazon.com/quicksight/latest/user/quicksight-q-unsubscribe.html) in the Quick User Guide. To stop charges for an Amazon Q Business index, you must delete either your Amazon Q Business index or [delete your Amazon Q Business application environment](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/supported-app-actions.html#delete-app). If you use the console, deleting your application environment is the only way to delete an index associated with it. ------ #### [ AWS CLI ] **To cancel user or group subscriptions to Amazon Q Business** ``` aws qbusiness cancel-subscription \ --application-id application-id \ --subscription-id subscription-id \ --type subscription-type ``` ------ ## Listing user subscriptions To see a list of user and group subscriptions within a specific Amazon Q Business application, you can use the AWS Management Console or the [https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ListSubscriptions.html](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ListSubscriptions.html) API operation. For a consolidated view of your user subscriptions—including a list of subscribed users, their subscription status, and applications, accounts, or services a user can access through their subscriptions—you can also view the [Amazon Q subscriptions page](https://console.aws.amazon.com/amazonq/subscriptions). ------ #### [ Console ] **To view a list of user and group subscriptions in an Amazon Q Business application environment** 1. Sign in to the AWS Management Console and open the Amazon Q Business console. 1. In **Applications**, select the name of the application environment you created. 1. From your applications page, from the **User access** section, select **Manage user access**. 1. In the **Manage access and subscriptions** select **Users** if you want to view user subscriptions or **Groups** if you want to list group subscriptions. **To view a consolidated list of all user and group subscriptions across all Amazon Q Business application environments** 1. Sign in to the AWS Management Console and open the Amazon Q console. 1. From the left navigation menu, choose **Subscriptions**,and then select **Users** if you want to view user subscriptions or **Groups** if you want to list group subscriptions. ------ #### [ AWS CLI ] **To list user or group subscriptions in an Amazon Q Business application** ``` aws qbusiness list-subscriptions \ --application-id application-id ``` **To list user or group subscriptions across all Amazon Q Business applications** This action is not supported. ------ # Tagging Amazon Q Business resources Tagging resources Manage your Amazon Q Business applications and web experiences by assigning tags. You can use tags to categorize your Amazon Q Business resources in various ways. For example, you could categorize by purpose, owner, or application, or any combination. Each tag consists of a *key* and a *value*, both of which you define. Tags help you to do the following: + **Identify and organize your AWS resources** – Many AWS services support tagging, so you can assign the same tag to resources in different services to indicate that the resources are related. For example, you can tag an Amazon Kendra retriever and the Amazon Q Business web experience that uses the retriever with the same tag. + **Allocate costs** – You activate tags on the AWS Billing and Cost Management dashboard. AWS uses tags to categorize your costs and deliver a monthly cost allocation report to you. For more information, see [Cost Allocation and Tagging](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the *AWS Billing User Guide*. + **Control access to your resources** – You can use tags in AWS Identity and Access Management (IAM) policies that control access to Amazon Q Business resources. To activate tag-based access control, you can attach these policies to an IAM role or IAM user. For more information, see [Authorization based on tags](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/security_iam_service-with-iam.html#security_iam_service-with-iam-tags). You can create and manage tags using the AWS Management Console, the AWS Command Line Interface (AWS CLI), or the Amazon Q Business API. **Topics** + [ ## Using tags ](#tagging-resources) + [ ## Tag restrictions ](#tag-restrictions) ## Using tags If you're using the console, you can tag resources when you create them or add them later. You can also use the console to update or remove tags in the following ways: ------ #### [ Adding tags ] **To add Amazon Q Business tags** 1. Sign in to the AWS Management Console and open the Amazon Q Business console. 1. From **Applications**, select the application whose resources you want to tag. 1. From the application summary page, scroll down and select **Tags**. 1. In **Tags**, from the resource you want to add tags to, select **Manage tags**. 1. In **Tags – *optional***, select **Add new tag** to add tags to your Amazon Q Business resource. Then, enter the following information for each tag: + **Key** – Add a key for your tag. + **Value - *optional*** – An optional value for your tag. 1. Select **Save**. ------ #### [ Removing tags ] **To remove tags** 1. Sign in to the AWS Management Console and open the Amazon Q Business console. 1. From **Applications**, select the application you want to delete tags from. 1. From the application summary page, scroll down and select **Tags**. 1. In **Tags**, from the resource you want to add tags to, select **Manage tags**. 1. In **Tags – *optional***, select **Remove**. 1. Select **Save**. ------ #### [ Listing tags ] **To view a list of tags** 1. Sign in to the AWS Management Console and open the Amazon Q Business console. 1. From **Applications**, select the application you want to delete tags from. 1. From the application summary page, scroll down and select **Tags**. 1. In **Tags**, each tagged resource will display a list of tags associated with it. ------ If you're using the AWS CLI or the Amazon Q Business API, use the following operations to manage tags for your resources: + [CreateApplication](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateApplication.html) – Apply tags when you create an Amazon Q Business application. + [CreateWebExperience](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateWebExperience.html) – Apply tags when you create an Amazon Q Business web experience. + [ListTagsForResource](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ListTagsForResource.html) – View the tags associated with a resource. + [TagResource](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_TagResource.html) – Add and modify tags for a resource. + [UntagResource](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UntagResource.html) – Remove tags from a resource. ## Tag restrictions The following restrictions apply to tags on Amazon Q Business resources: + Maximum number of tags – 50 + Maximum key length – 128 characters + Maximum value length – 256 characters + Valid characters for key and value – a–z, A–Z, space, and the following characters: \$1 . : / = \$1 - and @ + Keys and values are case sensitive + Don't use `aws:` as a prefix for keys; it's reserved for AWS use