GetRetrieverCommand

Suggest an Edit

Gets information about an existing 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, GetRetrieverCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
// const { QBusinessClient, GetRetrieverCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
const client = new QBusinessClient(config);
const input = { // GetRetrieverRequest
  applicationId: "STRING_VALUE", // required
  retrieverId: "STRING_VALUE", // required
};
const command = new GetRetrieverCommand(input);
const response = await client.send(command);
// { // GetRetrieverResponse
//   applicationId: "STRING_VALUE",
//   retrieverId: "STRING_VALUE",
//   retrieverArn: "STRING_VALUE",
//   type: "NATIVE_INDEX" || "KENDRA_INDEX",
//   status: "CREATING" || "ACTIVE" || "FAILED",
//   displayName: "STRING_VALUE",
//   configuration: { // RetrieverConfiguration Union: only one key present
//     nativeIndexConfiguration: { // NativeIndexConfiguration
//       indexId: "STRING_VALUE", // required
//       boostingOverride: { // DocumentAttributeBoostingOverrideMap
//         "<keys>": { // DocumentAttributeBoostingConfiguration Union: only one key present
//           numberConfiguration: { // NumberAttributeBoostingConfiguration
//             boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
//             boostingType: "PRIORITIZE_LARGER_VALUES" || "PRIORITIZE_SMALLER_VALUES",
//           },
//           stringConfiguration: { // StringAttributeBoostingConfiguration
//             boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
//             attributeValueBoosting: { // StringAttributeValueBoosting
//               "<keys>": "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH",
//             },
//           },
//           dateConfiguration: { // DateAttributeBoostingConfiguration
//             boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
//             boostingDurationInSeconds: Number("long"),
//           },
//           stringListConfiguration: { // StringListAttributeBoostingConfiguration
//             boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
//           },
//         },
//       },
//     },
//     kendraIndexConfiguration: { // KendraIndexConfiguration
//       indexId: "STRING_VALUE", // required
//     },
//   },
//   roleArn: "STRING_VALUE",
//   createdAt: new Date("TIMESTAMP"),
//   updatedAt: new Date("TIMESTAMP"),
// };

GetRetrieverCommand Input

See GetRetrieverCommandInput for more details

Parameter
Type
Description
applicationId
Required
string | undefined

The identifier of the Amazon Q Business application using the retriever.

retrieverId
Required
string | undefined

The identifier of the retriever.

GetRetrieverCommand Output

See GetRetrieverCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
applicationId
string | undefined

The identifier of the Amazon Q Business application using the retriever.

configuration
RetrieverConfiguration | undefined

Provides information on how the retriever used for your Amazon Q Business application is configured.

createdAt
Date | undefined

The Unix timestamp when the retriever was created.

displayName
string | undefined

The name of the retriever.

retrieverArn
string | undefined

The Amazon Resource Name (ARN) of the IAM role associated with the retriever.

retrieverId
string | undefined

The identifier of the retriever.

roleArn
string | undefined

The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.

status
RetrieverStatus | undefined

The status of the retriever.

type
RetrieverType | undefined

The type of the retriever.

updatedAt
Date | undefined

The Unix timestamp when the retriever was last updated.

Throws

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.