Run a Logs Insights query
POST/tap/api/v3/tools/logs-insights/query
Runs a CloudWatch Logs Insights query against the TAP server or Endpoint server log group and waits for the results. A limit command with the combine.tap.tools.logsInsights.query.limit Configuration Value (default 500) is appended to queryString, unless that value is 0 or less. Results are polled every combine.tap.tools.logsInsights.poll.iterations.interval milliseconds (default 500), at most combine.tap.tools.logsInsights.poll.iterations times (default 60) and for at most combine.tap.tools.logsInsights.poll.totalDuration.limit milliseconds (default 30,000). A query that has not finished by then is stopped, and the results it had so far are returned with status Scheduled or Running. Requires the admin role.
Request
Responses
- 200
- 400
- 403
- 404
- 429
- 500
- 502
The query results.
queryString or logGroupName is missing or blank, logGroupName is not the TAP server or Endpoint server log group, or CloudWatch Logs rejected the query or its parameters; the message then includes the AWS error message.
The caller does not have the admin role.
The Logs Insights tool is not enabled (the combine.tap.tools.logsInsights.enable Configuration Value, true by default).
Too many Logs Insights queries are already running.
The query could not be run, including when queryString or logGroupName is not a string.
The query ended with status Failed, Cancelled, Timeout, or Unknown.