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

UpdateChatResponseConfiguration

Updates an existing chat response configuration in an Amazon Q Business application. This operation allows administrators to modify configuration settings, display name, and response parameters to refine how the system generates responses.

Request Syntax


PUT /applications/applicationId/chatresponseconfigurations/chatResponseConfigurationId HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "displayName": "string",
   "responseConfigurations": { 
      "string" : { 
         "instructionCollection": { 
            "customInstructions": "string",
            "examples": "string",
            "identity": "string",
            "outputStyle": "string",
            "perspective": "string",
            "responseLength": "string",
            "targetAudience": "string",
            "tone": "string"
         }
      }
   }
}

URI Request Parameters

The request uses the following URI parameters.

applicationId

The unique identifier of the Amazon Q Business application containing the chat response configuration to update.

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]{35}

Required: Yes

chatResponseConfigurationId

The unique identifier of the chat response configuration to update within the specified application.

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]{35}

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

A unique, case-sensitive identifier to ensure idempotency of the request. This helps prevent the same update from being processed multiple times if retries occur.

Type: String

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

Required: No

displayName

The new human-readable name to assign to the chat response configuration, making it easier to identify among multiple configurations.

Type: String

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

Required: No

responseConfigurations

The updated collection of response configuration settings that define how Amazon Q Business generates and formats responses to user queries.

Type: String to ResponseConfiguration object map

Map Entries: Maximum number of 1 item.

Valid Keys: ALL

Required: Yes

Response Syntax


HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

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

AccessDeniedException

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

HTTP Status Code: 403

ConflictException

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.

HTTP Status Code: 409

InternalServerException

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.

HTTP Status Code: 500

ResourceNotFoundException

The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

HTTP Status Code: 404

ThrottlingException

The request was denied due to throttling. Reduce the number of requests and try again.

HTTP Status Code: 429

ValidationException

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

HTTP Status Code: 400