UpdateQuickResponseCommand

Suggest an Edit

Updates an existing Amazon Q in Connect quick response.

Example Syntax

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

import { QConnectClient, UpdateQuickResponseCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
// const { QConnectClient, UpdateQuickResponseCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
const client = new QConnectClient(config);
const input = { // UpdateQuickResponseRequest
  knowledgeBaseId: "STRING_VALUE", // required
  quickResponseId: "STRING_VALUE", // required
  name: "STRING_VALUE",
  content: { // QuickResponseDataProvider Union: only one key present
    content: "STRING_VALUE",
  },
  contentType: "STRING_VALUE",
  groupingConfiguration: { // GroupingConfiguration
    criteria: "STRING_VALUE",
    values: [ // GroupingValues
      "STRING_VALUE",
    ],
  },
  removeGroupingConfiguration: true || false,
  description: "STRING_VALUE",
  removeDescription: true || false,
  shortcutKey: "STRING_VALUE",
  removeShortcutKey: true || false,
  isActive: true || false,
  channels: [ // Channels
    "STRING_VALUE",
  ],
  language: "STRING_VALUE",
};
const command = new UpdateQuickResponseCommand(input);
const response = await client.send(command);
// { // UpdateQuickResponseResponse
//   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",
//     },
//   },
// };

UpdateQuickResponseCommand Input

See UpdateQuickResponseCommandInput for more details

Parameter
Type
Description
knowledgeBaseId
Required
string | undefined

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

quickResponseId
Required
string | undefined

The identifier of the quick response.

channels
string[] | undefined

The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.

content
QuickResponseDataProvider | undefined

The updated content of the quick response.

contentType
string | undefined

The media type of the quick response content.

  • Use application/x.quickresponse;format=plain for quick response written in plain text.

  • Use application/x.quickresponse;format=markdown for quick response written in richtext.

description
string | undefined

The updated description of the quick response.

groupingConfiguration
GroupingConfiguration | undefined

The updated grouping configuration of the quick response.

isActive
boolean | undefined

Whether the quick response is active.

language
string | undefined

The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW

name
string | undefined

The name of the quick response.

removeDescription
boolean | undefined

Whether to remove the description from the quick response.

removeGroupingConfiguration
boolean | undefined

Whether to remove the grouping configuration of the quick response.

removeShortcutKey
boolean | undefined

Whether to remove the shortcut key of the quick response.

shortcutKey
string | undefined

The shortcut key of the quick response. The value should be unique across the knowledge base.

UpdateQuickResponseCommand Output

See UpdateQuickResponseCommandOutput for details

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.

ConflictException
client

The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

PreconditionFailedException
client

The provided revisionId does not match, indicating the content has been modified since it was last read.

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.