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

ListInsights

Lists insights for an Amazon OpenSearch Service domain or Amazon Web Services account. Returns a paginated list of insights based on the specified entity, filters, time range, and sort order.

Request Syntax


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

{
   "Entity": { 
      "Type": "string",
      "Value": "string"
   },
   "MaxResults": number,
   "NextToken": "string",
   "SortOrder": "string",
   "TimeRange": { 
      "From": number,
      "To": number
   }
}

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

Type: InsightEntity object

Required: Yes

MaxResults

An optional parameter that specifies the maximum number of results to return. You can use NextToken to get the next page of results. Valid values are 1 to 500.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 500.

Required: No

NextToken

If your initial ListInsights operation returns a NextToken, include the returned NextToken in subsequent ListInsights operations to retrieve the next page of results.

Type: String

Required: No

SortOrder

The sort order for the results. Possible values are ASC (ascending) and DESC (descending).

Type: String

Valid Values: ASC | DESC

Required: No

TimeRange

The time range for filtering insights, specified as epoch millisecond timestamps.

Type: InsightTimeRange object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Insights": [ 
      { 
         "CreationTime": number,
         "DisplayName": "string",
         "InsightId": "string",
         "IsExperimental": boolean,
         "Priority": "string",
         "Status": "string",
         "Type": "string",
         "UpdateTime": number
      }
   ],
   "NextToken": "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.

Insights

The list of insights returned for the specified entity.

Type: Array of Insight objects

NextToken

When NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

Type: String

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