Register Amazon Q details in Control Room via API

Register your Amazon Q index details in Control Room using public APIs, mapping the Amazon Q Business application, retriever, and identity settings. This ensures Automation Co-Pilot can securely route user queries to the correct Q index and deliver accurate responses.

1. Open Postman or a similar tool for running REST calls.
2. Create a POST request to {{ControlRoomURL}}/v2/authentication.
3. Add the following details in the body, replacing the CR Username and CR Password with your own specific values to log into the Control Room:

   {
     "username": "{{CR_username}}",
     "password": "{{CR_password}}" 
   }

4. Execute the request and in the response, copy the value of token to your clipboard.
5. Create a POST request to {{ControlRoomURL}}/v1/qindex.
6. Create a new header key-value pair:
   • Key: X-Authorization
   • Value: The value of token from the authentication request
7. Add the following into the body of your request and update the values with the specific values from your AWS console:

   {
     "qbizappid": "{{Q Biz App ID}}",
     "retrieverid": "{{Retreiver ID}}",
     "idcapparn": "{{IDC App ARN}}",
     "qbizregion": "{{Q Biz Region}}",
     "iamidcregion": "{{IDC Region}}"  
   }

8. Execute the request and ensure you receive a 200 OK as a response.
   Your Amazon Q index details are saved into the Control Room and can be used to query the data within it from Automation Co-Pilot.