Updates an AI Prompt.
Request Syntax
POST /assistants/assistantId/aiprompts/aiPromptId HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"description": "string",
"templateConfiguration": { ... },
"visibilityStatus": "string"
}URI Request Parameters
The request uses the following URI parameters.
- aiPromptId
-
The identifier of the Amazon Q in Connect AI Prompt.
Pattern:
[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^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}){0,2}(:[A-Z0-9_$]+){0,1}Required: Yes
- assistantId
-
The identifier of the Amazon Q in Connect assistant. 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}){0,2}Required: Yes
Request Body
The request accepts the following data in JSON format.
- clientToken
-
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs
.. Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Required: No
- description
-
The description of the Amazon Q in Connect AI Prompt.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9\s_.,-]+.*Required: No
- templateConfiguration
-
The configuration of the prompt template for this AI Prompt.
Type: AIPromptTemplateConfiguration object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- visibilityStatus
-
The visibility status of the Amazon Q in Connect AI prompt.
Type: String
Valid Values:
SAVED | PUBLISHEDRequired: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"aiPrompt": {
"aiPromptArn": "string",
"aiPromptId": "string",
"apiFormat": "string",
"assistantArn": "string",
"assistantId": "string",
"description": "string",
"modelId": "string",
"modifiedTime": number,
"name": "string",
"origin": "string",
"status": "string",
"tags": {
"string" : "string"
},
"templateConfiguration": { ... },
"templateType": "string",
"type": "string",
"visibilityStatus": "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.
- aiPrompt
-
The data of the updated Amazon Q in Connect AI Prompt.
Type: AIPromptData 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
CreateAPI (such asCreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.HTTP Status Code: 409
- ResourceNotFoundException
-
The specified resource does not exist.
HTTP Status Code: 404
- ThrottlingException
-
The throttling limit has been exceeded.
HTTP Status Code: 400
- ValidationException
-
The input fails to satisfy the constraints specified by a service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
