Q Business Using Deprecated Search API, what scope should I give my API token to use the new one?

[Rafael Ojeda]

I am currently trying to create a Amazon Q Business application with the data source of Jira to be able to search through issues, ask any questions on ongoing projects etc. 

I used the following to set my Q Business data source for Jira up and running: 

- https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/jira-prereqs.html

- https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/jira-credentials-basic.html

My data source successfully connects but it is not able to scan any items due to this error: 

---

An exception has occurred while fetching issue entity information , Error: [410 Gone] during [GET] to [https://companyJira-admin.atlassian.net/rest/api/3/search?jql=updated%3E%3D0&startAt=0&maxResults=50&fields=%2Aall&expand=all] [IssueSearchApi#searchForIssuesUsingJql(String,Integer,Integer,String,List,String,List,Boolean)]: [{"errorMessages":["The requested API has been removed. Please use the newer, enhanced search-based API instead. Deprecation details are available at https://developer.atlassian.com/changelog/#CHANGE-2046."],"errors":{}}]

---

I generated the api token through an account with admin access, I understand it says that my Q Business Application is attempting to query through a deprecated API, I am just not sure how I can make it query through the new API endpoints. Does this have to due with me giving the incorrect scope to the API token? If so, which scopes should I be giving the API for it to properly search. 

[Sunny Ape]

Does this have to due with me giving the incorrect scope to the API token?

Nope.

It has to do with what the error message says is described in CHANGE-2046, which is that the GET /rest/api/2|3/search endpoint has been deprecated and replaced with the GET /rest/api/2|3/search/jql endpoint.

If you look at the documentation for all the Issue Search endpoints, you'll see the same information has been provided about those old endpoints.

PS. The startAt and maxResults parameters have default values of 0 and 50 respectively, so there's no need to declare those same parameter values again in your request.

PPS. The expand parameter doesn't accept a value 'all', so that's mistake in your request. You must specify the names of the fields you want expanded.

PPPS. Your request declares the value '%2all' for the fields parameter, but the alt code for an asterisk is '%42' not '%2' so that's also a mistake in your request.

You might want to try using an API test tool like Postman to validate your requests before you commit them to your use case.

[Rafael Ojeda]

I am using Amazon Q Business though, which is supposed to intelligently call the right endpoints based on the given API. I am not manually picking out the endpoints that I would like for Jira to use Q Business just seems to be choosing the incorrect ones. Could this be something with Amazon Q Business then? 

How can I make sure that Amazon Q Business uses the non-deprecated endpoints?

[Sunny Ape]

Could this be something with Amazon Q Business then?

I have no idea, as I don't use Amazon Q Business.

I do know how to use Google though, so I did a search of "Using Amazon Q Business, can I manually select the API endpoint it uses?" for you and I got this response:

"While you do not directly 'manually select' a specific API endpoint from a list within the Amazon Q Business console or settings, you can control the endpoint used by configuring VPC interface endpoints (AWS PrivateLink) for Amazon Q"

...followed by instructions on how to achieve this, as well as links to the associated Amazon Q Business documentation on the topic.

I guess all you have to do is ask Google and you can get the answer.

Have fun!