Lists the retriever used by an Amazon Q Business application.
Request Syntax
GET /applications/applicationId/retrievers?maxResults=maxResults&nextToken=nextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- applicationId
-
The identifier of the Amazon Q Business application using the retriever.
Length Constraints: Fixed length of 36.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9-]{35}Required: Yes
- maxResults
-
The maximum number of retrievers returned.
Valid Range: Minimum value of 1. Maximum value of 50.
- nextToken
-
If the number of retrievers returned exceeds
maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of retrievers.Length Constraints: Minimum length of 1. Maximum length of 800.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"retrievers": [
{
"applicationId": "string",
"displayName": "string",
"retrieverId": "string",
"status": "string",
"type": "string"
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- nextToken
-
If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of retrievers.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
- retrievers
-
An array of summary information for one or more retrievers.
Type: Array of Retriever objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
HTTP Status Code: 403
- InternalServerException
-
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support
for help. HTTP Status Code: 500
- ResourceNotFoundException
-
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to throttling. Reduce the number of requests and try again.
HTTP Status Code: 429
- ValidationException
-
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
