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

InsightFeedback

Submits feedback for an existing insight in an Amazon OpenSearch Service domain. Allows users to provide a thumbs up or thumbs down rating and optional text feedback for a specific insight.

Request Syntax


POST /2021-01-01/opensearch/insight-feedback HTTP/1.1
Content-type: application/json

{
   "Entity": { 
      "Type": "string",
      "Value": "string"
   },
   "FeedbackText": "string",
   "InsightId": "string",
   "Thumbs": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Entity

The entity for which to submit insight feedback. Specifies the type and value of the entity, such as a domain name.

Type: InsightFeedbackEntity object

Required: Yes

FeedbackText

Optional text feedback providing additional details about the insight. Maximum length is 1000 characters.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Required: No

InsightId

The unique identifier of the insight for which to submit feedback.

Type: String

Length Constraints: Fixed length of 36.

Pattern: \p{XDigit}{8}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{12}

Required: Yes

Thumbs

The thumbs up or thumbs down feedback for the insight. Possible values are Up and Down.

Type: String

Valid Values: Up | Down

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Status": "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.

Status

The status of the feedback submission. Possible values are SUCCESS and ERROR.

Type: String

Valid Values: SUCCESS | ERROR

Errors

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

BaseException

An error occurred while processing the request.

message: A description of the error.

HTTP Status Code: 400

DisabledOperationException

An error occured because the client wanted to access an unsupported operation.

HTTP Status Code: 409

InternalException

Request processing failed because of an unknown error, exception, or internal failure.

HTTP Status Code: 500

LimitExceededException

An exception for trying to create more than the allowed number of resources or sub-resources.

HTTP Status Code: 409

ResourceNotFoundException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 409

ValidationException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 400