Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateQuickResponse

Updates an existing Amazon Q in Connect quick response.

Request Syntax


POST /knowledgeBases/knowledgeBaseId/quickResponses/quickResponseId HTTP/1.1
Content-type: application/json

{
   "channels": [ "string" ],
   "content": { ... },
   "contentType": "string",
   "description": "string",
   "groupingConfiguration": { 
      "criteria": "string",
      "values": [ "string" ]
   },
   "isActive": boolean,
   "language": "string",
   "name": "string",
   "removeDescription": boolean,
   "removeGroupingConfiguration": boolean,
   "removeShortcutKey": boolean,
   "shortcutKey": "string"
}

URI Request Parameters

The request uses the following URI parameters.

knowledgeBaseId

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

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$

Required: Yes

quickResponseId

The identifier of the quick response.

Required: Yes

Request Body

The request accepts the following data in JSON format.

channels

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

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 10.

Required: No

content

The updated content of the quick response.

Type: QuickResponseDataProvider object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

contentType

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.

Type: String

Pattern: ^(application/x\.quickresponse;format=(plain|markdown))$

Required: No

description

The updated description of the quick response.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

groupingConfiguration

The updated grouping configuration of the quick response.

Type: GroupingConfiguration object

Required: No

isActive

Whether the quick response is active.

Type: Boolean

Required: No

language

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

Type: String

Length Constraints: Minimum length of 2. Maximum length of 5.

Required: No

name

The name of the quick response.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

removeDescription

Whether to remove the description from the quick response.

Type: Boolean

Required: No

removeGroupingConfiguration

Whether to remove the grouping configuration of the quick response.

Type: Boolean

Required: No

removeShortcutKey

Whether to remove the shortcut key of the quick response.

Type: Boolean

Required: No

shortcutKey

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 10.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "quickResponse": { 
      "channels": [ "string" ],
      "contents": { 
         "markdown": { ... },
         "plainText": { ... }
      },
      "contentType": "string",
      "createdTime": number,
      "description": "string",
      "groupingConfiguration": { 
         "criteria": "string",
         "values": [ "string" ]
      },
      "isActive": boolean,
      "knowledgeBaseArn": "string",
      "knowledgeBaseId": "string",
      "language": "string",
      "lastModifiedBy": "string",
      "lastModifiedTime": number,
      "name": "string",
      "quickResponseArn": "string",
      "quickResponseId": "string",
      "shortcutKey": "string",
      "status": "string",
      "tags": { 
         "string" : "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.

quickResponse

The quick response.

Type: QuickResponseData object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

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.

HTTP Status Code: 409

PreconditionFailedException

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

HTTP Status Code: 412

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ValidationException

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

HTTP Status Code: 400