- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListRetrieversCommand
Lists the retriever used by an Amazon Q Business application.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { QBusinessClient, ListRetrieversCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
// const { QBusinessClient, ListRetrieversCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
const client = new QBusinessClient(config);
const input = { // ListRetrieversRequest
applicationId: "STRING_VALUE", // required
nextToken: "STRING_VALUE",
maxResults: Number("int"),
};
const command = new ListRetrieversCommand(input);
const response = await client.send(command);
// { // ListRetrieversResponse
// retrievers: [ // Retrievers
// { // Retriever
// applicationId: "STRING_VALUE",
// retrieverId: "STRING_VALUE",
// type: "NATIVE_INDEX" || "KENDRA_INDEX",
// status: "CREATING" || "ACTIVE" || "FAILED",
// displayName: "STRING_VALUE",
// },
// ],
// nextToken: "STRING_VALUE",
// };
ListRetrieversCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
applicationId Required | string | undefined | The identifier of the Amazon Q Business application using the retriever. |
maxResults | number | undefined | The maximum number of retrievers returned. |
nextToken | string | undefined | If the number of retrievers returned exceeds |
ListRetrieversCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
nextToken | string | undefined | 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. |
retrievers | Retriever[] | undefined | An array of summary information for one or more retrievers. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again. |
InternalServerException | server | 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. |
ResourceNotFoundException | client | The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again. |
ThrottlingException | client | The request was denied due to throttling. Reduce the number of requests and try again. |
ValidationException | client | The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again. |
QBusinessServiceException | Base exception class for all service exceptions from QBusiness service. |