0 : AUTOMATED CONFIGURATION =============================================
The steps from 0) to 1) of the first action can be automatically performed by using this deployment template:
   https://console.aws.amazon.com/cloudformation/home?#/stacks/create/review?stackName=BubbleAmazonQForBusiness&templateURL=https://bubble-resources.s3.amazonaws.com/deployment-assets/CloudFormation-AWSAmazonQForBusiness.yaml

 You will find the required parameters values used across the plugin in the "OUTPUT" tab of the created stack.

1 : CREATE USER (AMAZON Q FOR BUSINESS)
=====================================

ACTION DESCRIPTION
--------------------------------
 CREATE USER (AMAZON Q FOR BUSINESS) creates a Amazon Q user mapped to a local user id, such as an email address, within an application, allowing usage and access to Amazon Q.

STEP-BY-STEP SETUP
--------------------------------
 0) Sign-up for AWS AMAZON Q: https://console.aws.amazon.com/amazonq/home?p=ply&cp=bn&ad=c

 1) Create your AWS AMAZON Q FOR BUSINESS API Key & Key Secret, then add to the credentials the QBUSINESS:* permissions : https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys

 2) In the Plugin Settings, enter the following :
     - AWS AMAZON Q FOR BUSINESS API KEY & SECRET
     - AWS SERVICE ENDPOINT REGION (if not provided, default endpoint is "us-east-1").

 3) Create your application and add your datasources by following the step-by-step https:/console.aws.amazon.com/amazonq/home?#applications/createApplication
    Always accept to create recommended IAM roles when required. Deploying the Web Experience is not required.

 4) Set up the "CREATE USER (AMAZON Q FOR BUSINESS)" action in the workflow.
   Inputs Fields :
     - APPLICATION ID : The identifier of the Amazon Q application.
     - USER ID : The user emails attached to a user mapping.

   Output Fields :
     - SUCCESS : Returns a true if success.

2 : SEND PROMPT (AMAZON Q FOR BUSINESS)
======================================

ACTION DESCRIPTION
--------------------------------
 SEND PROMPT (AMAZON Q FOR BUSINESS) sends to the specified AWS Amazon Q application a prompt to answer to.

STEP-BY-STEP SETUP
--------------------------------
 0) If not already done, perform the steps 0 to 4 of the first action of this documentation.

 1) Set up the "SEND PROMPT (AMAZON Q FOR BUSINESS)" action in the workflow.
   Inputs Fields :
     - OUTPUT TYPE : Must always be "RESULT (AMAZON Q FOR BUSINESS)"
     - APPLICATION ID : The identifier of the Amazon Q application.
     - USER ID : The identifier of the user involved in the Amazon Q web experience conversation.
     - CONVERSATION ID : The identifier of the Amazon Q web experience conversation.
     - PARENT MESSAGE ID : The identifier of the previous end USER text input message in a conversation.
     - USER MESSAGE : Prompt of the user.
     - ATTACHMENT : File URL from the Bubble.io uploader, or a Protocol-relative URLs (//server/file.ext), or a HTTPS file URL (https://server/file.ext). The file must be accessible through the HTTPS protocol. The file must be less than 10 megabytes.

   Output Fields :
     - RESULTS : Returns the answer as a single MESSAGE, containing MESSAGE ID, Body, Start Time, Attribution Sources and Type, which is either SYSTEM or USER.

3 : LIST CONVERSATIONS (AMAZON Q FOR BUSINESS)
===========================================

ACTION DESCRIPTION
--------------------------------
 LIST CONVERSATIONS (AMAZON Q FOR BUSINESS) lists all the conversations of a given Amazon Q Business application. Returns for each CONVERSATION IDs, Title and Start Time.

STEP-BY-STEP SETUP
--------------------------------
 0) If not already done, perform the steps 0 to 4 of the first action of this documentation.

 1) Set up the "LIST CONVERSATIONS (AMAZON Q FOR BUSINESS)" action in the workflow.
   Inputs Fields :
     - OUTPUT TYPE : Must always be "RESULT (AMAZON Q FOR BUSINESS)"
     - APPLICATION ID : The identifier of the Amazon Q application.
     - USER ID : The identifier of the user involved in the Amazon Q web experience conversation.
   Output Fields :
     - RESULTS : Returns a list of CONVERSATIONS, containing for each the CONVERSATION ID, Title, and Start Time.

4 : LIST MESSAGES (AMAZON Q FOR BUSINESS)
=======================================

ACTION DESCRIPTION
--------------------------------
 LIST MESSAGES (AMAZON Q FOR BUSINESS) lists all the messages of a given Amazon Q Business conversation. Returns for each MESSAGE ID, Body, Start Time, Attribution Sources and Type, which is either SYSTEM or USER.

STEP-BY-STEP SETUP
--------------------------------
 0) If not already done, perform the steps 0 to 4 of the first action of this documentation.

 1) Set up the "LIST MESSAGES (AMAZON Q FOR BUSINESS)" action in the workflow.
   Inputs Fields :
     - OUTPUT TYPE : Must always be "AMAZON Q - RESULTS".
     - APPLICATION ID : The identifier of the Amazon Q application.
     - USER ID : The identifier of the user involved in the Amazon Q web experience conversation.
     - CONVERSATION ID : The identifier of the Amazon Q web experience conversation.
   Output Fields :
     - RESULTS : Returns a list of MESSAGES, containing for each MESSAGE ID, Body, Start Time, Attribution Sources and Type, which is either SYSTEM or USER.

5 : DELETE USER (AMAZON Q FOR BUSINESS)
=====================================

ACTION DESCRIPTION
--------------------------------
 DELETE USER (AMAZON Q FOR BUSINESS) deletes a Amazon Q user already mapped to a local user id, such as an email address, within the specified application.

STEP-BY-STEP SETUP
--------------------------------.
 0) If not already done, perform the steps 0 to 4 of the first action of this documentation.

 1) Set up the "DELETE USER (AMAZON Q FOR BUSINESS)" action in the workflow.
   Inputs Fields :
     - APPLICATION ID : The identifier of the Amazon Q application.
     - USER ID : The user emails attached to a user mapping.

   Output Fields :
     - SUCCESS : Returns a true if success.


IMPLEMENTATION EXAMPLE
======================
Feel free to browse the app editor in the Service URL for an implementation example.

ADDITIONAL INFORMATION
======================

> AWS AMAZON Q service limits : https://docs.aws.amazon.com/amazonq/latest/business-use-dg/load-balancer-limits.html
> AWS services availability per region : https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services/
> AWS Service endpoints list : https://docs.aws.amazon.com/general/latest/gr/rande.html

TROUBLESHOOTING
================
Any plugin related error will be posted to the the Logs tab, "Server logs" section of your App Editor.
Make sure that "Plugin server side output" and "Plugin server side output" is selected in "Show Advanced".

> Server Logs Details: https://manual.bubble.io/core-resources/bubbles-interface/logs-tab#server-logs

QUESTIONS ?
===========
Contact us at [email protected] for any additional feature you would require or support questi