GetQuickResponseCommand

Retrieves the quick response.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { QConnectClient, GetQuickResponseCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
// const { QConnectClient, GetQuickResponseCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
const client = new QConnectClient(config);
const input = { // GetQuickResponseRequest
  quickResponseId: "STRING_VALUE", // required
  knowledgeBaseId: "STRING_VALUE", // required
};
const command = new GetQuickResponseCommand(input);
const response = await client.send(command);
// { // GetQuickResponseResponse
//   quickResponse: { // QuickResponseData
//     quickResponseArn: "STRING_VALUE", // required
//     quickResponseId: "STRING_VALUE", // required
//     knowledgeBaseArn: "STRING_VALUE", // required
//     knowledgeBaseId: "STRING_VALUE", // required
//     name: "STRING_VALUE", // required
//     contentType: "STRING_VALUE", // required
//     status: "STRING_VALUE", // required
//     createdTime: new Date("TIMESTAMP"), // required
//     lastModifiedTime: new Date("TIMESTAMP"), // required
//     contents: { // QuickResponseContents
//       plainText: { // QuickResponseContentProvider Union: only one key present
//         content: "STRING_VALUE",
//       },
//       markdown: {//  Union: only one key present
//         content: "STRING_VALUE",
//       },
//     },
//     description: "STRING_VALUE",
//     groupingConfiguration: { // GroupingConfiguration
//       criteria: "STRING_VALUE",
//       values: [ // GroupingValues
//         "STRING_VALUE",
//       ],
//     },
//     shortcutKey: "STRING_VALUE",
//     lastModifiedBy: "STRING_VALUE",
//     isActive: true || false,
//     channels: [ // Channels
//       "STRING_VALUE",
//     ],
//     language: "STRING_VALUE",
//     tags: { // Tags
//       "<keys>": "STRING_VALUE",
//     },
//   },
// };

GetQuickResponseCommand Input

See GetQuickResponseCommandInput for more details

Parameter
Type
Description
knowledgeBaseId
Required
string | undefined

The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.

quickResponseId
Required
string | undefined

The identifier of the quick response.

GetQuickResponseCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
quickResponse
QuickResponseData | undefined

The quick response.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

ResourceNotFoundException
client

The specified resource does not exist.

ValidationException
client

The input fails to satisfy the constraints specified by a service.

QConnectServiceException
Base exception class for all service exceptions from QConnect service.