PutFeedback
Provides feedback against the specified assistant for the specified target. This API only supports generative targets.
Request Syntax
PUT /assistants/assistantId/feedback HTTP/1.1
Content-type: application/json
{
"contentFeedback": { ... },
"targetId": "string",
"targetType": "string"
}URI Request Parameters
The request uses the following URI parameters.
- assistantId
-
The identifier of the Amazon Q in Connect assistant.
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.
- contentFeedback
-
Information about the feedback provided.
Type: ContentFeedbackData object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
- targetId
-
The identifier of the feedback target.
Type: String
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$Required: Yes
- targetType
-
The type of the feedback target.
Type: String
Valid Values:
RECOMMENDATION | RESULTRequired: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"assistantArn": "string",
"assistantId": "string",
"contentFeedback": { ... },
"targetId": "string",
"targetType": "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.
- assistantArn
-
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
Type: String
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}$ - assistantId
-
The identifier of the Amazon Q in Connect assistant.
Type: String
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ - contentFeedback
-
Information about the feedback provided.
Type: ContentFeedbackData object
Note: This object is a Union. Only one member of this object can be specified or returned.
- targetId
-
The identifier of the feedback target.
Type: String
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ - targetType
-
The type of the feedback target.
Type: String
Valid Values:
RECOMMENDATION | RESULT
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
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
