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

DescribeInsightDetails

Describes the details of an existing insight for an Amazon OpenSearch Service domain. Returns detailed fields associated with the specified insight, such as text descriptions and metric data.

Request Syntax


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

{
   "Entity": { 
      "Type": "string",
      "Value": "string"
   },
   "InsightId": "string",
   "ShowHtmlContent": boolean
}

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 retrieve insight details. Specifies the type and value of the entity, such as a domain name or Amazon Web Services account ID.

Type: InsightEntity object

Required: Yes

InsightId

The unique identifier of the insight to describe.

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

ShowHtmlContent

Specifies whether to show response with HTML content in response or not.

Type: Boolean

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Fields": [ 
      { 
         "Name": "string",
         "Type": "string",
         "Value": "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.

Fields

The list of fields that contain detailed information about the insight.

Type: Array of InsightField objects

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